DefaultEurekaServerConfig (eureka-core 1.8.0 API)

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

All Implemented Interfaces:

EurekaServerConfig
```
@Singleton
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

Constructors
Constructor and Description

DefaultEurekaServerConfig()

DefaultEurekaServerConfig(java.lang.String namespace)

Constructors
Constructor and Description
`DefaultEurekaServerConfig()`
`DefaultEurekaServerConfig(java.lang.String namespace)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`disableTransparentFallbackToOtherRegion()` Old behavior of fallback to applications in the remote region (if configured) if there are no instances of that application in the local region, will be disabled.
`long`	`getASGCacheExpiryTimeoutMs()` Get the expiration value for the cached ASG information
`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.
`AwsBindingStrategy`	`getBindingStrategy()` Get the configured binding strategy EIP or Route53.
`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, iff the EIP is already bound.
`int`	`getEIPBindingRetryIntervalMsWhenUnbound()` Get 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, iff the EIP is not currently 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.
`java.lang.String`	`getExperimental(java.lang.String name)` To avoid configuration API pollution when trying new/experimental or features or for the migration process, the corresponding configuration can be put into experimental configuration section.
`int`	`getHealthStatusMinNumberOfAvailablePeers()` Get the minimum number of available peer replication instances for this instance to be considered healthy.
`java.lang.String`	`getJsonCodecName()`
`java.lang.String`	`getListAutoScalingGroupsRoleName()` Name of the Role used to describe auto scaling groups from third AWS accounts.
`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`	`getRateLimiterBurstSize()` Rate limiter, token bucket algorithm property.
`int`	`getRateLimiterFullFetchAverageRate()` Rate limiter, token bucket algorithm property.
`java.util.Set<java.lang.String>`	`getRateLimiterPrivilegedClients()` A list of certified clients.
`int`	`getRateLimiterRegistryFetchAverageRate()` Rate limiter, token bucket algorithm property.
`int`	`getRegistrySyncRetries()` Get the number of times that a eureka node would try to get the registry information from the peers during startup.
`long`	`getRegistrySyncRetryWaitMs()` Get the wait/sleep time between each retry sync attempts, if the prev retry failed and there are more retries to attempt.
`java.util.Set<java.lang.String>`	`getRemoteRegionAppWhitelist(java.lang.String regionName)` Returns a list of applications that must be retrieved from the passed remote region.
`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`	`getRemoteRegionFetchThreadPoolSize()` Size of a thread pool used to execute remote region registry fetch requests.
`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 registry information 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`	`getRemoteRegionTrustStore()` Gets the fully qualified trust store file that will be used for remote region registry fetches.
`java.lang.String`	`getRemoteRegionTrustStorePassword()` Get the remote region trust store's password.
`java.lang.String[]`	`getRemoteRegionUrls()` Get the list of remote region urls.
`java.util.Map<java.lang.String,java.lang.String>`	`getRemoteRegionUrlsWithName()` Expects a property with name: [eureka-namespace].remoteRegionUrlsWithName and a value being a comma separated list of region name & remote url pairs, separated with a ";".
`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`	`getRoute53BindingRetryIntervalMs()` Gets the interval with which the server should check if the Route53 domain is bound and should try to bind in the case if it is already not bound.
`int`	`getRoute53BindRebindRetries()` Gets the number of times the server should try to bind to the candidate Route53 domain.
`long`	`getRoute53DomainTTL()`
`int`	`getWaitTimeInMsWhenSyncEmpty()` Gets the time to wait when the eureka server starts up unable to get instances from peer nodes.
`java.lang.String`	`getXmlCodecName()`
`boolean`	`isRateLimiterEnabled()` Indicates whether the rate limiter should be enabled or disabled.
`boolean`	`isRateLimiterThrottleStandardClients()` Indicate if rate limit standard clients.
`boolean`	`shouldBatchReplication()` Indicates whether the replication between cluster nodes should be batched for network efficiency.
`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`	`shouldEnableReplicatedRequestCompression()` If set to true, the replicated data send in the request will be always compressed.
`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`	`shouldLogIdentityHeaders()` Indicates whether the eureka server should log/metric clientAuthHeaders
`boolean`	`shouldPrimeAwsReplicaConnections()` Checks whether the connections to replicas should be primed.
`boolean`	`shouldSyncWhenTimestampDiffers()` Checks whether to synchronize instances when timestamp differs.
`boolean`	`shouldUseReadOnlyResponseCache()` The `ResponseCache` currently uses a two level caching strategy to responses.

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.
  - getEIPBindingRetryIntervalMsWhenUnbound
