com.netflix.client.config
Class DefaultClientConfigImpl

java.lang.Object
  com.netflix.client.config.DefaultClientConfigImpl

All Implemented Interfaces:

IClientConfig

public class DefaultClientConfigImpl
extends java.lang.Object
implements IClientConfig

Default client configuration that loads properties from Archaius's ConfigurationManager.

The easiest way to configure client and load balancer is through loading properties into Archaius that conform to the specific format:

<clientName>.<nameSpace>.<propertyName>=<value>

You can define properties in a file on classpath or as system properties. If former, ConfigurationManager.loadPropertiesFromResources() API should be called to load the file.

By default, "ribbon" should be the nameSpace.

If there is no property specified for a named client, ClientFactory will still create the client and load balancer with default values for all necessary properties. The default values are specified in this class as constants.

If a property is missing the clientName, it is interpreted as a property that applies to all clients. For example

ribbon.ReadTimeout=1000

This will establish the default ReadTimeout property for all clients.

You can also programmatically set properties by constructing instance of DefaultClientConfigImpl. Follow these steps:

Get an instance by calling getClientConfigWithDefaultValues(String) to load default values, and any properties that are already defined with Configuration in Archaius

Set all desired properties by calling setProperty(IClientConfigKey, Object) API.

Pass this instance together with client name to ClientFactory API.

If it is desired to have properties defined in a different name space, for example, "foo"

myclient.foo.ReadTimeout=1000

You should use getClientConfigWithDefaultValues(String, String) - in the first step above.

Field Summary

static java.lang.String	DEFAULT_CLIENT_CLASSNAME
static int	DEFAULT_CONNECT_TIMEOUT
static int	DEFAULT_CONNECTION_IDLE_TIMERTASK_REPEAT_IN_MSECS
static int	DEFAULT_CONNECTION_MANAGER_TIMEOUT
static java.lang.Boolean	DEFAULT_CONNECTION_POOL_CLEANER_TASK_ENABLED
static int	DEFAULT_CONNECTIONIDLE_TIME_IN_MSECS
static java.lang.Boolean	DEFAULT_ENABLE_GZIP_CONTENT_ENCODING_FILTER
static java.lang.Boolean	DEFAULT_ENABLE_LOADBALANCER
static java.lang.Boolean	DEFAULT_ENABLE_NIWS_EVENT_LOGGING
static java.lang.Boolean	DEFAULT_ENABLE_PRIME_CONNECTIONS
static java.lang.Boolean	DEFAULT_ENABLE_REQUEST_THROTTLING
static java.lang.Boolean	DEFAULT_ENABLE_ZONE_AFFINITY
static java.lang.Boolean	DEFAULT_ENABLE_ZONE_EXCLUSIVITY
static java.lang.Boolean	DEFAULT_FOLLOW_REDIRECTS
static int	DEFAULT_MAX_AUTO_RETRIES
static int	DEFAULT_MAX_AUTO_RETRIES_NEXT_SERVER
static int	DEFAULT_MAX_HTTP_CONNECTIONS_PER_HOST
static int	DEFAULT_MAX_REQUESTS_ALLOWED_PER_WINDOW
static int	DEFAULT_MAX_RETRIES_PER_SERVER_PRIME_CONNECTION
static int	DEFAULT_MAX_TOTAL_HTTP_CONNECTIONS
static int	DEFAULT_MAX_TOTAL_TIME_TO_PRIME_CONNECTIONS
static float	DEFAULT_MIN_PRIME_CONNECTIONS_RATIO
static java.lang.String	DEFAULT_NFLOADBALANCER_CLASSNAME
static java.lang.String	DEFAULT_NFLOADBALANCER_PING_CLASSNAME
static java.lang.String	DEFAULT_NFLOADBALANCER_RULE_CLASSNAME
static java.lang.Boolean	DEFAULT_OK_TO_RETRY_ON_ALL_OPERATIONS
static float	DEFAULT_PERCENTAGE_NIWS_EVENT_LOGGED
static long	DEFAULT_POOL_KEEP_ALIVE_TIME
static java.util.concurrent.TimeUnit	DEFAULT_POOL_KEEP_ALIVE_TIME_UNITS
static int	DEFAULT_POOL_MAX_THREADS Defaults for the parameters for the thread pool used by batchParallel calls
static int	DEFAULT_POOL_MIN_THREADS
static int	DEFAULT_PORT
static java.lang.String	DEFAULT_PRIME_CONNECTIONS_CLASS
static java.lang.String	DEFAULT_PRIME_CONNECTIONS_URI
static java.lang.Boolean	DEFAULT_PRIORITIZE_VIP_ADDRESS_BASED_SERVERS
static java.lang.String	DEFAULT_PROPERTY_NAME_SPACE
static int	DEFAULT_READ_TIMEOUT
static int	DEFAULT_REQUEST_THROTTLING_WINDOW_IN_MILLIS
static java.lang.String	DEFAULT_SEVER_LIST_CLASS
static java.lang.String	DEFAULT_VIPADDRESS_RESOLVER_CLASSNAME

