com.netflix.eureka
Class DefaultEurekaServerConfig

java.lang.Object
  com.netflix.eureka.DefaultEurekaServerConfig

All Implemented Interfaces:

EurekaServerConfig

public class DefaultEurekaServerConfig
extends java.lang.Object
implements EurekaServerConfig

A default implementation of eureka server configuration as required by EurekaServerConfig.

The information required for configuring eureka server is provided in a configuration file.The configuration file is searched for in the classpath with the name specified by the property eureka.server.props and with the suffix .properties. If the property is not specified, eureka-server.properties is assumed as the default.The properties that are looked up uses the namespace passed on to this class.

If the eureka.environment property is specified, additionally eureka-server-.properties is loaded in addition to eureka-server.properties.

Constructor Summary

DefaultEurekaServerConfig()

DefaultEurekaServerConfig(java.lang.String namespace)

Method Summary

int	getASGQueryTimeoutMs() Get the timeout value for querying the AWS for ASG information.
long	getASGUpdateIntervalMs() Get the time interval with which the ASG information must be queried from AWS
java.lang.String	getAWSAccessId() Gets the AWS Access Id.
java.lang.String	getAWSSecretKey() Gets the AWS Secret Key.
long	getDeltaRetentionTimerIntervalInMs() Get the time interval with which the clean up task should wake up and check for expired delta information.
int	getEIPBindingRetryIntervalMs() Gets the interval with which the server should check if the EIP is bound and should try to bind in the case if it is already not bound.
int	getEIPBindRebindRetries() Gets the number of times the server should try to bind to the candidate EIP.
long	getEvictionIntervalTimerInMs() Get the time interval with which the task that expires instances should wake up and run.
int	getMaxElementsInPeerReplicationPool() Get the maximum number of replication events that can be allowed to back up in the replication pool.
int	getMaxElementsInStatusReplicationPool() Get the maximum number of replication events that can be allowed to back up in the status replication pool.
long	getMaxIdleThreadAgeInMinutesForPeerReplication() Get the idle time for which the replication threads can stay alive.
long	getMaxIdleThreadInMinutesAgeForStatusReplication() Get the idle time for which the status replication threads can stay alive.
int	getMaxThreadsForPeerReplication() Get the maximum number of threads to be used for replication.
int	getMaxThreadsForStatusReplication() Get the maximum number of threads to be used for status replication.
int	getMaxTimeForReplication() Get the time in milliseconds to try to replicate before dropping replication events.
int	getMinThreadsForPeerReplication() Get the minimum number of threads to be used for replication.
int	getMinThreadsForStatusReplication() Get the minimum number of threads to be used for status replication.
int	getNumberOfReplicationRetries() Get the number of times the replication events should be retried with peers.
int	getPeerEurekaNodesUpdateIntervalMs() The interval with which the information about the changes in peer eureka nodes is updated.
int	getPeerEurekaStatusRefreshTimeIntervalMs() Gets the interval with which the status information about peer nodes is updated.
int	getPeerNodeConnectionIdleTimeoutSeconds() Gets the idle time after which the HTTP connection should be cleaned up.
int	getPeerNodeConnectTimeoutMs() Gets the timeout value for connecting to peer eureka nodes for replication.
int	getPeerNodeReadTimeoutMs() Gets the timeout value for reading information from peer eureka nodes for replication.
int	getPeerNodeTotalConnections() Gets the total number of HTTP connections allowed to peer eureka nodes for replication.
int	getPeerNodeTotalConnectionsPerHost() Gets the total number of HTTP connections allowed to a particular peer eureka node for replication.
int	getRegistrySyncRetries() Get the number of times that a eureka node would try to get the registry information from the peers during startup.
int	getRemoteRegionConnectionIdleTimeoutSeconds() Gets the idle time after which the HTTP connection should be cleaned up for remote regions.
int	getRemoteRegionConnectTimeoutMs() Gets the timeout value for connecting to peer eureka nodes for remote regions.
int	getRemoteRegionReadTimeoutMs() Gets the timeout value for reading information from peer eureka nodes for remote regions.
int	getRemoteRegionRegistryFetchInterval() Get the time interval for which the registryinformation need to be fetched from the remote region.
int	getRemoteRegionTotalConnections() Gets the total number of HTTP connections allowed to peer eureka nodes for remote regions.
int	getRemoteRegionTotalConnectionsPerHost() Gets the total number of HTTP connections allowed to a particular peer eureka node for remote regions.
java.lang.String[]	getRemoteRegionUrls() Get the list of remote region urls
double	getRenewalPercentThreshold() The minimum percentage of renewals that is expected from the clients in the period specified by EurekaServerConfig.getRenewalThresholdUpdateIntervalMs().
int	getRenewalThresholdUpdateIntervalMs() The interval with which the threshold as specified in EurekaServerConfig.getRenewalPercentThreshold() needs to be updated.
long	getResponseCacheAutoExpirationInSeconds() Gets the time for which the registry payload should be kept in the cache if it is not invalidated by change events.
long	getResponseCacheUpdateIntervalMs() Gets the time interval with which the payload cache of the client should be updated.
long	getRetentionTimeInMSInDeltaQueue() Get the time for which the delta information should be cached for the clients to retrieve the value without missing it.
int	getWaitTimeInMsWhenSyncEmpty() Gets the time to wait when the eureka server starts up unable to get instances from peer nodes.
boolean	shouldDisableDelta() Checks to see if the delta information can be served to client or not.
boolean	shouldDisableDeltaForRemoteRegions() Checks to see if the delta information can be served to client or not for remote regions.
boolean	shouldEnableSelfPreservation() Checks to see if the eureka server is enabled for self preservation.
boolean	shouldGZipContentFromRemoteRegion() Indicates whether the content fetched from eureka server has to be compressed for remote regions whenever it is supported by the server.
boolean	shouldPrimeAwsReplicaConnections() Checks whether the connections to replicas should be primed.
boolean	shouldSyncWhenTimestampDiffers() Checks whether to synchronize instances when timestamp differs.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEurekaServerConfig

