Config (Apache Sling 9 API)

java.lang.Object
- org.apache.sling.discovery.oak.Config

All Implemented Interfaces:

BaseConfig, DiscoveryLiteConfig
```
@Service(value={Config.class,BaseConfig.class,DiscoveryLiteConfig.class})
public class Config
extends Object
implements BaseConfig, DiscoveryLiteConfig
```
Configuration object used as a central config point for the discovery service implementation
The properties are described below under.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLUSTER_SYNC_SERVICE_INTERVAL_KEY`
`static String`	`CLUSTER_SYNC_SERVICE_TIMEOUT_KEY`
`protected long`	`clusterSyncServiceInterval`
`protected long`	`clusterSyncServiceTimeout`
`protected long`	`connectorPingInterval`
`protected long`	`connectorPingTimeout`
`static long`	`DEFAULT_CLUSTER_SYNC_SERVICE_INTERVAL`
`static long`	`DEFAULT_CLUSTER_SYNC_SERVICE_TIMEOUT`
`static long`	`DEFAULT_DISCOVERY_LITE_CHECK_INTERVAL` Configure the interval (in seconds) according to which the heartbeats are exchanged in the topology.
`static int`	`DEFAULT_MIN_EVENT_DELAY` Configure the time (in seconds) which must be passed at minimum between sending TOPOLOGY_CHANGING/_CHANGED (avoid flooding).
`static int`	`DEFAULT_SO_TIMEOUT` Configure the socket read timeout (SO_TIMEOUT) for topology connectors.
`static int`	`DEFAULT_SOCKET_CONNECT_TIMEOUT` Configure the socket connect timeout for topology connectors.
`static long`	`DEFAULT_TOPOLOGY_CONNECTOR_INTERVAL` Configure the interval (in seconds) according to which the heartbeats are exchanged in the topology.
`static long`	`DEFAULT_TOPOLOGY_CONNECTOR_TIMEOUT` Configure the timeout (in seconds) after which an instance is considered dead/crashed.
`static String`	`DISCOVERY_LITE_CHECK_INTERVAL_KEY`
`static String`	`DISCOVERY_RESOURCE_PATH_KEY`
`protected long`	`discoveryLiteCheckInterval`
`protected String`	`discoveryResourcePath`
`static String`	`MIN_EVENT_DELAY_KEY`
`protected int`	`minEventDelay`
`static String`	`SO_TIMEOUT_KEY`
`static String`	`SOCKET_CONNECT_TIMEOUT_KEY`
`static String`	`TOPOLOGY_CONNECTOR_INTERVAL_KEY`
`static String`	`TOPOLOGY_CONNECTOR_TIMEOUT_KEY`
`static String`	`TOPOLOGY_CONNECTOR_URLS_KEY` URLs where to join a topology, eg http://localhost:4502/libs/sling/topology/connector
`static String`	`TOPOLOGY_CONNECTOR_WHITELIST_KEY`
`protected String[]`	`topologyConnectorWhitelist`

Constructor Summary

Constructors
Constructor and Description

Config()

Constructors
Constructor and Description
`Config()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`activate(Map<String,Object> properties)`
`protected void`	`configure(Map<String,Object> properties)`
`int`	`getBackoffStableFactor()` Returns the (maximum) backoff factor to be used for stable connectors
`int`	`getBackoffStandbyFactor()` Returns the backoff factor to be used for standby (loop) connectors
`long`	`getBackoffStandbyInterval()` Returns the backoff interval for standby (loop) connectors in seconds
`String`	`getClusterInstancesPath()` Returns the resource path where cluster instance informations are stored.
`long`	`getClusterSyncServiceIntervalMillis()` Returns the interval (in milliseconds) to be used when waiting for the sync tokens or id mapping
`long`	`getClusterSyncServiceTimeoutMillis()` Returns the timeout (in milliseconds) to be used when waiting for the sync tokens or id mapping
`long`	`getConnectorPingInterval()` Returns the interval (in seconds) in which connectors are pinged
`long`	`getConnectorPingTimeout()` Returns the timeout (in seconds) after which a connector ping is considered invalid/timed out
`long`	`getDiscoveryLiteCheckInterval()`
`protected String`	`getDiscoveryResourcePath()`
`String`	`getIdMapPath()` Returns the configured path to store the idMap to
`long`	`getKeyInterval()`
`int`	`getMinEventDelay()` Returns the minimum time (in seconds) between sending TOPOLOGY_CHANGING/_CHANGED events - to avoid flooding
`String`	`getSharedKey()`
`int`	`getSocketConnectTimeout()` Returns the socket connect() timeout used by the topology connector, 0 disables the timeout
`int`	`getSoTimeout()` Returns the socket read timeout (SO_TIMEOUT) used by the topology connector, 0 disables the timeout
`boolean`	`getSyncTokenEnabled()`
`String`	`getSyncTokenPath()` Returns the configured path to store the syncTokens to
`URL[]`	`getTopologyConnectorURLs()` Returns the URLs to which to open a topology connector - or null/empty if no topology connector is configured (default is null)
`String[]`	`getTopologyConnectorWhitelist()` Returns a comma separated list of hostnames and/or ip addresses which are allowed as remote hosts to open connections to the topology connector servlet
`boolean`	`isAutoStopLocalLoopEnabled()`
`boolean`	`isEncryptionEnabled()`
`boolean`	`isGzipConnectorRequestsEnabled()`
`boolean`	`isHmacEnabled()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_TOPOLOGY_CONNECTOR_TIMEOUT
```
public static final long DEFAULT_TOPOLOGY_CONNECTOR_TIMEOUT
```
    Configure the timeout (in seconds) after which an instance is considered dead/crashed.
    
    See Also:
    
    Constant Field Values
  - TOPOLOGY_CONNECTOR_TIMEOUT_KEY
```
@Property(longValue=120L)
public static final String TOPOLOGY_CONNECTOR_TIMEOUT_KEY
```
    See Also:
    
    Constant Field Values
  - connectorPingTimeout
```
protected long connectorPingTimeout
```
  - DEFAULT_TOPOLOGY_CONNECTOR_INTERVAL
```
public static final long DEFAULT_TOPOLOGY_CONNECTOR_INTERVAL
```
    Configure the interval (in seconds) according to which the heartbeats are exchanged in the topology.
    
    See Also:
    
    Constant Field Values
  - TOPOLOGY_CONNECTOR_INTERVAL_KEY
```
@Property(longValue=30L)
public static final String TOPOLOGY_CONNECTOR_INTERVAL_KEY
```
    See Also:
    
    Constant Field Values
  - connectorPingInterval
```
protected long connectorPingInterval
```
  - DEFAULT_DISCOVERY_LITE_CHECK_INTERVAL
```
public static final long DEFAULT_DISCOVERY_LITE_CHECK_INTERVAL
```
    Configure the interval (in seconds) according to which the heartbeats are exchanged in the topology.
    
    See Also:
    
    Constant Field Values
  - DISCOVERY_LITE_CHECK_INTERVAL_KEY
```
@Property(longValue=2L)
public static final String DISCOVERY_LITE_CHECK_INTERVAL_KEY
```
    See Also:
    
    Constant Field Values
  - discoveryLiteCheckInterval
```
protected long discoveryLiteCheckInterval
```
  - DEFAULT_CLUSTER_SYNC_SERVICE_TIMEOUT
```
public static final long DEFAULT_CLUSTER_SYNC_SERVICE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - CLUSTER_SYNC_SERVICE_TIMEOUT_KEY
```
@Property(longValue=120L)
public static final String CLUSTER_SYNC_SERVICE_TIMEOUT_KEY
```
    See Also:
    
    Constant Field Values
  - clusterSyncServiceTimeout