Constructor Summary

DefaultClientConfigImpl()
Create instance with no properties in default name space DEFAULT_PROPERTY_NAME_SPACE

DefaultClientConfigImpl(java.lang.String nameSpace)
Create instance with no properties in the specified name space

Method Summary

IClientConfig	applyOverride(IClientConfig override)
boolean	containsProperty(IClientConfigKey key)
java.lang.String	getAppName()
static DefaultClientConfigImpl	getClientConfigWithDefaultValues(java.lang.String clientName)
static DefaultClientConfigImpl	getClientConfigWithDefaultValues(java.lang.String clientName, java.lang.String nameSpace)
java.lang.String	getClientName()
java.lang.String	getDefaultClientClassname()
int	getDefaultConnectionidleTimeInMsecs()
int	getDefaultConnectionIdleTimertaskRepeatInMsecs()
int	getDefaultConnectionManagerTimeout()
java.lang.Boolean	getDefaultConnectionPoolCleanerTaskEnabled()
int	getDefaultConnectTimeout()
java.lang.Boolean	getDefaultEnableGzipContentEncodingFilter()
java.lang.Boolean	getDefaultEnableLoadbalancer()
java.lang.Boolean	getDefaultEnablePrimeConnections()
java.lang.Boolean	getDefaultEnableRequestThrottling()
java.lang.Boolean	getDefaultEnableZoneAffinity()
java.lang.Boolean	getDefaultEnableZoneExclusivity()
java.lang.Boolean	getDefaultFollowRedirects()
int	getDefaultMaxAutoRetries()
int	getDefaultMaxAutoRetriesNextServer()
int	getDefaultMaxHttpConnectionsPerHost()
int	getDefaultMaxRequestsAllowedPerWindow()
int	getDefaultMaxRetriesPerServerPrimeConnection()
int	getDefaultMaxTotalHttpConnections()
int	getDefaultMaxTotalTimeToPrimeConnections()
float	getDefaultMinPrimeConnectionsRatio()
java.lang.String	getDefaultNfloadbalancerClassname()
java.lang.String	getDefaultNfloadbalancerPingClassname()
java.lang.String	getDefaultNfloadbalancerRuleClassname()
java.lang.Boolean	getDefaultOkToRetryOnAllOperations()
float	getDefaultPercentageNiwsEventLogged()
long	getDefaultPoolKeepAliveTime()
java.util.concurrent.TimeUnit	getDefaultPoolKeepAliveTimeUnits()
int	getDefaultPoolMaxThreads()
int	getDefaultPoolMinThreads()
int	getDefaultPort()
java.lang.String	getDefaultPrimeConnectionsClass()
java.lang.String	getDefaultPrimeConnectionsUri()
java.lang.Boolean	getDefaultPrioritizeVipAddressBasedServers()
java.lang.String	getDefaultPropName(IClientConfigKey propName)
int	getDefaultReadTimeout()
int	getDefaultRequestThrottlingWindowInMillis()
java.lang.String	getDefaultSeverListClass()
java.lang.String	getDefaultVipaddressResolverClassname()
java.lang.String	getInstancePropName(java.lang.String restClientName, IClientConfigKey configKey)
java.lang.String	getInstancePropName(java.lang.String restClientName, java.lang.String key)
java.lang.String	getNameSpace()
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
java.lang.Object	getProperty(IClientConfigKey key)
java.lang.Object	getProperty(IClientConfigKey key, java.lang.Object defaultVal)
static java.lang.Object	getProperty(java.util.Map<java.lang.String,java.lang.Object> config, IClientConfigKey key)
static java.lang.Object	getProperty(java.util.Map<java.lang.String,java.lang.Object> config, IClientConfigKey key, java.lang.Object defaultVal)
VipAddressResolver	getResolver()
java.lang.String	getVersion()
boolean	isEnableDynamicProperties()
boolean	isSecure()
protected void	loadDefaultValues()
void	loadProperties(java.lang.String restClientName) Load properties for a given client.
java.lang.String	resolveDeploymentContextbasedVipAddresses() Returns the applicable virtual addresses ("vip") used by this client configuration.
void	setClientName(java.lang.String clientName)
void	setProperty(IClientConfigKey key, java.lang.Object value)
void	setProperty(java.util.Properties props, java.lang.String restClientName, java.lang.String key, java.lang.String value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRIORITIZE_VIP_ADDRESS_BASED_SERVERS

public static final java.lang.Boolean DEFAULT_PRIORITIZE_VIP_ADDRESS_BASED_SERVERS

DEFAULT_NFLOADBALANCER_PING_CLASSNAME

public static final java.lang.String DEFAULT_NFLOADBALANCER_PING_CLASSNAME

See Also:

Constant Field Values

DEFAULT_NFLOADBALANCER_RULE_CLASSNAME

public static final java.lang.String DEFAULT_NFLOADBALANCER_RULE_CLASSNAME

See Also:

Constant Field Values

DEFAULT_NFLOADBALANCER_CLASSNAME

public static final java.lang.String DEFAULT_NFLOADBALANCER_CLASSNAME

See Also:

Constant Field Values

DEFAULT_CLIENT_CLASSNAME

public static final java.lang.String DEFAULT_CLIENT_CLASSNAME

See Also:

Constant Field Values

DEFAULT_VIPADDRESS_RESOLVER_CLASSNAME

public static final java.lang.String DEFAULT_VIPADDRESS_RESOLVER_CLASSNAME

See Also:

Constant Field Values

DEFAULT_PRIME_CONNECTIONS_URI

public static final java.lang.String DEFAULT_PRIME_CONNECTIONS_URI

See Also:

Constant Field Values

DEFAULT_MAX_TOTAL_TIME_TO_PRIME_CONNECTIONS

public static final int DEFAULT_MAX_TOTAL_TIME_TO_PRIME_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_MAX_RETRIES_PER_SERVER_PRIME_CONNECTION

public static final int DEFAULT_MAX_RETRIES_PER_SERVER_PRIME_CONNECTION

See Also:

Constant Field Values

DEFAULT_ENABLE_PRIME_CONNECTIONS

public static final java.lang.Boolean DEFAULT_ENABLE_PRIME_CONNECTIONS

DEFAULT_MAX_REQUESTS_ALLOWED_PER_WINDOW

public static final int DEFAULT_MAX_REQUESTS_ALLOWED_PER_WINDOW

See Also:

Constant Field Values

DEFAULT_REQUEST_THROTTLING_WINDOW_IN_MILLIS

public static final int DEFAULT_REQUEST_THROTTLING_WINDOW_IN_MILLIS

See Also:

Constant Field Values

DEFAULT_ENABLE_REQUEST_THROTTLING

public static final java.lang.Boolean DEFAULT_ENABLE_REQUEST_THROTTLING

DEFAULT_ENABLE_GZIP_CONTENT_ENCODING_FILTER

public static final java.lang.Boolean DEFAULT_ENABLE_GZIP_CONTENT_ENCODING_FILTER

DEFAULT_CONNECTION_POOL_CLEANER_TASK_ENABLED

public static final java.lang.Boolean DEFAULT_CONNECTION_POOL_CLEANER_TASK_ENABLED

DEFAULT_FOLLOW_REDIRECTS

public static final java.lang.Boolean DEFAULT_FOLLOW_REDIRECTS

DEFAULT_PERCENTAGE_NIWS_EVENT_LOGGED

public static final float DEFAULT_PERCENTAGE_NIWS_EVENT_LOGGED

See Also:

Constant Field Values

DEFAULT_MAX_AUTO_RETRIES_NEXT_SERVER

public static final int DEFAULT_MAX_AUTO_RETRIES_NEXT_SERVER

See Also:

Constant Field Values

DEFAULT_MAX_AUTO_RETRIES

public static final int DEFAULT_MAX_AUTO_RETRIES

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CONNECTION_MANAGER_TIMEOUT

public static final int DEFAULT_CONNECTION_MANAGER_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_MAX_HTTP_CONNECTIONS_PER_HOST

public static final int DEFAULT_MAX_HTTP_CONNECTIONS_PER_HOST

See Also:

Constant Field Values

DEFAULT_MAX_TOTAL_HTTP_CONNECTIONS

public static final int DEFAULT_MAX_TOTAL_HTTP_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_MIN_PRIME_CONNECTIONS_RATIO

public static final float DEFAULT_MIN_PRIME_CONNECTIONS_RATIO

See Also:

Constant Field Values

DEFAULT_PRIME_CONNECTIONS_CLASS

public static final java.lang.String DEFAULT_PRIME_CONNECTIONS_CLASS

See Also:

Constant Field Values

DEFAULT_SEVER_LIST_CLASS

public static final java.lang.String DEFAULT_SEVER_LIST_CLASS

See Also:

Constant Field Values

DEFAULT_CONNECTION_IDLE_TIMERTASK_REPEAT_IN_MSECS

public static final int DEFAULT_CONNECTION_IDLE_TIMERTASK_REPEAT_IN_MSECS

See Also:

Constant Field Values

DEFAULT_CONNECTIONIDLE_TIME_IN_MSECS

public static final int DEFAULT_CONNECTIONIDLE_TIME_IN_MSECS

See Also:

Constant Field Values

DEFAULT_POOL_MAX_THREADS

public static final int DEFAULT_POOL_MAX_THREADS

Defaults for the parameters for the thread pool used by batchParallel calls

See Also:

Constant Field Values

DEFAULT_POOL_MIN_THREADS

public static final int DEFAULT_POOL_MIN_THREADS

See Also:

Constant Field Values

DEFAULT_POOL_KEEP_ALIVE_TIME

public static final long DEFAULT_POOL_KEEP_ALIVE_TIME

See Also:

Constant Field Values

DEFAULT_POOL_KEEP_ALIVE_TIME_UNITS

public static final java.util.concurrent.TimeUnit DEFAULT_POOL_KEEP_ALIVE_TIME_UNITS

DEFAULT_ENABLE_ZONE_AFFINITY

public static final java.lang.Boolean DEFAULT_ENABLE_ZONE_AFFINITY

DEFAULT_ENABLE_ZONE_EXCLUSIVITY

public static final java.lang.Boolean DEFAULT_ENABLE_ZONE_EXCLUSIVITY

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_ENABLE_LOADBALANCER

public static final java.lang.Boolean DEFAULT_ENABLE_LOADBALANCER

DEFAULT_PROPERTY_NAME_SPACE

public static final java.lang.String DEFAULT_PROPERTY_NAME_SPACE

See Also:

Constant Field Values

DEFAULT_OK_TO_RETRY_ON_ALL_OPERATIONS

public static final java.lang.Boolean DEFAULT_OK_TO_RETRY_ON_ALL_OPERATIONS

DEFAULT_ENABLE_NIWS_EVENT_LOGGING

public static final java.lang.Boolean DEFAULT_ENABLE_NIWS_EVENT_LOGGING

Constructor Detail

DefaultClientConfigImpl

public DefaultClientConfigImpl()

Create instance with no properties in default name space DEFAULT_PROPERTY_NAME_SPACE

DefaultClientConfigImpl

public DefaultClientConfigImpl(java.lang.String nameSpace)

Create instance with no properties in the specified name space

Method Detail

getDefaultPrioritizeVipAddressBasedServers

public java.lang.Boolean getDefaultPrioritizeVipAddressBasedServers()

getDefaultNfloadbalancerPingClassname

public java.lang.String getDefaultNfloadbalancerPingClassname()

getDefaultNfloadbalancerRuleClassname

public java.lang.String getDefaultNfloadbalancerRuleClassname()

getDefaultNfloadbalancerClassname

public java.lang.String getDefaultNfloadbalancerClassname()

getDefaultClientClassname

public java.lang.String getDefaultClientClassname()

getDefaultVipaddressResolverClassname

public java.lang.String getDefaultVipaddressResolverClassname()

getDefaultPrimeConnectionsUri

public java.lang.String getDefaultPrimeConnectionsUri()

getDefaultMaxTotalTimeToPrimeConnections

public int getDefaultMaxTotalTimeToPrimeConnections()

getDefaultMaxRetriesPerServerPrimeConnection

public int getDefaultMaxRetriesPerServerPrimeConnection()

getDefaultEnablePrimeConnections

public java.lang.Boolean getDefaultEnablePrimeConnections()

getDefaultMaxRequestsAllowedPerWindow

public int getDefaultMaxRequestsAllowedPerWindow()

getDefaultRequestThrottlingWindowInMillis

public int getDefaultRequestThrottlingWindowInMillis()

getDefaultEnableRequestThrottling

public java.lang.Boolean getDefaultEnableRequestThrottling()

getDefaultEnableGzipContentEncodingFilter

public java.lang.Boolean getDefaultEnableGzipContentEncodingFilter()

getDefaultConnectionPoolCleanerTaskEnabled

public java.lang.Boolean getDefaultConnectionPoolCleanerTaskEnabled()

getDefaultFollowRedirects

public java.lang.Boolean getDefaultFollowRedirects()

getDefaultPercentageNiwsEventLogged

public float getDefaultPercentageNiwsEventLogged()

getDefaultMaxAutoRetriesNextServer

public int getDefaultMaxAutoRetriesNextServer()

getDefaultMaxAutoRetries

public int getDefaultMaxAutoRetries()

getDefaultReadTimeout

public int getDefaultReadTimeout()

getDefaultConnectionManagerTimeout

public int getDefaultConnectionManagerTimeout()

getDefaultConnectTimeout

public int getDefaultConnectTimeout()

getDefaultMaxHttpConnectionsPerHost

public int getDefaultMaxHttpConnectionsPerHost()

getDefaultMaxTotalHttpConnections

public int getDefaultMaxTotalHttpConnections()

getDefaultMinPrimeConnectionsRatio

public float getDefaultMinPrimeConnectionsRatio()

getDefaultPrimeConnectionsClass

public java.lang.String getDefaultPrimeConnectionsClass()

getDefaultSeverListClass

public java.lang.String getDefaultSeverListClass()

getDefaultConnectionIdleTimertaskRepeatInMsecs

public int getDefaultConnectionIdleTimertaskRepeatInMsecs()

getDefaultConnectionidleTimeInMsecs

public int getDefaultConnectionidleTimeInMsecs()

getResolver

public VipAddressResolver getResolver()

isEnableDynamicProperties

public boolean isEnableDynamicProperties()

getDefaultPoolMaxThreads

public int getDefaultPoolMaxThreads()

getDefaultPoolMinThreads

public int getDefaultPoolMinThreads()

getDefaultPoolKeepAliveTime

public long getDefaultPoolKeepAliveTime()

getDefaultPoolKeepAliveTimeUnits

public java.util.concurrent.TimeUnit getDefaultPoolKeepAliveTimeUnits()

getDefaultEnableZoneAffinity

public java.lang.Boolean getDefaultEnableZoneAffinity()

getDefaultEnableZoneExclusivity

public java.lang.Boolean getDefaultEnableZoneExclusivity()

getDefaultPort

public int getDefaultPort()

getDefaultEnableLoadbalancer

public java.lang.Boolean getDefaultEnableLoadbalancer()

getDefaultOkToRetryOnAllOperations

public java.lang.Boolean getDefaultOkToRetryOnAllOperations()

loadDefaultValues

protected void loadDefaultValues()

getDefaultPropName

public java.lang.String getDefaultPropName(IClientConfigKey propName)

setClientName

public void setClientName(java.lang.String clientName)

getClientName

public java.lang.String getClientName()

Specified by:

getClientName in interface IClientConfig

loadProperties

public void loadProperties(java.lang.String restClientName)

Load properties for a given client. It first loads the default values for all properties, and any properties already defined with Archaius ConfigurationManager.

Specified by:

loadProperties in interface IClientConfig

resolveDeploymentContextbasedVipAddresses

public java.lang.String resolveDeploymentContextbasedVipAddresses()

Description copied from interface: IClientConfig

Returns the applicable virtual addresses ("vip") used by this client configuration.

Specified by:

resolveDeploymentContextbasedVipAddresses in interface IClientConfig

Returns:

getAppName

public java.lang.String getAppName()

getVersion

public java.lang.String getVersion()

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Specified by:

getProperties in interface IClientConfig

setProperty

public void setProperty(IClientConfigKey key,
                        java.lang.Object value)

Specified by:

setProperty in interface IClientConfig

applyOverride

public IClientConfig applyOverride(IClientConfig override)

getProperty

public java.lang.Object getProperty(IClientConfigKey key)

Specified by:

getProperty in interface IClientConfig

getProperty

public java.lang.Object getProperty(IClientConfigKey key,
                                    java.lang.Object defaultVal)

Specified by:

getProperty in interface IClientConfig

getProperty

public static java.lang.Object getProperty(java.util.Map<java.lang.String,java.lang.Object> config,
                                           IClientConfigKey key,
                                           java.lang.Object defaultVal)

getProperty

public static java.lang.Object getProperty(java.util.Map<java.lang.String,java.lang.Object> config,
                                           IClientConfigKey key)

isSecure

public boolean isSecure()

containsProperty

public boolean containsProperty(IClientConfigKey key)

Specified by:

containsProperty in interface IClientConfig

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setProperty

public void setProperty(java.util.Properties props,
                        java.lang.String restClientName,
                        java.lang.String key,
                        java.lang.String value)

getInstancePropName

public java.lang.String getInstancePropName(java.lang.String restClientName,
                                            IClientConfigKey configKey)

getInstancePropName

public java.lang.String getInstancePropName(java.lang.String restClientName,
                                            java.lang.String key)

getNameSpace

public java.lang.String getNameSpace()

Specified by:

getNameSpace in interface IClientConfig

getClientConfigWithDefaultValues

public static DefaultClientConfigImpl getClientConfigWithDefaultValues(java.lang.String clientName)

getClientConfigWithDefaultValues

public static DefaultClientConfigImpl getClientConfigWithDefaultValues(java.lang.String clientName,
                                                                       java.lang.String nameSpace)