public DefaultEurekaServerConfig()

DefaultEurekaServerConfig

public DefaultEurekaServerConfig(java.lang.String namespace)

Method Detail

getAWSAccessId

public java.lang.String getAWSAccessId()

Description copied from interface: EurekaServerConfig

Gets the AWS Access Id. This is primarily used for Elastic IP Biding. The access id should be provided with appropriate AWS permissions to bind the EIP.

Specified by:

getAWSAccessId in interface EurekaServerConfig

Returns:

getAWSSecretKey

public java.lang.String getAWSSecretKey()

Description copied from interface: EurekaServerConfig

Gets the AWS Secret Key. This is primarily used for Elastic IP Biding. The access id should be provided with appropriate AWS permissions to bind the EIP.

Specified by:

getAWSSecretKey in interface EurekaServerConfig

Returns:

getEIPBindRebindRetries

public int getEIPBindRebindRetries()

Description copied from interface: EurekaServerConfig

Gets the number of times the server should try to bind to the candidate EIP.

The changes are effective at runtime.

Specified by:

getEIPBindRebindRetries in interface EurekaServerConfig

Returns:

the number of times the server should try to bind to the candidate EIP.

getEIPBindingRetryIntervalMs

public int getEIPBindingRetryIntervalMs()

Description copied from interface: EurekaServerConfig

Gets the interval with which the server should check if the EIP is bound and should try to bind in the case if it is already not bound.

The changes are effective at runtime.

Specified by:

getEIPBindingRetryIntervalMs in interface EurekaServerConfig

Returns:

the time in milliseconds.

shouldEnableSelfPreservation

public boolean shouldEnableSelfPreservation()

Description copied from interface: EurekaServerConfig

Checks to see if the eureka server is enabled for self preservation.

When enabled, the server keeps track of the number of renewals it should receive from the server. Any time, the number of renewals drops below the threshold percentage as defined by EurekaServerConfig.getRenewalPercentThreshold(), the server turns off expirations to avert danger.This will help the server in maintaining the registry information in case of network problems between client and the server.

The changes are effective at runtime.

Specified by:

shouldEnableSelfPreservation in interface EurekaServerConfig

Returns:

true to enable self preservation, false otherwise.

getPeerEurekaNodesUpdateIntervalMs

public int getPeerEurekaNodesUpdateIntervalMs()

Description copied from interface: EurekaServerConfig

The interval with which the information about the changes in peer eureka nodes is updated. The user can use the DNS mechanism or dynamic configuration provided by https://github.com/Netflix/archaius to change the information dynamically.

The changes are effective at runtime.

Specified by:

getPeerEurekaNodesUpdateIntervalMs in interface EurekaServerConfig

Returns:

timer in milliseconds indicating the interval.

getRenewalThresholdUpdateIntervalMs

public int getRenewalThresholdUpdateIntervalMs()

Description copied from interface: EurekaServerConfig

The interval with which the threshold as specified in EurekaServerConfig.getRenewalPercentThreshold() needs to be updated.

Specified by:

getRenewalThresholdUpdateIntervalMs in interface EurekaServerConfig

Returns:

time in milliseconds indicating the interval.