```
protected long clusterSyncServiceTimeout
```
  - DEFAULT_CLUSTER_SYNC_SERVICE_INTERVAL
```
public static final long DEFAULT_CLUSTER_SYNC_SERVICE_INTERVAL
```
    See Also:
    
    Constant Field Values
  - CLUSTER_SYNC_SERVICE_INTERVAL_KEY
```
@Property(longValue=2L)
public static final String CLUSTER_SYNC_SERVICE_INTERVAL_KEY
```
    See Also:
    
    Constant Field Values
  - clusterSyncServiceInterval
```
protected long clusterSyncServiceInterval
```
  - DEFAULT_MIN_EVENT_DELAY
```
public static final int DEFAULT_MIN_EVENT_DELAY
```
    Configure the time (in seconds) which must be passed at minimum between sending TOPOLOGY_CHANGING/_CHANGED (avoid flooding).
    
    See Also:
    
    Constant Field Values
  - MIN_EVENT_DELAY_KEY
```
@Property(intValue=3)
public static final String MIN_EVENT_DELAY_KEY
```
    See Also:
    
    Constant Field Values
  - minEventDelay
```
protected int minEventDelay
```
  - DEFAULT_SOCKET_CONNECT_TIMEOUT
```
public static final int DEFAULT_SOCKET_CONNECT_TIMEOUT
```
    Configure the socket connect timeout for topology connectors.
    
    See Also:
    
    Constant Field Values
  - SOCKET_CONNECT_TIMEOUT_KEY
