From 7510d59aa2871477f2890cf065aa29eb925e1905 Mon Sep 17 00:00:00 2001 From: Jon Bratseth Date: Tue, 8 Aug 2017 14:43:16 +0200 Subject: Remove unnecessary instances of the character sequence 'yca' --- .../xml/dom/chains/search/DomProviderBuilder.java | 26 +++++------ .../model/container/component/HttpFilter.java | 2 +- .../container/search/searchchain/HttpProvider.java | 16 +++---- .../dom/chains/search/DomProviderBuilderTest.java | 8 ++-- .../search/federation/http/HTTPParameters.java | 38 ++++++++-------- .../yahoo/search/federation/http/HTTPSearcher.java | 50 +++++++++++----------- .../main/resources/configdefinitions/provider.def | 4 +- .../search/federation/http/HttpParametersTest.java | 2 +- 8 files changed, 73 insertions(+), 73 deletions(-) diff --git a/config-model/src/main/java/com/yahoo/vespa/model/builder/xml/dom/chains/search/DomProviderBuilder.java b/config-model/src/main/java/com/yahoo/vespa/model/builder/xml/dom/chains/search/DomProviderBuilder.java index 91a46c25384..198824ea9fb 100644 --- a/config-model/src/main/java/com/yahoo/vespa/model/builder/xml/dom/chains/search/DomProviderBuilder.java +++ b/config-model/src/main/java/com/yahoo/vespa/model/builder/xml/dom/chains/search/DomProviderBuilder.java @@ -64,10 +64,10 @@ public class DomProviderBuilder extends DomGenericTargetBuilder { connectionPoolTimeout = readConnectionPoolTimeout(providerElement); retries = readRetries(providerElement); nodes = readNodes(providerElement); - ycaApplicationId = readYcaApplicationId(providerElement); - ycaTtl = readYcaTtl(providerElement); - ycaRetryWait = readYcaRetryWait(providerElement); - ycaProxy = readYcaProxy(providerElement); + ycaApplicationId = readCertificateApplicationId(providerElement); + ycaTtl = readCertificateTtl(providerElement); + ycaRetryWait = readCertificateRetryWait(providerElement); + ycaProxy = readCertificateProxy(providerElement); } @@ -114,29 +114,29 @@ public class DomProviderBuilder extends DomGenericTargetBuilder { return (timeoutString == null) ? null : TimeParser.seconds(timeoutString); } - private String readYcaApplicationId(Element providerElement) { + private String readCertificateApplicationId(Element providerElement) { return getAttributeOrNull(providerElement, "yca-application-id"); } - private Integer readYcaTtl(Element providerElement) { + private Integer readCertificateTtl(Element providerElement) { String x = getAttributeOrNull(providerElement, "yca-cache-ttl"); return (x == null) ? null : TimeParser.seconds(x).intValue(); } - private Integer readYcaRetryWait(Element providerElement) { + private Integer readCertificateRetryWait(Element providerElement) { String x = getAttributeOrNull(providerElement, "yca-cache-retry-wait"); return (x == null) ? null : TimeParser.seconds(x).intValue(); } - private HttpProviderSpec.Node readYcaProxy(Element providerElement) { - Element ycaProxySpec = XML.getChild(providerElement, "yca-proxy"); - if (ycaProxySpec == null) { + private HttpProviderSpec.Node readCertificateProxy(Element providerElement) { + Element certificateProxySpec = XML.getChild(providerElement, "yca-proxy"); + if (certificateProxySpec == null) { return null; // no proxy } - if(getAttributeOrNull(ycaProxySpec, "host") == null) { + if(getAttributeOrNull(certificateProxySpec, "host") == null) { return new HttpProviderSpec.Node(null, 0); // default proxy } - return readNode(ycaProxySpec); + return readNode(certificateProxySpec); } private List readNodes(Element providerElement) { @@ -177,7 +177,7 @@ public class DomProviderBuilder extends DomGenericTargetBuilder { if (providerReader.ycaApplicationId == null && providerReader.ycaProxy != null) { throw new IllegalArgumentException( "Provider '" + specWithoutInnerComponents.componentId + - "' must have a YCA application ID, since a YCA proxy is given"); + "' must have a certificate application ID, since a certificate store proxy is given"); } FederationOptions federationOptions = readFederationOptions(providerElement); diff --git a/config-model/src/main/java/com/yahoo/vespa/model/container/component/HttpFilter.java b/config-model/src/main/java/com/yahoo/vespa/model/container/component/HttpFilter.java index a016b5ada44..e943da41dd3 100644 --- a/config-model/src/main/java/com/yahoo/vespa/model/container/component/HttpFilter.java +++ b/config-model/src/main/java/com/yahoo/vespa/model/container/component/HttpFilter.java @@ -8,7 +8,7 @@ import com.yahoo.container.bundle.BundleInstantiationSpecification; import com.yahoo.osgi.provider.model.ComponentModel; /** - * This is only for the legacy yca filter setup, outside http. + * This is only for the legacy certificate filter setup, outside http. * * TODO: Remove when 'filter' directly under 'jdisc' can be removed from services.xml * diff --git a/config-model/src/main/java/com/yahoo/vespa/model/container/search/searchchain/HttpProvider.java b/config-model/src/main/java/com/yahoo/vespa/model/container/search/searchchain/HttpProvider.java index 22ed9b881b7..0dcd45e4e64 100644 --- a/config-model/src/main/java/com/yahoo/vespa/model/container/search/searchchain/HttpProvider.java +++ b/config-model/src/main/java/com/yahoo/vespa/model/container/search/searchchain/HttpProvider.java @@ -66,24 +66,24 @@ public class HttpProvider extends Provider implements ProviderConfig.Producer, builder.node(getNodes(providerSpec.nodes)); if (providerSpec.ycaApplicationId != null) { - builder.yca(getYca(providerSpec)); + builder.yca(getCertificate(providerSpec)); } } - private static Yca.Builder getYca(HttpProviderSpec providerSpec) { - Yca.Builder yca = new Yca.Builder() + private static Yca.Builder getCertificate(HttpProviderSpec providerSpec) { + Yca.Builder certificate = new Yca.Builder() .applicationId(providerSpec.ycaApplicationId); if (providerSpec.ycaProxy != null) { - yca.useProxy(true); + certificate.useProxy(true); if (providerSpec.ycaProxy.host != null) { - yca.host(providerSpec.ycaProxy.host) + certificate.host(providerSpec.ycaProxy.host) .port(providerSpec.ycaProxy.port); } } - if (providerSpec.ycaCertificateTtl != null) yca.ttl(providerSpec.ycaCertificateTtl); - if (providerSpec.ycaRetryWait != null) yca.ttl(providerSpec.ycaRetryWait); - return yca; + if (providerSpec.ycaCertificateTtl != null) certificate.ttl(providerSpec.ycaCertificateTtl); + if (providerSpec.ycaRetryWait != null) certificate.ttl(providerSpec.ycaRetryWait); + return certificate; } private static List getNodes(List nodeSpecs) { diff --git a/config-model/src/test/java/com/yahoo/vespa/model/builder/xml/dom/chains/search/DomProviderBuilderTest.java b/config-model/src/test/java/com/yahoo/vespa/model/builder/xml/dom/chains/search/DomProviderBuilderTest.java index b7df93fbc0c..81eeeea42ee 100755 --- a/config-model/src/test/java/com/yahoo/vespa/model/builder/xml/dom/chains/search/DomProviderBuilderTest.java +++ b/config-model/src/test/java/com/yahoo/vespa/model/builder/xml/dom/chains/search/DomProviderBuilderTest.java @@ -57,7 +57,7 @@ public class DomProviderBuilderTest extends DomBuilderTest { private Provider provider; @Test - public void testYcaConfig_noProxy() { + public void testCertificateConfig_noProxy() { provider = new DomProviderBuilder(new HashMap()).doBuild(root, noProxy); ChainedComponent providerSearcher = provider.getInnerComponents().iterator().next(); @@ -71,7 +71,7 @@ public class DomProviderBuilderTest extends DomBuilderTest { } @Test - public void testYcaConfig_defaultProxy() { + public void testCertificatewConfig_defaultProxy() { provider = new DomProviderBuilder(new HashMap()).doBuild(root, defaultProxy); ProviderConfig.Builder providerBuilder = new ProviderConfig.Builder(); @@ -85,7 +85,7 @@ public class DomProviderBuilderTest extends DomBuilderTest { } @Test - public void testYcaConfig_proprietaryProxy() { + public void testCertificateConfig_proprietaryProxy() { provider = new DomProviderBuilder(new HashMap()).doBuild(root, proprietaryProxy); ProviderConfig.Builder providerBuilder = new ProviderConfig.Builder(); @@ -104,7 +104,7 @@ public class DomProviderBuilderTest extends DomBuilderTest { provider = new DomProviderBuilder(new HashMap()).doBuild(root, illegal_proxyWithoutId); fail("Expected exception upon illegal xml."); } catch (IllegalArgumentException e) { - assertThat(e.getMessage(), is("Provider 'yca-provider' must have a YCA application ID, since a YCA proxy is given")); + assertThat(e.getMessage(), is("Provider 'yca-provider' must have a certificate application ID, since a certificate store proxy is given")); } } diff --git a/container-search/src/main/java/com/yahoo/search/federation/http/HTTPParameters.java b/container-search/src/main/java/com/yahoo/search/federation/http/HTTPParameters.java index c4227e06538..99dae4e20aa 100644 --- a/container-search/src/main/java/com/yahoo/search/federation/http/HTTPParameters.java +++ b/container-search/src/main/java/com/yahoo/search/federation/http/HTTPParameters.java @@ -42,12 +42,12 @@ public final class HTTPParameters { private int configuredReadTimeout = -1; private int configuredConnectionTimeout = -1; private int connectionPoolTimeout = -1; - private String ycaProxy = null; - private int ycaPort = 0; - private String ycaApplicationId = null; - private boolean ycaUseProxy = false; - private long ycaTtl = 0L; - private long ycaRetry = 0L; + private String certificateProxy = null; + private int certificatePort = 0; + private String certificateApplicationId = null; + private boolean certificateUseProxy = false; + private long certificateTtl = 0L; + private long certificateRetry = 0L; private PingOption.Enum pingOption = PingOption.NORMAL; @@ -66,14 +66,14 @@ public final class HTTPParameters { connectionPoolTimeout = (int) (providerConfig.connectionPoolTimeout() * 1000.0d); retries = providerConfig.retries(); setPath(providerConfig.path()); - ycaUseProxy = providerConfig.yca().useProxy(); - if (ycaUseProxy) { - ycaProxy = providerConfig.yca().host(); - ycaPort = providerConfig.yca().port(); + certificateUseProxy = providerConfig.yca().useProxy(); + if (certificateUseProxy) { + certificateProxy = providerConfig.yca().host(); + certificatePort = providerConfig.yca().port(); } - ycaApplicationId = providerConfig.yca().applicationId(); - ycaTtl = providerConfig.yca().ttl() * 1000L; - ycaRetry = providerConfig.yca().retry() * 1000L; + certificateApplicationId = providerConfig.yca().applicationId(); + certificateTtl = providerConfig.yca().ttl() * 1000L; + certificateRetry = providerConfig.yca().retry() * 1000L; followRedirects = providerConfig.followRedirects(); pingOption = providerConfig.pingOption(); } @@ -289,27 +289,27 @@ public final class HTTPParameters { } public String getYcaProxy() { - return ycaProxy; + return certificateProxy; } public int getYcaPort() { - return ycaPort; + return certificatePort; } public String getYcaApplicationId() { - return ycaApplicationId; + return certificateApplicationId; } public boolean getYcaUseProxy() { - return ycaUseProxy; + return certificateUseProxy; } public long getYcaTtl() { - return ycaTtl; + return certificateTtl; } public long getYcaRetry() { - return ycaRetry; + return certificateRetry; } } diff --git a/container-search/src/main/java/com/yahoo/search/federation/http/HTTPSearcher.java b/container-search/src/main/java/com/yahoo/search/federation/http/HTTPSearcher.java index 1afe08414b2..3707d7fa77a 100644 --- a/container-search/src/main/java/com/yahoo/search/federation/http/HTTPSearcher.java +++ b/container-search/src/main/java/com/yahoo/search/federation/http/HTTPSearcher.java @@ -177,17 +177,17 @@ public abstract class HTTPSearcher extends ClusterSearcher { private final CertificateStore certificateStore; - /** The (optional) YCA application ID. */ - private String ycaApplicationId = null; + /** The (optional) certificate application ID. */ + private String certificateApplicationId = null; - /** The (optional) YCA proxy */ - protected HttpHost ycaProxy = null; + /** The (optional) certificate server proxy */ + protected HttpHost certificateProxy = null; - /** YCA cache TTL in ms */ - private long ycaTtl = 0L; + /** Certificate cache TTL in ms */ + private long certificateTtl = 0L; - /** YCA retry rate in the cache if no cert is found, in ms */ - private long ycaRetry = 0L; + /** Certificate server retry rate in the cache if no cert is found, in ms */ + private long certificateRetry = 0L; /** Set at construction if this is using persistent connections */ private ClientConnectionManager sharedConnectionManager = null; @@ -275,15 +275,15 @@ public abstract class HTTPSearcher extends ClusterSearcher { singleClientConnManagerThreadLocal =new ThreadLocal<>(); } - initializeYCA(httpParameters, certificateStore); + initializeCertificate(httpParameters, certificateStore); } /** - * Initialize YCA certificate and proxy if they have been set to non-null, - * non-empty values. It will wrap thrown exceptions from the YCA layer into + * Initialize certificate store and proxy if they have been set to non-null, + * non-empty values. It will wrap thrown exceptions from the certificate store into * RuntimeException and propagate them. */ - private void initializeYCA(HTTPParameters parameters, CertificateStore certificateStore) { + private void initializeCertificate(HTTPParameters parameters, CertificateStore certificateStore) { String applicationId = parameters.getYcaApplicationId(); String proxy = parameters.getYcaProxy(); int port = parameters.getYcaPort(); @@ -314,7 +314,7 @@ public abstract class HTTPSearcher extends ClusterSearcher { } /** - * Initialize the YCA certificate. + * Initialize the certificate. * This will warn but not throw if certificates could not be loaded, as the certificates * are external state which can fail independently. */ @@ -328,9 +328,9 @@ public abstract class HTTPSearcher extends ClusterSearcher { } this.useCertificate = true; - this.ycaApplicationId = applicationId; - this.ycaTtl = ttl; - this.ycaRetry = retry; + this.certificateApplicationId = applicationId; + this.certificateTtl = ttl; + this.certificateRetry = retry; getLogger().log(LogLevel.CONFIG, "Got certificate: " + certificate); } catch (Exception e) { @@ -340,11 +340,11 @@ public abstract class HTTPSearcher extends ClusterSearcher { } /** - * Initialize the YCA proxy setting. + * Initialize the certificate proxy setting. */ private void initializeProxy(String host, int port) { - ycaProxy = new HttpHost(host, port); - getLogger().log(LogLevel.CONFIG,"Proxy is configured; will use proxy: " + ycaProxy); + certificateProxy = new HttpHost(host, port); + getLogger().log(LogLevel.CONFIG, "Proxy is configured; will use proxy: " + certificateProxy); } /** @@ -644,8 +644,8 @@ public abstract class HTTPSearcher extends ClusterSearcher { /** * Returns the set of headers to be passed in the http request to provider backend. The default - * implementation returns null, unless YCA is in use. If YCA is used, it will return a map - * only containing the needed YCA headers. + * implementation returns null, unless certificates are in use. If certificates are used, it will return a map + * only containing the needed certificate headers. */ protected Map getRequestHeaders(Query query, Hit requestMeta) { if (useCertificate) { @@ -781,13 +781,13 @@ public abstract class HTTPSearcher extends ClusterSearcher { /** * Creates a http client for one request. Override to customize the client - * to use, e.g for testing. This default implementation will add the YCA + * to use, e.g for testing. This default implementation will add a certificate store * proxy to params if is necessary, and then do * return new SearcherHttpClient(getConnectionManager(params), params); */ protected HttpClient createClient(HttpParams params) { - if (ycaProxy != null) { - params.setParameter(ConnRoutePNames.DEFAULT_PROXY, ycaProxy); + if (certificateProxy != null) { + params.setParameter(ConnRoutePNames.DEFAULT_PROXY, certificateProxy); } return new SearcherHttpClient(getConnectionManager(params), params); } @@ -830,7 +830,7 @@ public abstract class HTTPSearcher extends ClusterSearcher { private Map generateYCAHeaders() { Map headers = new HashMap<>(); - String certificate = certificateStore.getCertificate(ycaApplicationId, ycaTtl, ycaRetry); + String certificate = certificateStore.getCertificate(certificateApplicationId, certificateTtl, certificateRetry); headers.put(YCA_HTTP_HEADER, certificate); return headers; } diff --git a/container-search/src/main/resources/configdefinitions/provider.def b/container-search/src/main/resources/configdefinitions/provider.def index dca31cb3923..3cddc085de9 100644 --- a/container-search/src/main/resources/configdefinitions/provider.def +++ b/container-search/src/main/resources/configdefinitions/provider.def @@ -21,9 +21,9 @@ connectionTimeout double default=-1.0 ## Unit is seconds, default value is ## in com.yahoo.search.federation.http.HTTPParameters. connectionPoolTimeout double default=-1.0 -## YCA proxy host +## Certificate store proxy host yca.host string default="yca-proxy.corp.yahoo.com" -## YCA proxy port +## Certificate store proxy port yca.port int default=3128 ## Whether a proxy is needed (i.e. should the proxy settings be used) yca.useProxy bool default=false diff --git a/container-search/src/test/java/com/yahoo/search/federation/http/HttpParametersTest.java b/container-search/src/test/java/com/yahoo/search/federation/http/HttpParametersTest.java index 1edb41dad05..11f5d7d14fd 100644 --- a/container-search/src/test/java/com/yahoo/search/federation/http/HttpParametersTest.java +++ b/container-search/src/test/java/com/yahoo/search/federation/http/HttpParametersTest.java @@ -12,7 +12,7 @@ import static org.junit.Assert.assertTrue; /** * @author gjoranv - * @author Steinar Knutsen + * @author Steinar Knutsen */ public class HttpParametersTest { -- cgit v1.2.3