getRenewalPercentThreshold

public double getRenewalPercentThreshold()

Description copied from interface: EurekaServerConfig

The minimum percentage of renewals that is expected from the clients in the period specified by EurekaServerConfig.getRenewalThresholdUpdateIntervalMs(). If the renewals drop below the threshold, the expirations are disabled if the EurekaServerConfig.shouldEnableSelfPreservation() is enabled.

The changes are effective at runtime.

Specified by:

getRenewalPercentThreshold in interface EurekaServerConfig

Returns:

value between 0 and 1 indicating the percentage. For example, 85% will be specified as 0.85.

getNumberOfReplicationRetries

public int getNumberOfReplicationRetries()

Description copied from interface: EurekaServerConfig

Get the number of times the replication events should be retried with peers.

The changes are effective at runtime.

Specified by:

getNumberOfReplicationRetries in interface EurekaServerConfig

Returns:

the number of retries.

getPeerEurekaStatusRefreshTimeIntervalMs

public int getPeerEurekaStatusRefreshTimeIntervalMs()

Description copied from interface: EurekaServerConfig

Gets the interval with which the status information about peer nodes is updated.

The changes are effective at runtime.

Specified by:

getPeerEurekaStatusRefreshTimeIntervalMs in interface EurekaServerConfig

Returns:

time in milliseconds indicating the interval.

getWaitTimeInMsWhenSyncEmpty

public int getWaitTimeInMsWhenSyncEmpty()

Description copied from interface: EurekaServerConfig

Gets the time to wait when the eureka server starts up unable to get instances from peer nodes. It is better not to start serving rightaway during these scenarios as the information that is stored in the registry may not be complete. When the instance registry starts up empty, it builds over time when the clients start to send heartbeats and the server requests the clients for registration information.

Specified by:

getWaitTimeInMsWhenSyncEmpty in interface EurekaServerConfig

Returns:

time in milliseconds.

getPeerNodeConnectTimeoutMs

public int getPeerNodeConnectTimeoutMs()

Description copied from interface: EurekaServerConfig

Gets the timeout value for connecting to peer eureka nodes for replication.

Specified by:

getPeerNodeConnectTimeoutMs in interface EurekaServerConfig

Returns:

timeout value in milliseconds.

getPeerNodeReadTimeoutMs

public int getPeerNodeReadTimeoutMs()

Description copied from interface: EurekaServerConfig

Gets the timeout value for reading information from peer eureka nodes for replication.

Specified by:

getPeerNodeReadTimeoutMs in interface EurekaServerConfig

Returns:

timeout value in milliseconds.

getPeerNodeTotalConnections

public int getPeerNodeTotalConnections()

Description copied from interface: EurekaServerConfig

Gets the total number of HTTP connections allowed to peer eureka nodes for replication.

Specified by:

getPeerNodeTotalConnections in interface EurekaServerConfig

Returns:

total number of allowed HTTP connections.

getPeerNodeTotalConnectionsPerHost

public int getPeerNodeTotalConnectionsPerHost()

Description copied from interface: EurekaServerConfig

Gets the total number of HTTP connections allowed to a particular peer eureka node for replication.

Specified by:

getPeerNodeTotalConnectionsPerHost in interface EurekaServerConfig

Returns:

total number of allowed HTTP connections for a peer node.

getPeerNodeConnectionIdleTimeoutSeconds

public int getPeerNodeConnectionIdleTimeoutSeconds()

Description copied from interface: EurekaServerConfig

Gets the idle time after which the HTTP connection should be cleaned up.

Specified by:

getPeerNodeConnectionIdleTimeoutSeconds in interface EurekaServerConfig

Returns:

idle time in seconds.

getRetentionTimeInMSInDeltaQueue

public long getRetentionTimeInMSInDeltaQueue()

Description copied from interface: EurekaServerConfig

Get the time for which the delta information should be cached for the clients to retrieve the value without missing it.

Specified by:

getRetentionTimeInMSInDeltaQueue in interface EurekaServerConfig

Returns:

time in milliseconds

getDeltaRetentionTimerIntervalInMs

public long getDeltaRetentionTimerIntervalInMs()

Description copied from interface: EurekaServerConfig

Get the time interval with which the clean up task should wake up and check for expired delta information.

Specified by:

getDeltaRetentionTimerIntervalInMs in interface EurekaServerConfig

Returns:

time in milliseconds.

getEvictionIntervalTimerInMs

public long getEvictionIntervalTimerInMs()

Description copied from interface: EurekaServerConfig

Get the time interval with which the task that expires instances should wake up and run.

Specified by:

getEvictionIntervalTimerInMs in interface EurekaServerConfig