```
@Property(intValue=10)
public static final String SOCKET_CONNECT_TIMEOUT_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SO_TIMEOUT
```
public static final int DEFAULT_SO_TIMEOUT
```
    Configure the socket read timeout (SO_TIMEOUT) for topology connectors.
    
    See Also:
    
    Constant Field Values
  - SO_TIMEOUT_KEY
```
@Property(intValue=10)
public static final String SO_TIMEOUT_KEY
```
    See Also:
    
    Constant Field Values
  - TOPOLOGY_CONNECTOR_URLS_KEY
```
@Property(cardinality=1024)
public static final String TOPOLOGY_CONNECTOR_URLS_KEY
```
    URLs where to join a topology, eg http://localhost:4502/libs/sling/topology/connector
    
    See Also:
    
    Constant Field Values
  - TOPOLOGY_CONNECTOR_WHITELIST_KEY
```
@Property(value={"localhost","127.0.0.1"})
public static final String TOPOLOGY_CONNECTOR_WHITELIST_KEY
```
    See Also:
    
    Constant Field Values
  - topologyConnectorWhitelist
```
protected String[] topologyConnectorWhitelist
```
  - DISCOVERY_RESOURCE_PATH_KEY
```
@Property(value="/var/discovery/oak/",
          propertyPrivate=true)