```
public int getEIPBindingRetryIntervalMsWhenUnbound()
```
    Description copied from interface: EurekaServerConfig
    
    Get 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, iff the EIP is not currently bound.
    The changes are effective at runtime.
    
    Specified by:
    
    getEIPBindingRetryIntervalMsWhenUnbound in interface EurekaServerConfig
    
    Returns:
    
    the time in milliseconds.
  - 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, iff the EIP is already bound. (so this refresh is just for steady state checks)
    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 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.
  - shouldEnableReplicatedRequestCompression
```
public boolean shouldEnableReplicatedRequestCompression()
```
    Description copied from interface: EurekaServerConfig
    
    If set to true, the replicated data send in the request will be always compressed. This does not define response path, which is driven by "Accept-Encoding" header.
    
    Specified by:
    
    shouldEnableReplicatedRequestCompression in interface EurekaServerConfig
  - 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.
  - getASGCacheExpiryTimeoutMs
```
public long getASGCacheExpiryTimeoutMs()
```
    Description copied from interface: EurekaServerConfig
    
    Get the expiration value for the cached ASG information
    
    Specified by:
    
    getASGCacheExpiryTimeoutMs 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.
  - shouldUseReadOnlyResponseCache
```
public boolean shouldUseReadOnlyResponseCache()
```
    Description copied from interface: EurekaServerConfig
    
    The ResponseCache currently uses a two level caching strategy to responses. A readWrite cache with an expiration policy, and a readonly cache that caches without expiry.
    
    Specified by:
    
    shouldUseReadOnlyResponseCache in interface EurekaServerConfig
    
    Returns:
    
    true if the read only cache is to be used
  - 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
  - getRegistrySyncRetryWaitMs
```
public long getRegistrySyncRetryWaitMs()
```
    Description copied from interface: EurekaServerConfig
    
    Get the wait/sleep time between each retry sync attempts, if the prev retry failed and there are more retries to attempt.
    
    Specified by:
    
    getRegistrySyncRetryWaitMs in interface EurekaServerConfig
    
    Returns:
    
    the wait time in ms between each sync 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.
  - getRemoteRegionUrlsWithName
```
public java.util.Map<java.lang.String,java.lang.String> getRemoteRegionUrlsWithName()
```
    Expects a property with name: [eureka-namespace].remoteRegionUrlsWithName and a value being a comma separated list of region name & remote url pairs, separated with a ";".
    So, if you wish to specify two regions with name region1 & region2, the property value will be:
```
     eureka.remoteRegionUrlsWithName=region1;http://region1host/eureka/v2,region2;http://region2host/eureka/v2
     
```
    The above property will result in the following map:
```
     region1->"http://region1host/eureka/v2"
     region2->"http://region2host/eureka/v2"
     
```
    Specified by:
    
    getRemoteRegionUrlsWithName in interface EurekaServerConfig
    
    Returns:
    
    A map of region name to remote region URL parsed from the property specified above. If there is no property available, then an empty map is returned.
  - 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.
  - getRemoteRegionAppWhitelist
