com.netflix.client.config

Class IClientConfig.Builder

java.lang.Object

com.netflix.client.config.IClientConfig.Builder

Enclosing interface:

IClientConfig

public static class IClientConfig.Builder
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
IClientConfig	build()
IClientConfig.Builder	ignoreUserTokenInConnectionPoolForSecureClient(boolean value)
static IClientConfig.Builder	newBuilder() Create a builder with no initial property and value for the configuration to be built.
static IClientConfig.Builder	newBuilder(java.lang.Class<? extends IClientConfig> implClass) Create a builder to build the configuration with no initial properties set
static IClientConfig.Builder	newBuilder(java.lang.Class<? extends IClientConfig> implClass, java.lang.String clientName) Create a builder with properties for the specific client loaded.
static IClientConfig.Builder	newBuilder(java.lang.String clientName) Create a builder with properties for the specific client loaded.
static IClientConfig.Builder	newBuilder(java.lang.String clientName, java.lang.String propertyNameSpace) Create a builder with properties for the specific client loaded.
IClientConfig.Builder	prioritizeVipAddressBasedServers(boolean value)
IClientConfig.Builder	withClientAuthRequired(boolean value)
IClientConfig.Builder	withConnectionCleanerRepeatIntervalMills(int value)
IClientConfig.Builder	withConnectionManagerTimeout(int value)
IClientConfig.Builder	withConnectionPoolCleanerTaskEnabled(boolean value)
IClientConfig.Builder	withConnectTimeout(int value)
IClientConfig.Builder	withConnIdleEvictTimeMilliSeconds(int value)
IClientConfig.Builder	withCustomSSLSocketFactoryClassName(java.lang.String value)
IClientConfig.Builder	withDefaultValues() Load a set of default values for the configuration
IClientConfig.Builder	withDeploymentContextBasedVipAddresses(java.lang.String vipAddress)
IClientConfig.Builder	withEnablePrimeConnections(boolean value)
IClientConfig.Builder	withFollowRedirects(boolean value)
IClientConfig.Builder	withForceClientPortConfiguration(boolean forceClientPortConfiguration)
IClientConfig.Builder	withGZIPContentEncodingFilterEnabled(boolean value)
IClientConfig.Builder	withHostnameValidationRequired(boolean value)
IClientConfig.Builder	withKeyStore(java.lang.String value)
IClientConfig.Builder	withKeyStorePassword(java.lang.String value)
IClientConfig.Builder	withLoadBalancerEnabled(boolean value)
IClientConfig.Builder	withMaxAutoRetries(int value)
IClientConfig.Builder	withMaxAutoRetriesNextServer(int value)
IClientConfig.Builder	withMaxConnectionsPerHost(int value)
IClientConfig.Builder	withMaxTotalConnections(int value)
IClientConfig.Builder	withProxyHost(java.lang.String proxyHost)
IClientConfig.Builder	withProxyPort(int value)
IClientConfig.Builder	withReadTimeout(int value)
IClientConfig.Builder	withRequestSpecificRetryOn(boolean value)
IClientConfig.Builder	withRetryOnAllOperations(boolean value)
IClientConfig.Builder	withSecure(boolean secure)
IClientConfig.Builder	withServerListRefreshIntervalMills(int value)
IClientConfig.Builder	withTargetRegion(java.lang.String value)
IClientConfig.Builder	withTrustStore(java.lang.String value)
IClientConfig.Builder	withTrustStorePassword(java.lang.String value)
IClientConfig.Builder	withZoneAffinityEnabled(boolean value)
IClientConfig.Builder	withZoneExclusivityEnabled(boolean value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newBuilder

public static IClientConfig.Builder newBuilder()

Create a builder with no initial property and value for the configuration to be built. The configuration object that will be built is an instance of DefaultClientConfigImpl

newBuilder

public static IClientConfig.Builder newBuilder(java.lang.String clientName)

Create a builder with properties for the specific client loaded. The default IClientConfig implementation loads properties from Archaius

Parameters:

clientName - Name of client. clientName.ribbon will be used as a prefix to find corresponding properties from Archaius

newBuilder

public static IClientConfig.Builder newBuilder(java.lang.String clientName,
                               java.lang.String propertyNameSpace)

Create a builder with properties for the specific client loaded. The default IClientConfig implementation loads properties from Archaius

Parameters:

clientName - Name of client. clientName.propertyNameSpace will be used as a prefix to find corresponding properties from Archaius

newBuilder

public static IClientConfig.Builder newBuilder(java.lang.Class<? extends IClientConfig> implClass,
                               java.lang.String clientName)

Create a builder with properties for the specific client loaded.

Parameters:

implClass - the class of IClientConfig object to be built

newBuilder

public static IClientConfig.Builder newBuilder(java.lang.Class<? extends IClientConfig> implClass)

Create a builder to build the configuration with no initial properties set

Parameters:

implClass - the class of IClientConfig object to be built

build

public IClientConfig build()

withDefaultValues

public IClientConfig.Builder withDefaultValues()

Load a set of default values for the configuration

withDeploymentContextBasedVipAddresses

public IClientConfig.Builder withDeploymentContextBasedVipAddresses(java.lang.String vipAddress)

withForceClientPortConfiguration

public IClientConfig.Builder withForceClientPortConfiguration(boolean forceClientPortConfiguration)

withMaxAutoRetries

public IClientConfig.Builder withMaxAutoRetries(int value)

withMaxAutoRetriesNextServer

public IClientConfig.Builder withMaxAutoRetriesNextServer(int value)

withRetryOnAllOperations

public IClientConfig.Builder withRetryOnAllOperations(boolean value)

withRequestSpecificRetryOn

public IClientConfig.Builder withRequestSpecificRetryOn(boolean value)

withEnablePrimeConnections

public IClientConfig.Builder withEnablePrimeConnections(boolean value)

withMaxConnectionsPerHost

public IClientConfig.Builder withMaxConnectionsPerHost(int value)

withMaxTotalConnections

public IClientConfig.Builder withMaxTotalConnections(int value)

withSecure

public IClientConfig.Builder withSecure(boolean secure)

withConnectTimeout

public IClientConfig.Builder withConnectTimeout(int value)

withReadTimeout

public IClientConfig.Builder withReadTimeout(int value)

withConnectionManagerTimeout

public IClientConfig.Builder withConnectionManagerTimeout(int value)

withFollowRedirects

public IClientConfig.Builder withFollowRedirects(boolean value)

withConnectionPoolCleanerTaskEnabled

public IClientConfig.Builder withConnectionPoolCleanerTaskEnabled(boolean value)

withConnIdleEvictTimeMilliSeconds

public IClientConfig.Builder withConnIdleEvictTimeMilliSeconds(int value)

withConnectionCleanerRepeatIntervalMills

public IClientConfig.Builder withConnectionCleanerRepeatIntervalMills(int value)

withGZIPContentEncodingFilterEnabled

public IClientConfig.Builder withGZIPContentEncodingFilterEnabled(boolean value)

withProxyHost

public IClientConfig.Builder withProxyHost(java.lang.String proxyHost)

withProxyPort

public IClientConfig.Builder withProxyPort(int value)

withKeyStore

public IClientConfig.Builder withKeyStore(java.lang.String value)

withKeyStorePassword

public IClientConfig.Builder withKeyStorePassword(java.lang.String value)

withTrustStore

public IClientConfig.Builder withTrustStore(java.lang.String value)

withTrustStorePassword

public IClientConfig.Builder withTrustStorePassword(java.lang.String value)

withClientAuthRequired

public IClientConfig.Builder withClientAuthRequired(boolean value)

withCustomSSLSocketFactoryClassName

public IClientConfig.Builder withCustomSSLSocketFactoryClassName(java.lang.String value)

withHostnameValidationRequired

public IClientConfig.Builder withHostnameValidationRequired(boolean value)

ignoreUserTokenInConnectionPoolForSecureClient

public IClientConfig.Builder ignoreUserTokenInConnectionPoolForSecureClient(boolean value)

withLoadBalancerEnabled

public IClientConfig.Builder withLoadBalancerEnabled(boolean value)

withServerListRefreshIntervalMills

public IClientConfig.Builder withServerListRefreshIntervalMills(int value)

withZoneAffinityEnabled

public IClientConfig.Builder withZoneAffinityEnabled(boolean value)

withZoneExclusivityEnabled

public IClientConfig.Builder withZoneExclusivityEnabled(boolean value)

prioritizeVipAddressBasedServers

public IClientConfig.Builder prioritizeVipAddressBasedServers(boolean value)

withTargetRegion

public IClientConfig.Builder withTargetRegion(java.lang.String value)