public static final String DISCOVERY_RESOURCE_PATH_KEY
```
    See Also:
    
    Constant Field Values
  - discoveryResourcePath
```
protected String discoveryResourcePath
```
- Constructor Detail
  - Config
```
public Config()
```
- Method Detail
  - activate
```
@Activate
protected void activate(Map<String,Object> properties)
```
  - configure
```
protected void configure(Map<String,Object> properties)
```
  - getSocketConnectTimeout
```
public int getSocketConnectTimeout()
```
    Returns the socket connect() timeout used by the topology connector, 0 disables the timeout
    
    Specified by:
    
    getSocketConnectTimeout in interface BaseConfig
    
    Returns:
    
    the socket connect() timeout used by the topology connector, 0 disables the timeout
  - getSoTimeout
```
public int getSoTimeout()
```
    Returns the socket read timeout (SO_TIMEOUT) used by the topology connector, 0 disables the timeout
    
    Specified by:
    
    getSoTimeout in interface BaseConfig
    
    Returns:
    
    the socket read timeout (SO_TIMEOUT) used by the topology connector, 0 disables the timeout
  - getMinEventDelay
```
public int getMinEventDelay()
```
    Returns the minimum time (in seconds) between sending TOPOLOGY_CHANGING/_CHANGED events - to avoid flooding
    
    Specified by:
    
    getMinEventDelay in interface BaseConfig
    
    Returns:
    
    the minimum time (in seconds) between sending TOPOLOGY_CHANGING/_CHANGED events - to avoid flooding
  - getTopologyConnectorURLs
```
public URL[] getTopologyConnectorURLs()
```
    Returns the URLs to which to open a topology connector - or null/empty if no topology connector is configured (default is null)
    
    Specified by:
    
    getTopologyConnectorURLs in interface BaseConfig
    
    Returns:
    
    the URLs to which to open a topology connector - or null/empty if no topology connector is configured
  - getTopologyConnectorWhitelist
```
public String[] getTopologyConnectorWhitelist()
```
    Returns a comma separated list of hostnames and/or ip addresses which are allowed as remote hosts to open connections to the topology connector servlet
    
    Specified by:
    
    getTopologyConnectorWhitelist in interface BaseConfig
    
    Returns:
    
    a comma separated list of hostnames and/or ip addresses which are allowed as remote hosts to open connections to the topology connector servlet
  - getDiscoveryResourcePath
```
protected String getDiscoveryResourcePath()
```
  - getClusterInstancesPath
```
public String getClusterInstancesPath()
```
    Returns the resource path where cluster instance informations are stored.
    
    Specified by:
    
    getClusterInstancesPath in interface BaseConfig
    
    Returns:
    
    the resource path where cluster instance informations are stored
  - getSyncTokenPath
```
public String getSyncTokenPath()
```
    Description copied from interface: DiscoveryLiteConfig
    
    Returns the configured path to store the syncTokens to
    
    Specified by:
    
    getSyncTokenPath in interface DiscoveryLiteConfig
    
    Returns:
    
    the configured path to store the syncTokens to
  - getIdMapPath
```
public String getIdMapPath()
```
    Description copied from interface: DiscoveryLiteConfig
    
    Returns the configured path to store the idMap to
    
    Specified by:
    
    getIdMapPath in interface DiscoveryLiteConfig
    
    Returns:
    
    the configured path to store the idMap to
  - isHmacEnabled
```
public boolean isHmacEnabled()
```
    Specified by:
    
    isHmacEnabled in interface BaseConfig
    
    Returns:
    
    true if hmac is enabled.
  - getSharedKey
```
public String getSharedKey()
```
    Specified by:
    
    getSharedKey in interface BaseConfig
    
    Returns:
    
    the shared key
  - getKeyInterval
```
public long getKeyInterval()
```
    Specified by:
    
    getKeyInterval in interface BaseConfig
    
    Returns:
    
    the interval of the shared key for hmac.
  - isEncryptionEnabled
```
public boolean isEncryptionEnabled()
```
    Specified by:
    
    isEncryptionEnabled in interface BaseConfig
    
    Returns:
    
    true if encryption is enabled.
  - isGzipConnectorRequestsEnabled
```
public boolean isGzipConnectorRequestsEnabled()
```
    Specified by:
    
    isGzipConnectorRequestsEnabled in interface BaseConfig
    
    Returns:
    
    true if requests on the topology connector should be gzipped (which only works if the server accepts that.. ie discovery.impl 1.0.4+)
  - isAutoStopLocalLoopEnabled
```
public boolean isAutoStopLocalLoopEnabled()
```
    Specified by:
    
    isAutoStopLocalLoopEnabled in interface BaseConfig
    
    Returns:
    
    true if the auto-stopping of local-loop topology connectors is enabled.
  - getBackoffStandbyFactor
```
public int getBackoffStandbyFactor()
```
    Returns the backoff factor to be used for standby (loop) connectors
    
    Specified by:
    
    getBackoffStandbyFactor in interface BaseConfig
    
    Returns:
    
    the backoff factor to be used for standby (loop) connectors
  - getBackoffStableFactor
```
public int getBackoffStableFactor()
```
    Returns the (maximum) backoff factor to be used for stable connectors
    
    Specified by:
    
    getBackoffStableFactor in interface BaseConfig
    
    Returns:
    
    the (maximum) backoff factor to be used for stable connectors
  - getBackoffStandbyInterval
```
public long getBackoffStandbyInterval()
```
    Returns the backoff interval for standby (loop) connectors in seconds
    
    Specified by:
    
    getBackoffStandbyInterval in interface BaseConfig
    
    Returns:
    
    the backoff interval for standby (loop) connectors in seconds
  - getConnectorPingInterval
```
public long getConnectorPingInterval()
```
    Description copied from interface: BaseConfig
    
    Returns the interval (in seconds) in which connectors are pinged
    
    Specified by:
    
    getConnectorPingInterval in interface BaseConfig
    
    Returns:
    
    the interval (in seconds) in which connectors are pinged
  - getConnectorPingTimeout
```
public long getConnectorPingTimeout()
```
    Description copied from interface: BaseConfig
    
    Returns the timeout (in seconds) after which a connector ping is considered invalid/timed out
    
    Specified by:
    
    getConnectorPingTimeout in interface BaseConfig
    
    Returns:
    
    the timeout (in seconds) after which a connector ping is considered invalid/timed out
  - getDiscoveryLiteCheckInterval
```
public long getDiscoveryLiteCheckInterval()
```
  - getClusterSyncServiceTimeoutMillis
```
public long getClusterSyncServiceTimeoutMillis()
```
    Description copied from interface: DiscoveryLiteConfig
    
    Returns the timeout (in milliseconds) to be used when waiting for the sync tokens or id mapping
    
    Specified by:
    
    getClusterSyncServiceTimeoutMillis in interface DiscoveryLiteConfig
    
    Returns:
    
    the timeout (in milliseconds) to be used when waiting for the sync tokens or id mapping
  - getClusterSyncServiceIntervalMillis
```
public long getClusterSyncServiceIntervalMillis()
```
    Description copied from interface: DiscoveryLiteConfig
    
    Returns the interval (in milliseconds) to be used when waiting for the sync tokens or id mapping
    
    Specified by:
    
    getClusterSyncServiceIntervalMillis in interface DiscoveryLiteConfig
    
    Returns:
    
    the interval (in milliseconds) to be used when waiting for the sync tokens or id mapping
  - getSyncTokenEnabled
```
public boolean getSyncTokenEnabled()
```

Class Config

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TOPOLOGY_CONNECTOR_TIMEOUT

TOPOLOGY_CONNECTOR_TIMEOUT_KEY

connectorPingTimeout

DEFAULT_TOPOLOGY_CONNECTOR_INTERVAL

TOPOLOGY_CONNECTOR_INTERVAL_KEY

connectorPingInterval

DEFAULT_DISCOVERY_LITE_CHECK_INTERVAL

DISCOVERY_LITE_CHECK_INTERVAL_KEY

discoveryLiteCheckInterval

DEFAULT_CLUSTER_SYNC_SERVICE_TIMEOUT

CLUSTER_SYNC_SERVICE_TIMEOUT_KEY

clusterSyncServiceTimeout

DEFAULT_CLUSTER_SYNC_SERVICE_INTERVAL

CLUSTER_SYNC_SERVICE_INTERVAL_KEY

clusterSyncServiceInterval

DEFAULT_MIN_EVENT_DELAY

MIN_EVENT_DELAY_KEY

minEventDelay

DEFAULT_SOCKET_CONNECT_TIMEOUT

SOCKET_CONNECT_TIMEOUT_KEY

DEFAULT_SO_TIMEOUT

SO_TIMEOUT_KEY

TOPOLOGY_CONNECTOR_URLS_KEY

TOPOLOGY_CONNECTOR_WHITELIST_KEY

topologyConnectorWhitelist

DISCOVERY_RESOURCE_PATH_KEY

discoveryResourcePath

Constructor Detail

Config

Method Detail

activate

configure

getSocketConnectTimeout

getSoTimeout

getMinEventDelay

getTopologyConnectorURLs

getTopologyConnectorWhitelist

getDiscoveryResourcePath

getClusterInstancesPath

getSyncTokenPath

getIdMapPath

isHmacEnabled

getSharedKey

getKeyInterval

isEncryptionEnabled

isGzipConnectorRequestsEnabled

isAutoStopLocalLoopEnabled

getBackoffStandbyFactor

getBackoffStableFactor

getBackoffStandbyInterval

getConnectorPingInterval

getConnectorPingTimeout

getDiscoveryLiteCheckInterval

getClusterSyncServiceTimeoutMillis

getClusterSyncServiceIntervalMillis

getSyncTokenEnabled