```
@Nullable
public java.util.Set<java.lang.String> getRemoteRegionAppWhitelist(@Nullable
                                                                             java.lang.String regionName)
```
    Description copied from interface: EurekaServerConfig
    
    Returns a list of applications that must be retrieved from the passed remote region.
    This list can be null which means that no filtering should be applied on the applications for this region i.e. all applications must be returned.
    A global whitelist can also be configured which can be used when no setting is available for a region, such a whitelist can be obtained by passing null to this method.
    
    Specified by:
    
    getRemoteRegionAppWhitelist in interface EurekaServerConfig
    
    Parameters:
    
    regionName - Name of the region for which the application whitelist is to be retrieved. If null a global setting is returned.
    
    Returns:
    
    A set of application names which must be retrieved from the passed region. If null all applications must be retrieved.
  - getRemoteRegionRegistryFetchInterval
```
public int getRemoteRegionRegistryFetchInterval()
```
    Description copied from interface: EurekaServerConfig
    
    Get the time interval for which the registry information need to be fetched from the remote region.
    
    Specified by:
    
    getRemoteRegionRegistryFetchInterval in interface EurekaServerConfig
    
    Returns:
    
    time in seconds.
  - getRemoteRegionFetchThreadPoolSize
```
public int getRemoteRegionFetchThreadPoolSize()
```
    Description copied from interface: EurekaServerConfig
    
    Size of a thread pool used to execute remote region registry fetch requests. Delegating these requests to internal threads is necessary workaround to https://bugs.openjdk.java.net/browse/JDK-8049846 bug.
    
    Specified by:
    
    getRemoteRegionFetchThreadPoolSize in interface EurekaServerConfig
  - getRemoteRegionTrustStore
```
public java.lang.String getRemoteRegionTrustStore()
```
    Description copied from interface: EurekaServerConfig
    
    Gets the fully qualified trust store file that will be used for remote region registry fetches.
    
    Specified by:
    
    getRemoteRegionTrustStore in interface EurekaServerConfig
    
    Returns:
  - getRemoteRegionTrustStorePassword
```
public java.lang.String getRemoteRegionTrustStorePassword()
```
    Description copied from interface: EurekaServerConfig
    
    Get the remote region trust store's password.
    
    Specified by:
    
    getRemoteRegionTrustStorePassword in interface EurekaServerConfig
  - disableTransparentFallbackToOtherRegion
```
public boolean disableTransparentFallbackToOtherRegion()
```
    Description copied from interface: EurekaServerConfig
    
    Old behavior of fallback to applications in the remote region (if configured) if there are no instances of that application in the local region, will be disabled.
    
    Specified by:
    
    disableTransparentFallbackToOtherRegion in interface EurekaServerConfig
    
    Returns:
    
    true if the old behavior is to be disabled.
  - shouldBatchReplication
```
public boolean shouldBatchReplication()
```
    Description copied from interface: EurekaServerConfig
    
    Indicates whether the replication between cluster nodes should be batched for network efficiency.
    
    Specified by:
    
    shouldBatchReplication in interface EurekaServerConfig
    
    Returns:
    
    true if the replication needs to be batched.
  - shouldLogIdentityHeaders
```
public boolean shouldLogIdentityHeaders()
```
    Description copied from interface: EurekaServerConfig
    
    Indicates whether the eureka server should log/metric clientAuthHeaders
    
    Specified by:
    
    shouldLogIdentityHeaders in interface EurekaServerConfig
    
    Returns:
    
    true if the clientAuthHeaders should be logged and/or emitted as metrics
  - getJsonCodecName
```
public java.lang.String getJsonCodecName()
```
    Specified by:
    
    getJsonCodecName in interface EurekaServerConfig
    
    Returns:
    
    the class name of the full json codec to use for the server. If none set a default codec will be used
  - getXmlCodecName
```
public java.lang.String getXmlCodecName()
```
    Specified by:
    
    getXmlCodecName in interface EurekaServerConfig
    
    Returns:
    
    the class name of the full xml codec to use for the server. If none set a default codec will be used
  - isRateLimiterEnabled
```
public boolean isRateLimiterEnabled()
```
    Description copied from interface: EurekaServerConfig
    
    Indicates whether the rate limiter should be enabled or disabled.
    
    Specified by:
    
    isRateLimiterEnabled in interface EurekaServerConfig
  - isRateLimiterThrottleStandardClients