Returns:

time in milliseconds.

getASGQueryTimeoutMs

public int getASGQueryTimeoutMs()

Description copied from interface: EurekaServerConfig

Get the timeout value for querying the AWS for ASG information.

Specified by:

getASGQueryTimeoutMs in interface EurekaServerConfig

Returns:

timeout value in milliseconds.

getASGUpdateIntervalMs

public long getASGUpdateIntervalMs()

Description copied from interface: EurekaServerConfig

Get the time interval with which the ASG information must be queried from AWS

Specified by:

getASGUpdateIntervalMs in interface EurekaServerConfig

Returns:

time in milliseconds.

getResponseCacheAutoExpirationInSeconds

public long getResponseCacheAutoExpirationInSeconds()

Description copied from interface: EurekaServerConfig

Gets the time for which the registry payload should be kept in the cache if it is not invalidated by change events.

Specified by:

getResponseCacheAutoExpirationInSeconds in interface EurekaServerConfig

Returns:

time in seconds.

getResponseCacheUpdateIntervalMs

public long getResponseCacheUpdateIntervalMs()

Description copied from interface: EurekaServerConfig

Gets the time interval with which the payload cache of the client should be updated.

Specified by:

getResponseCacheUpdateIntervalMs in interface EurekaServerConfig

Returns:

time in milliseconds.

shouldDisableDelta

public boolean shouldDisableDelta()

Description copied from interface: EurekaServerConfig

Checks to see if the delta information can be served to client or not.

The changes are effective at runtime.

Specified by:

shouldDisableDelta in interface EurekaServerConfig

Returns:

true if the delta information is allowed to be served, false otherwise.

getMaxIdleThreadInMinutesAgeForStatusReplication

public long getMaxIdleThreadInMinutesAgeForStatusReplication()

Description copied from interface: EurekaServerConfig

Get the idle time for which the status replication threads can stay alive.

Specified by:

getMaxIdleThreadInMinutesAgeForStatusReplication in interface EurekaServerConfig

Returns:

time in minutes.

getMinThreadsForStatusReplication

public int getMinThreadsForStatusReplication()

Description copied from interface: EurekaServerConfig

Get the minimum number of threads to be used for status replication.

Specified by:

getMinThreadsForStatusReplication in interface EurekaServerConfig

Returns:

minimum number of threads to be used for status replication.

getMaxThreadsForStatusReplication

public int getMaxThreadsForStatusReplication()

Description copied from interface: EurekaServerConfig

Get the maximum number of threads to be used for status replication.

Specified by:

getMaxThreadsForStatusReplication in interface EurekaServerConfig

Returns:

maximum number of threads to be used for status replication.

getMaxElementsInStatusReplicationPool

public int getMaxElementsInStatusReplicationPool()

Description copied from interface: EurekaServerConfig

Get the maximum number of replication events that can be allowed to back up in the status replication pool.

Depending on the memory allowed, timeout and the replication traffic, this value can vary.

Specified by:

getMaxElementsInStatusReplicationPool in interface EurekaServerConfig

Returns:

the maximum number of replication events that can be allowed to back up.

shouldSyncWhenTimestampDiffers

public boolean shouldSyncWhenTimestampDiffers()

Description copied from interface: EurekaServerConfig

Checks whether to synchronize instances when timestamp differs.

The changes are effective at runtime.

Specified by:

shouldSyncWhenTimestampDiffers in interface EurekaServerConfig

Returns:

true, to synchronize, false otherwise.

getRegistrySyncRetries

public int getRegistrySyncRetries()

Description copied from interface: EurekaServerConfig

Get the number of times that a eureka node would try to get the registry information from the peers during startup.

Specified by:

getRegistrySyncRetries in interface EurekaServerConfig

Returns:

the number of retries

getMaxElementsInPeerReplicationPool

public int getMaxElementsInPeerReplicationPool()

Description copied from interface: EurekaServerConfig

Get the maximum number of replication events that can be allowed to back up in the replication pool. This replication pool is responsible for all events except status updates.

Depending on the memory allowed, timeout and the replication traffic, this value can vary.

Specified by:

getMaxElementsInPeerReplicationPool in interface EurekaServerConfig

Returns:

the maximum number of replication events that can be allowed to back up.

getMaxIdleThreadAgeInMinutesForPeerReplication

public long getMaxIdleThreadAgeInMinutesForPeerReplication()

Description copied from interface: EurekaServerConfig

Get the idle time for which the replication threads can stay alive.

Specified by:

getMaxIdleThreadAgeInMinutesForPeerReplication in interface EurekaServerConfig

Returns:

time in minutes.

