com.netflix.client.config

Interface IClientConfig

All Known Implementing Classes:

DefaultClientConfigImpl

public interface IClientConfig

Defines the client configuration used by various APIs to initialize clients or load balancers and for method execution. The default implementation is DefaultClientConfigImpl.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IClientConfig.Builder

Method Summary

Modifier and Type	Method and Description
boolean	containsProperty(IClientConfigKey key)
<T> T	get(IClientConfigKey<T> key) Returns a typed property.
<T> T	get(IClientConfigKey<T> key, T defaultValue) Returns a typed property.
java.lang.String	getClientName()
java.lang.String	getNameSpace()
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
java.lang.Object	getProperty(IClientConfigKey key) Deprecated. use get(IClientConfigKey)
java.lang.Object	getProperty(IClientConfigKey key, java.lang.Object defaultVal) Deprecated. use get(IClientConfigKey, Object)
boolean	getPropertyAsBoolean(IClientConfigKey key, boolean defaultValue)
int	getPropertyAsInteger(IClientConfigKey key, int defaultValue)
java.lang.String	getPropertyAsString(IClientConfigKey key, java.lang.String defaultValue)
void	loadDefaultValues() load default values for this configuration
void	loadProperties(java.lang.String clientName) Load the properties for a given client and/or load balancer.
java.lang.String	resolveDeploymentContextbasedVipAddresses() Returns the applicable virtual addresses ("vip") used by this client configuration.
<T> IClientConfig	set(IClientConfigKey<T> key, T value) Set the typed property with the given value.
void	setProperty(IClientConfigKey key, java.lang.Object value) Deprecated. use set(IClientConfigKey, Object)

Method Detail

getClientName

java.lang.String getClientName()

getNameSpace

java.lang.String getNameSpace()

loadProperties

void loadProperties(java.lang.String clientName)

Load the properties for a given client and/or load balancer.

Parameters:

clientName -

loadDefaultValues

void loadDefaultValues()

load default values for this configuration

getProperties

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

setProperty

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

Deprecated. use set(IClientConfigKey, Object)

getProperty

@Deprecated
java.lang.Object getProperty(IClientConfigKey key)

Deprecated. use get(IClientConfigKey)

getProperty

@Deprecated
java.lang.Object getProperty(IClientConfigKey key,
                                         java.lang.Object defaultVal)

Deprecated. use get(IClientConfigKey, Object)

containsProperty

boolean containsProperty(IClientConfigKey key)

resolveDeploymentContextbasedVipAddresses

java.lang.String resolveDeploymentContextbasedVipAddresses()

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

getPropertyAsInteger

int getPropertyAsInteger(IClientConfigKey key,
                         int defaultValue)

getPropertyAsString

java.lang.String getPropertyAsString(IClientConfigKey key,
                                     java.lang.String defaultValue)

getPropertyAsBoolean

boolean getPropertyAsBoolean(IClientConfigKey key,
                             boolean defaultValue)

get

<T> T get(IClientConfigKey<T> key)

Returns a typed property. If the property of IClientConfigKey is not set, it returns null.

For DefaultClientConfigImpl, if the value of the property is String, it will do basic type conversion from String to the following type:

• Integer
• Boolean
• Float
• Long
• Double

get

<T> T get(IClientConfigKey<T> key,
          T defaultValue)

Returns a typed property. If the property of IClientConfigKey is not set, it returns the default value passed in as the parameter.

set

<T> IClientConfig set(IClientConfigKey<T> key,
                      T value)

Set the typed property with the given value.