```
public boolean isRateLimiterThrottleStandardClients()
```
    Description copied from interface: EurekaServerConfig
    
    Indicate if rate limit standard clients. If set to false, only non standard clients will be rate limited.
    
    Specified by:
    
    isRateLimiterThrottleStandardClients in interface EurekaServerConfig
  - getRateLimiterPrivilegedClients
```
public java.util.Set<java.lang.String> getRateLimiterPrivilegedClients()
```
    Description copied from interface: EurekaServerConfig
    
    A list of certified clients. This is in addition to standard eureka Java clients.
    
    Specified by:
    
    getRateLimiterPrivilegedClients in interface EurekaServerConfig
  - getRateLimiterBurstSize
```
public int getRateLimiterBurstSize()
```
    Description copied from interface: EurekaServerConfig
    
    Rate limiter, token bucket algorithm property. See also EurekaServerConfig.getRateLimiterRegistryFetchAverageRate() and EurekaServerConfig.getRateLimiterFullFetchAverageRate().
    
    Specified by:
    
    getRateLimiterBurstSize in interface EurekaServerConfig
  - getRateLimiterRegistryFetchAverageRate
```
public int getRateLimiterRegistryFetchAverageRate()
```
    Description copied from interface: EurekaServerConfig
    
    Rate limiter, token bucket algorithm property. Specifies the average enforced request rate. See also EurekaServerConfig.getRateLimiterBurstSize().
    
    Specified by:
    
    getRateLimiterRegistryFetchAverageRate in interface EurekaServerConfig
  - getRateLimiterFullFetchAverageRate
```
public int getRateLimiterFullFetchAverageRate()
```
    Description copied from interface: EurekaServerConfig
    
    Rate limiter, token bucket algorithm property. Specifies the average enforced request rate. See also EurekaServerConfig.getRateLimiterBurstSize().
    
    Specified by:
    
    getRateLimiterFullFetchAverageRate in interface EurekaServerConfig
  - getListAutoScalingGroupsRoleName
```
public java.lang.String getListAutoScalingGroupsRoleName()
```
    Description copied from interface: EurekaServerConfig
    
    Name of the Role used to describe auto scaling groups from third AWS accounts.
    
    Specified by:
    
    getListAutoScalingGroupsRoleName in interface EurekaServerConfig
  - getRoute53BindRebindRetries
```
public int getRoute53BindRebindRetries()
```
    Description copied from interface: EurekaServerConfig
    
    Gets the number of times the server should try to bind to the candidate Route53 domain.
    The changes are effective at runtime.
    
    Specified by:
    
    getRoute53BindRebindRetries in interface EurekaServerConfig
    
    Returns:
    
    the number of times the server should try to bind to the candidate Route53 domain.
  - getRoute53BindingRetryIntervalMs
```
public int getRoute53BindingRetryIntervalMs()
```
    Description copied from interface: EurekaServerConfig
    
    Gets the interval with which the server should check if the Route53 domain is bound and should try to bind in the case if it is already not bound.
    The changes are effective at runtime.
    
    Specified by:
    
    getRoute53BindingRetryIntervalMs in interface EurekaServerConfig
    
    Returns:
    
    the time in milliseconds.
  - getRoute53DomainTTL
```
public long getRoute53DomainTTL()
```
    Specified by:
    
    getRoute53DomainTTL in interface EurekaServerConfig
    
    Returns:
    
    the ttl used to set up the route53 domain if new
  - getBindingStrategy
```
public AwsBindingStrategy getBindingStrategy()
```
    Description copied from interface: EurekaServerConfig
    
    Get the configured binding strategy EIP or Route53.
    
    Specified by:
    
    getBindingStrategy in interface EurekaServerConfig
    
    Returns:
    
    the configured binding strategy
  - getExperimental