getMinThreadsForPeerReplication

public int getMinThreadsForPeerReplication()

Description copied from interface: EurekaServerConfig

Get the minimum number of threads to be used for replication.

Specified by:

getMinThreadsForPeerReplication in interface EurekaServerConfig

Returns:

minimum number of threads to be used for replication.

getMaxThreadsForPeerReplication

public int getMaxThreadsForPeerReplication()

Description copied from interface: EurekaServerConfig

Get the maximum number of threads to be used for replication.

Specified by:

getMaxThreadsForPeerReplication in interface EurekaServerConfig

Returns:

maximum number of threads to be used for replication.

getMaxTimeForReplication

public int getMaxTimeForReplication()

Description copied from interface: EurekaServerConfig

Get the time in milliseconds to try to replicate before dropping replication events.

Specified by:

getMaxTimeForReplication in interface EurekaServerConfig

Returns:

time in milliseconds

shouldPrimeAwsReplicaConnections

public boolean shouldPrimeAwsReplicaConnections()

Description copied from interface: EurekaServerConfig

Checks whether the connections to replicas should be primed. In AWS, the firewall requires sometime to establish network connection for new nodes.

Specified by:

shouldPrimeAwsReplicaConnections in interface EurekaServerConfig

Returns:

true, if connections should be primed, false otherwise.

shouldDisableDeltaForRemoteRegions

public boolean shouldDisableDeltaForRemoteRegions()

Description copied from interface: EurekaServerConfig

Checks to see if the delta information can be served to client or not for remote regions.

The changes are effective at runtime.

Specified by:

shouldDisableDeltaForRemoteRegions in interface EurekaServerConfig

Returns:

true if the delta information is allowed to be served, false otherwise.

getRemoteRegionConnectTimeoutMs

public int getRemoteRegionConnectTimeoutMs()

Description copied from interface: EurekaServerConfig

Gets the timeout value for connecting to peer eureka nodes for remote regions.

Specified by:

getRemoteRegionConnectTimeoutMs in interface EurekaServerConfig

Returns:

timeout value in milliseconds.

getRemoteRegionReadTimeoutMs

public int getRemoteRegionReadTimeoutMs()

Description copied from interface: EurekaServerConfig

Gets the timeout value for reading information from peer eureka nodes for remote regions.

Specified by:

getRemoteRegionReadTimeoutMs in interface EurekaServerConfig

Returns:

timeout value in milliseconds.

getRemoteRegionTotalConnections

public int getRemoteRegionTotalConnections()

Description copied from interface: EurekaServerConfig

Gets the total number of HTTP connections allowed to peer eureka nodes for remote regions.

Specified by:

getRemoteRegionTotalConnections in interface EurekaServerConfig

Returns:

total number of allowed HTTP connections.

getRemoteRegionTotalConnectionsPerHost

public int getRemoteRegionTotalConnectionsPerHost()

Description copied from interface: EurekaServerConfig

Gets the total number of HTTP connections allowed to a particular peer eureka node for remote regions.

Specified by:

getRemoteRegionTotalConnectionsPerHost in interface EurekaServerConfig

Returns:

total number of allowed HTTP connections for a peer node.

getRemoteRegionConnectionIdleTimeoutSeconds

public int getRemoteRegionConnectionIdleTimeoutSeconds()

Description copied from interface: EurekaServerConfig

Gets the idle time after which the HTTP connection should be cleaned up for remote regions.

Specified by:

getRemoteRegionConnectionIdleTimeoutSeconds in interface EurekaServerConfig

Returns:

idle time in seconds.

shouldGZipContentFromRemoteRegion

public boolean shouldGZipContentFromRemoteRegion()

Description copied from interface: EurekaServerConfig

Indicates whether the content fetched from eureka server has to be compressed for remote regions whenever it is supported by the server. The registry information from the eureka server is compressed for optimum network traffic.

Specified by:

shouldGZipContentFromRemoteRegion in interface EurekaServerConfig

Returns:

true, if the content need to be compressed, false otherwise.

getRemoteRegionUrls

public java.lang.String[] getRemoteRegionUrls()

Description copied from interface: EurekaServerConfig

Get the list of remote region urls

Specified by:

getRemoteRegionUrls in interface EurekaServerConfig

Returns:

- array of string representing URLs.

getRemoteRegionRegistryFetchInterval

public int getRemoteRegionRegistryFetchInterval()

Description copied from interface: EurekaServerConfig

Get the time interval for which the registryinformation need to be fetched from the remote region.

Specified by:

getRemoteRegionRegistryFetchInterval in interface EurekaServerConfig

Returns:

time in seconds.