```
public java.lang.String getExperimental(java.lang.String name)
```
    Description copied from interface: EurekaServerConfig
    
    To avoid configuration API pollution when trying new/experimental or features or for the migration process, the corresponding configuration can be put into experimental configuration section.
    
    Specified by:
    
    getExperimental in interface EurekaServerConfig
    
    Returns:
    
    a property of experimental feature
  - getHealthStatusMinNumberOfAvailablePeers
```
public int getHealthStatusMinNumberOfAvailablePeers()
```
    Description copied from interface: EurekaServerConfig
    
    Get the minimum number of available peer replication instances for this instance to be considered healthy. The design of eureka allows for an instance to continue operating with zero peers, but that would not be ideal.
    The default value of -1 is interpreted as a marker to not compare the number of replicas. This would be done to either disable this check or to run eureka in a single node configuration.
    
    Specified by:
    
    getHealthStatusMinNumberOfAvailablePeers in interface EurekaServerConfig
    
    Returns:
    
    minimum number of available peer replication instances for this instance to be considered healthy.

Class DefaultEurekaServerConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultEurekaServerConfig

DefaultEurekaServerConfig

Method Detail

getAWSAccessId

getAWSSecretKey

getEIPBindRebindRetries

getEIPBindingRetryIntervalMsWhenUnbound

getEIPBindingRetryIntervalMs

shouldEnableSelfPreservation

getPeerEurekaNodesUpdateIntervalMs

getRenewalThresholdUpdateIntervalMs

getRenewalPercentThreshold

shouldEnableReplicatedRequestCompression

getNumberOfReplicationRetries

getPeerEurekaStatusRefreshTimeIntervalMs

getWaitTimeInMsWhenSyncEmpty

getPeerNodeConnectTimeoutMs

getPeerNodeReadTimeoutMs

getPeerNodeTotalConnections

getPeerNodeTotalConnectionsPerHost

getPeerNodeConnectionIdleTimeoutSeconds

getRetentionTimeInMSInDeltaQueue

getDeltaRetentionTimerIntervalInMs

getEvictionIntervalTimerInMs

getASGQueryTimeoutMs

getASGUpdateIntervalMs

getASGCacheExpiryTimeoutMs

getResponseCacheAutoExpirationInSeconds

getResponseCacheUpdateIntervalMs

shouldUseReadOnlyResponseCache

shouldDisableDelta

getMaxIdleThreadInMinutesAgeForStatusReplication

getMinThreadsForStatusReplication

getMaxThreadsForStatusReplication

getMaxElementsInStatusReplicationPool

shouldSyncWhenTimestampDiffers

getRegistrySyncRetries

getRegistrySyncRetryWaitMs

getMaxElementsInPeerReplicationPool

getMaxIdleThreadAgeInMinutesForPeerReplication

getMinThreadsForPeerReplication

getMaxThreadsForPeerReplication

getMaxTimeForReplication

shouldPrimeAwsReplicaConnections

shouldDisableDeltaForRemoteRegions

getRemoteRegionConnectTimeoutMs

getRemoteRegionReadTimeoutMs

getRemoteRegionTotalConnections

getRemoteRegionTotalConnectionsPerHost

getRemoteRegionConnectionIdleTimeoutSeconds

shouldGZipContentFromRemoteRegion

getRemoteRegionUrlsWithName

getRemoteRegionUrls

getRemoteRegionAppWhitelist

getRemoteRegionRegistryFetchInterval

getRemoteRegionFetchThreadPoolSize

getRemoteRegionTrustStore

getRemoteRegionTrustStorePassword

disableTransparentFallbackToOtherRegion

shouldBatchReplication

shouldLogIdentityHeaders

getJsonCodecName

getXmlCodecName

isRateLimiterEnabled

isRateLimiterThrottleStandardClients

getRateLimiterPrivilegedClients

getRateLimiterBurstSize

getRateLimiterRegistryFetchAverageRate

getRateLimiterFullFetchAverageRate

getListAutoScalingGroupsRoleName

getRoute53BindRebindRetries

getRoute53BindingRetryIntervalMs

getRoute53DomainTTL

getBindingStrategy

getExperimental