DistributedSystemConfig (GemFire Java API Documentation)

All Superinterfaces:

Cloneable

All Known Subinterfaces:

AgentConfig

Deprecated.
as of 7.0 use the com.gemstone.gemfire.management package instead
```
public interface DistributedSystemConfig
extends Cloneable
```
Configuration for defining a GemFire distributed system to administrate. This configuration includes information about the discovery mechanism used to find members of the distributed system and information about managed entities such as distribution locators and GemFire cache vms that can be started.
Detailed descriptions of many of these configuration attributes can be found in the DistributedSystem class. Note that the default values of these configuration attributes can be specified using Java system properties.
A DistributedSystemConfig can be modified using a number of mutator methods until the AdminDistributedSystem that it configures connects to the distributed system. After that, attempts to modify most attributes in the DistributedSystemConfig will result in an IllegalStateException being thrown. If you wish to use the same DistributedSystemConfig to configure multiple AdminDistributedSystems, a copy of the DistributedSystemConfig object can be made by invoking the clone() method.

Since:

3.5

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`DistributedSystemConfig.ConfigListener` Deprecated. A listener whose callback methods are invoked when this config changes.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BIND_ADDRESS_NAME` Deprecated. The name of the "bindAddress" property
`static int`	`DEFAULT_ACK_SEVERE_ALERT_THRESHOLD` Deprecated. The default ackSevereAlertThreshold.
`static int`	`DEFAULT_ACK_WAIT_THRESHOLD` Deprecated. The default AckWaitThreshold.
`static String`	`DEFAULT_BIND_ADDRESS` Deprecated. The default value of the "bindAddress" property
`static boolean`	`DEFAULT_DISABLE_AUTO_RECONNECT` Deprecated. The default disable-auto-reconnect setting (`false`)
`static boolean`	`DEFAULT_DISABLE_TCP` Deprecated. The default disable-tcp value (`false`)
`static boolean`	`DEFAULT_ENABLE_NETWORK_PARTITION_DETECTION` Deprecated. The default enable-network-partition-detection setting (`false`)
`static String`	`DEFAULT_ENTITY_CONFIG_XML_FILE` Deprecated. The default value of the "entity-config-xml-file" property ("distributed-system.xml").
`static String`	`DEFAULT_LOCATORS` Deprecated. The default value of the "locators" property ("")
`static int`	`DEFAULT_LOG_DISK_SPACE_LIMIT` Deprecated. The default log disk space limit in megabytes (0)
`static String`	`DEFAULT_LOG_FILE` Deprecated. The default log-file value ("" which directs logging to standard output)
`static int`	`DEFAULT_LOG_FILE_SIZE_LIMIT` Deprecated. The default log file size limit in megabytes (0)
`static String`	`DEFAULT_LOG_LEVEL` Deprecated. The default log level ("config")
`static String`	`DEFAULT_MCAST_ADDRESS` Deprecated. The default value of the "mcastAddress" property (239.192.81.1).
`static int`	`DEFAULT_MCAST_PORT` Deprecated. The default value of the "mcastPort" property (10334)
`static int`	`DEFAULT_MEMBER_TIMEOUT` Deprecated. The default failure-detection timeout period for member heart-beat responses
`static int[]`	`DEFAULT_MEMBERSHIP_PORT_RANGE` Deprecated. The default membership-port-range.
`static String`	`DEFAULT_NAME` Deprecated. The default value of the "name" property ("").
`static int`	`DEFAULT_REFRESH_INTERVAL` Deprecated. The default "refreshInterval" in seconds which will apply to REFRESH_INTERVAL_NAME property.
`static String`	`DEFAULT_REMOTE_COMMAND` Deprecated. The default value of the remote-command property
`static String`	`DEFAULT_SSL_CIPHERS` Deprecated. The default ssl-ciphers value.
`static boolean`	`DEFAULT_SSL_ENABLED` Deprecated. The default ssl-enabled state (`false`)
`static String`	`DEFAULT_SSL_PROTOCOLS` Deprecated. The default ssl-protocols value (`any`)
`static boolean`	`DEFAULT_SSL_REQUIRE_AUTHENTICATION` Deprecated. The default ssl-require-authentication value (`true`)
`static String`	`DEFAULT_SYSTEM_ID` Deprecated. The default value of the "system-id" property ("")
`static int`	`DEFAULT_TCP_PORT` Deprecated. The default value of the "tcpPort" property.
`static String`	`ENTITY_CONFIG_XML_FILE_NAME` Deprecated. The name of an XML file that specifies the configuration for the managed entities administered by the `DistributedSystem`.
`static String`	`LOCATORS_NAME` Deprecated. The name of the "locators" property (comma-delimited host[port] list)
`static String`	`LOG_DISK_SPACE_LIMIT_NAME` Deprecated. The name of the "LogDiskSpaceLimit" property
`static String`	`LOG_FILE_NAME` Deprecated. The name of the "logFile" property
`static String`	`LOG_FILE_SIZE_LIMIT_NAME` Deprecated. The name of the "LogFileSizeLimit" property
`static String`	`LOG_LEVEL_NAME` Deprecated. The name of the "logLevel" property
`static int`	`MAX_ACK_SEVERE_ALERT_THRESHOLD` Deprecated. The maximum ackSevereAlertThreshold.
`static int`	`MAX_ACK_WAIT_THRESHOLD` Deprecated. The maximum AckWaitThreshold.
`static int`	`MAX_LOG_DISK_SPACE_LIMIT` Deprecated. The minimum log disk space limit in megabytes (1000000)
`static int`	`MAX_LOG_FILE_SIZE_LIMIT` Deprecated. The minimum log file size limit in megabytes (1000000)
`static int`	`MAX_MCAST_PORT` Deprecated. The maximum mcastPort (65535)
`static String`	`MCAST_ADDRESS_NAME` Deprecated. The name of the "mcastAddress" property
`static String`	`MCAST_PORT_NAME` Deprecated. The name of the "mcastPort" property
`static String`	`MEMBERSHIP_PORT_RANGE_NAME` Deprecated. The name of the "membership-port-range" property
`static int`	`MIN_ACK_SEVERE_ALERT_THRESHOLD` Deprecated. The minimum ackSevereAlertThreshold.
`static int`	`MIN_ACK_WAIT_THRESHOLD` Deprecated. The minimum AckWaitThreshold.
`static int`	`MIN_LOG_DISK_SPACE_LIMIT` Deprecated. The minimum log disk space limit in megabytes (0)
`static int`	`MIN_LOG_FILE_SIZE_LIMIT` Deprecated. The minimum log file size limit in megabytes (0)
`static int`	`MIN_MCAST_PORT` Deprecated. The minimum mcastPort (0)
`static String`	`NAME_NAME` Deprecated. The name of the "name" property.
`static String`	`REFRESH_INTERVAL_NAME` Deprecated. The name of the "refreshInterval" property which will apply to SystemMember, SystemMemberCache and StatisticResource refresh.
`static String`	`REMOTE_COMMAND_NAME` Deprecated. The name of the remote-command property
`static String`	`SSL_CIPHERS_NAME` Deprecated. The name of the "SSLCiphers" property
`static String`	`SSL_ENABLED_NAME` Deprecated. The name of the "SSLEnabled" property
`static String`	`SSL_PROTOCOLS_NAME` Deprecated. The name of the "SSLProtocols" property
`static String`	`SSL_REQUIRE_AUTHENTICATION_NAME` Deprecated. The name of the "SSLRequireAuthentication" property
`static String`	`SYSTEM_ID_NAME` Deprecated. The name of the "system-id" property
`static String`	`TCP_PORT_NAME` Deprecated. settings for tcp-port

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addListener(DistributedSystemConfig.ConfigListener listener)` Deprecated. Registers listener for notification of changes in this config.
`void`	`addSSLProperty(String key, String value)` Deprecated. Adds an SSL property
`Object`	`clone()` Deprecated. Returns a copy of this `DistributedSystemConfig` object whose configuration can be modified.
`CacheServerConfig`	`createCacheServerConfig()` Deprecated. as of 5.7 use `createCacheVmConfig()` instead.
`CacheVmConfig`	`createCacheVmConfig()` Deprecated. Creates the configuration for a `CacheVm`.
`DistributionLocatorConfig`	`createDistributionLocatorConfig()` Deprecated. Creates a new `DistributionLocatorConfig` for a distribution locator that is managed in this distributed system.
`int`	`getAckSevereAlertThreshold()` Deprecated. Returns the ack-severe-alert-threshold for the system
`int`	`getAckWaitThreshold()` Deprecated. Returns the ack-wait-threshold for the system
`String`	`getBindAddress()` Deprecated. Returns the IP address to which the distributed system's server sockets are bound.
`CacheServerConfig[]`	`getCacheServerConfigs()` Deprecated. as of 5.7 use `getCacheVmConfigs()` instead.
`CacheVmConfig[]`	`getCacheVmConfigs()` Deprecated. Returns an array of configurations for statically known `CacheVm`s.
`boolean`	`getDisableAutoReconnect()` Deprecated. Returns true if auto reconnect is disabled
`boolean`	`getDisableTcp()` Deprecated. Returns the disable-tcp property for the system.
`DistributionLocatorConfig[]`	`getDistributionLocatorConfigs()` Deprecated. Returns configuration information about `DistributionLocator`s that are managed by an `AdminDistributedSystem`.
`boolean`	`getEnableNetworkPartitionDetection()` Deprecated. Returns true if network partition detection is enabled.
`String`	`getEntityConfigXMLFile()` Deprecated. Returns the name of the XML file that specifies the configuration of the managed entities administered by the `DistributedSystem`.
`String`	`getLocators()` Deprecated. Returns a comma-delimited list of locators for the system
`int`	`getLogDiskSpaceLimit()` Deprecated. Returns the log disk space limit in megabytes
`String`	`getLogFile()` Deprecated. Returns the name of the log file to which informational messages are written.
`int`	`getLogFileSizeLimit()` Deprecated. Returns the log file size limit in megabytes
`String`	`getLogLevel()` Deprecated. Returns the level at which informational messages are logged.
`String`	`getMcastAddress()` Deprecated. Returns the multicast address for the system
`int`	`getMcastPort()` Deprecated. Returns the multicast port for the system
`String`	`getMembershipPortRange()` Deprecated. Returns the membership-port-range property of the Distributed System.
`int`	`getMemberTimeout()` Deprecated. Returns the member-timeout millisecond value used in failure-detection protocols
`int`	`getRefreshInterval()` Deprecated. Returns the refreshInterval in seconds used for auto-polling and updating AdminDistributedSystem constituents including SystemMember, CacheServer, SystemMemberCache and StatisticResource
`String`	`getRemoteCommand()` Deprecated. Returns the remote command setting to use for remote administration
`String`	`getServerBindAddress()` Deprecated. Returns the IP address to which client/server server sockets are bound
`String`	`getSSLCiphers()` Deprecated. Returns the value of the "ssl-ciphers" property.
`Properties`	`getSSLProperties()` Deprecated. Returns the provider-specific properties for SSL.
`String`	`getSSLProtocols()` Deprecated. Returns the value of the "ssl-protocols" property.
`String`	`getSystemId()` Deprecated. Returns the string identity for the system
`String`	`getSystemName()` Deprecated. Returns the optional non-unique name for the system
`int`	`getTcpPort()` Deprecated. Returns the primary communication port number for the Distributed System.
`boolean`	`isSSLAuthenticationRequired()` Deprecated. Returns the value of the "ssl-require-authentication" property.
`boolean`	`isSSLEnabled()` Deprecated. Returns the value of the "ssl-enabled" property.
`void`	`removeCacheServerConfig(CacheServerConfig managerConfig)` Deprecated. as of 5.7 use `removeCacheVmConfig(com.gemstone.gemfire.admin.CacheVmConfig)` instead.
`void`	`removeCacheVmConfig(CacheVmConfig existing)` Deprecated. Removes the configuration for a `CacheVm`
`void`	`removeDistributionLocatorConfig(DistributionLocatorConfig config)` Deprecated. Removes a `DistributionLocatorConfig` from the distributed system.
`void`	`removeListener(DistributedSystemConfig.ConfigListener listener)` Deprecated. Removes previously registered listener of this config.
`void`	`removeSSLProperty(String key)` Deprecated. Removes an SSL property
`void`	`setAckSevereAlertThreshold(int seconds)` Deprecated. Sets the ack-severe-alert-threshold for the system
`void`	`setAckWaitThreshold(int seconds)` Deprecated. Sets the ack-wait-threshold for the system
`void`	`setBindAddress(String bindAddress)` Deprecated. Sets the IP address to which the distributed system's server sockets are bound.
`void`	`setDisableAutoReconnect(boolean newValue)` Deprecated. Disables auto reconnect after being forced out of the distributed system
`void`	`setDisableTcp(boolean flag)` Deprecated. Sets the disable-tcp property for the system.
`void`	`setEnableNetworkPartitionDetection(boolean newValue)` Deprecated. Turns on network partition detection
`void`	`setEntityConfigXMLFile(String xmlFile)` Deprecated. Sets the name of the XML file that specifies the configuration of managed entities administered by the `DistributedSystem`.
`void`	`setLocators(String locators)` Deprecated. Sets the comma-delimited list of locators for the system
`void`	`setLogDiskSpaceLimit(int limit)` Deprecated. Sets the log disk space limit in megabytes
`void`	`setLogFile(String logFile)` Deprecated. Sets the name of the log file to which informational messages are written.
`void`	`setLogFileSizeLimit(int limit)` Deprecated. Sets the log file size limit in megabytes
`void`	`setLogLevel(String logLevel)` Deprecated. Sets the level at which information messages are logged.
`void`	`setMcastAddress(String mcastAddress)` Deprecated. Sets the multicast address for the system
`void`	`setMcastPort(int mcastPort)` Deprecated. Sets the multicast port for the system
`void`	`setMembershipPortRange(String membershipPortRange)` Deprecated. Sets the membership-port-range property of the Distributed System.
`void`	`setMemberTimeout(int value)` Deprecated. Set the millisecond value of the member-timeout used in failure-detection protocols.
`void`	`setRefreshInterval(int timeInSecs)` Deprecated. Sets the refreshInterval in seconds
`void`	`setRemoteCommand(String command)` Deprecated. Sets the remote command setting to use for remote administration.
`void`	`setServerBindAddress(String bindAddress)` Deprecated. Sets the IP address to which a server cache will bind when listening for client cache connections.
`void`	`setSSLAuthenticationRequired(boolean authRequired)` Deprecated. Sets the value of the "ssl-require-authentication" property.
`void`	`setSSLCiphers(String ciphers)` Deprecated. Sets the value of the "ssl-ciphers" property.
`void`	`setSSLEnabled(boolean enabled)` Deprecated. Sets the value of the "ssl-enabled" property.
`void`	`setSSLProperties(Properties sslProperties)` Deprecated. Sets the provider-specific properties for SSL.
`void`	`setSSLProtocols(String protocols)` Deprecated. Sets the value of the "ssl-protocols" property.
`void`	`setSystemId(String systemId)` Deprecated. Sets the string identity for the system
`void`	`setSystemName(String name)` Deprecated. Sets the optional non-unique name for the system
`void`	`setTcpPort(int port)` Deprecated. Sets the primary communication port number for the Distributed System.
`void`	`validate()` Deprecated. Validates that this distributed system configuration is correct and consistent.

- Field Detail
  - ENTITY_CONFIG_XML_FILE_NAME
```
static final String ENTITY_CONFIG_XML_FILE_NAME
```
    Deprecated.
    
    The name of an XML file that specifies the configuration for the managed entities administered by the DistributedSystem. The XML file must conform to a dtd.
    
    See Also:
    Constant Field Values
  - DEFAULT_ENTITY_CONFIG_XML_FILE
```
static final String DEFAULT_ENTITY_CONFIG_XML_FILE
```
    Deprecated.
    
    The default value of the "entity-config-xml-file" property ("distributed-system.xml").
    
    See Also:
    Constant Field Values
  - SYSTEM_ID_NAME
```
static final String SYSTEM_ID_NAME
```
    Deprecated.
    
    The name of the "system-id" property
    
    See Also:
    Constant Field Values
  - DEFAULT_SYSTEM_ID
```
static final String DEFAULT_SYSTEM_ID
```
    Deprecated.
    
    The default value of the "system-id" property ("")
    
    See Also:
    Constant Field Values
  - NAME_NAME
```
static final String NAME_NAME
```
    Deprecated.
    
    The name of the "name" property. See getSystemName().
    
    See Also:
    Constant Field Values
  - DEFAULT_NAME
```
static final String DEFAULT_NAME
```
    Deprecated.
    
    The default value of the "name" property (""). See getSystemName().
    
    See Also:
    Constant Field Values
  - MCAST_PORT_NAME
```
static final String MCAST_PORT_NAME
```
    Deprecated.
    
    The name of the "mcastPort" property
    
    See Also:
    Constant Field Values
  - DEFAULT_MCAST_PORT
```
static final int DEFAULT_MCAST_PORT
```
    Deprecated.
    
    The default value of the "mcastPort" property (10334)
    
    See Also:
    Constant Field Values
  - MIN_MCAST_PORT
```
static final int MIN_MCAST_PORT
```
    Deprecated.
    
    The minimum mcastPort (0)
    
    See Also:
    Constant Field Values
  - MAX_MCAST_PORT
```
static final int MAX_MCAST_PORT
```
    Deprecated.
    
    The maximum mcastPort (65535)
    
    See Also:
    Constant Field Values
  - MCAST_ADDRESS_NAME
```
static final String MCAST_ADDRESS_NAME
```
    Deprecated.
    
    The name of the "mcastAddress" property
    
    See Also:
    Constant Field Values
  - DEFAULT_MCAST_ADDRESS
```
static final String DEFAULT_MCAST_ADDRESS
```
    Deprecated.
    
    The default value of the "mcastAddress" property (239.192.81.1).
  - MEMBERSHIP_PORT_RANGE_NAME
```
static final String MEMBERSHIP_PORT_RANGE_NAME
```
    Deprecated.
    
    The name of the "membership-port-range" property
    
    Since:
    
    6.5
    
    See Also:
    Constant Field Values
  - DEFAULT_MEMBERSHIP_PORT_RANGE
```
static final int[] DEFAULT_MEMBERSHIP_PORT_RANGE
```
    Deprecated.
    
    The default membership-port-range.
    Actual value is [1024,65535].
    
    Since:
    
    6.5
  - TCP_PORT_NAME
```
static final String TCP_PORT_NAME
```
    Deprecated.
    
    settings for tcp-port
    
    Since:
    
    6.5
    
    See Also:
    Constant Field Values
  - DEFAULT_TCP_PORT
```
static final int DEFAULT_TCP_PORT
```
    Deprecated.
    
    The default value of the "tcpPort" property.
    Actual value is 0.
    
    Since:
    
    6.5
    
    See Also:
    Constant Field Values
  - DEFAULT_ACK_WAIT_THRESHOLD
```
static final int DEFAULT_ACK_WAIT_THRESHOLD
```
    Deprecated.
    
    The default AckWaitThreshold.
    Actual value of this constant is 15 seconds.
    
    See Also:
    Constant Field Values
  - MIN_ACK_WAIT_THRESHOLD
```
static final int MIN_ACK_WAIT_THRESHOLD
```
    Deprecated.
    
    The minimum AckWaitThreshold.
    Actual value of this constant is 1 second.
    
    See Also:
    Constant Field Values
  - MAX_ACK_WAIT_THRESHOLD
```
static final int MAX_ACK_WAIT_THRESHOLD
```
    Deprecated.
    
    The maximum AckWaitThreshold.
    Actual value of this constant is MAX_INT seconds.
    
    See Also:
    Constant Field Values
  - DEFAULT_ACK_SEVERE_ALERT_THRESHOLD
```
static final int DEFAULT_ACK_SEVERE_ALERT_THRESHOLD
```
    Deprecated.
    
    The default ackSevereAlertThreshold.
    Actual value of this constant is 0 seconds, which turns off forced disconnects based on ack wait periods.
    
    See Also:
    Constant Field Values
  - MIN_ACK_SEVERE_ALERT_THRESHOLD
```
static final int MIN_ACK_SEVERE_ALERT_THRESHOLD
```
    Deprecated.
    
    The minimum ackSevereAlertThreshold.
    Actual value of this constant is 0 second, which turns off forced disconnects based on ack wait periods.
    
    See Also:
    Constant Field Values
  - MAX_ACK_SEVERE_ALERT_THRESHOLD
```
static final int MAX_ACK_SEVERE_ALERT_THRESHOLD
```
    Deprecated.
    
    The maximum ackSevereAlertThreshold.
    Actual value of this constant is MAX_INT seconds.
    
    See Also:
    Constant Field Values
  - LOCATORS_NAME
```
static final String LOCATORS_NAME
```
    Deprecated.
    
    The name of the "locators" property (comma-delimited host[port] list)
    
    See Also:
    Constant Field Values
  - DEFAULT_LOCATORS
```
static final String DEFAULT_LOCATORS
```
    Deprecated.
    
    The default value of the "locators" property ("")
    
    See Also:
    Constant Field Values
  - BIND_ADDRESS_NAME
```
static final String BIND_ADDRESS_NAME
```
    Deprecated.
    
    The name of the "bindAddress" property
    
    See Also:
    Constant Field Values
  - DEFAULT_BIND_ADDRESS
```
static final String DEFAULT_BIND_ADDRESS
```
    Deprecated.
    
    The default value of the "bindAddress" property
    
    See Also:
    Constant Field Values
  - REMOTE_COMMAND_NAME
```
static final String REMOTE_COMMAND_NAME
```
    Deprecated.
    
    The name of the remote-command property
    
    See Also:
    Constant Field Values
  - DEFAULT_REMOTE_COMMAND
```
static final String DEFAULT_REMOTE_COMMAND
```
    Deprecated.
    
    The default value of the remote-command property
    
    See Also:
    Constant Field Values
  - SSL_ENABLED_NAME
```
static final String SSL_ENABLED_NAME
```
    Deprecated.
    
    The name of the "SSLEnabled" property
    
    See Also:
    Constant Field Values
  - DEFAULT_SSL_ENABLED
```
static final boolean DEFAULT_SSL_ENABLED
```
    Deprecated.
    
    The default ssl-enabled state (false)
    
    See Also:
    Constant Field Values
  - SSL_PROTOCOLS_NAME
```
static final String SSL_PROTOCOLS_NAME
```
    Deprecated.
    
    The name of the "SSLProtocols" property
    
    See Also:
    Constant Field Values
  - DEFAULT_SSL_PROTOCOLS
```
static final String DEFAULT_SSL_PROTOCOLS
```
    Deprecated.
    
    The default ssl-protocols value (any)
    
    See Also:
    Constant Field Values
  - SSL_CIPHERS_NAME
```
static final String SSL_CIPHERS_NAME
```
    Deprecated.
    
    The name of the "SSLCiphers" property
    
    See Also:
    Constant Field Values
  - DEFAULT_SSL_CIPHERS
```
static final String DEFAULT_SSL_CIPHERS
```
    Deprecated.
    
    The default ssl-ciphers value. (any)
    
    See Also:
    Constant Field Values
  - SSL_REQUIRE_AUTHENTICATION_NAME
```
static final String SSL_REQUIRE_AUTHENTICATION_NAME
```
    Deprecated.
    
    The name of the "SSLRequireAuthentication" property
    
    See Also:
    Constant Field Values
  - DEFAULT_SSL_REQUIRE_AUTHENTICATION
```
static final boolean DEFAULT_SSL_REQUIRE_AUTHENTICATION
```
    Deprecated.
    
    The default ssl-require-authentication value (true)
    
    See Also:
    Constant Field Values
  - DEFAULT_DISABLE_TCP
```
static final boolean DEFAULT_DISABLE_TCP
```
    Deprecated.
    
    The default disable-tcp value (false)
    
    See Also:
    Constant Field Values
  - DEFAULT_ENABLE_NETWORK_PARTITION_DETECTION
```
static final boolean DEFAULT_ENABLE_NETWORK_PARTITION_DETECTION
```
    Deprecated.
    
    The default enable-network-partition-detection setting (false)
    
    See Also:
    Constant Field Values
  - DEFAULT_DISABLE_AUTO_RECONNECT
```
static final boolean DEFAULT_DISABLE_AUTO_RECONNECT
```
    Deprecated.
    
    The default disable-auto-reconnect setting (false)
    
    See Also:
    Constant Field Values
  - DEFAULT_MEMBER_TIMEOUT
```
static final int DEFAULT_MEMBER_TIMEOUT
```
    Deprecated.
    
    The default failure-detection timeout period for member heart-beat responses
    
    See Also:
    Constant Field Values
  - LOG_FILE_NAME
```
static final String LOG_FILE_NAME
```
    Deprecated.
    
    The name of the "logFile" property
    
    See Also:
    Constant Field Values
  - DEFAULT_LOG_FILE
```
static final String DEFAULT_LOG_FILE
```
    Deprecated.
    
    The default log-file value ("" which directs logging to standard output)
    
    See Also:
    Constant Field Values
  - LOG_LEVEL_NAME
```
static final String LOG_LEVEL_NAME
```
    Deprecated.
    
    The name of the "logLevel" property
    
    See Also:
    Constant Field Values
  - DEFAULT_LOG_LEVEL
```
static final String DEFAULT_LOG_LEVEL
```
    Deprecated.
    
    The default log level ("config")
    
    See Also:
    Constant Field Values
  - LOG_DISK_SPACE_LIMIT_NAME
```
static final String LOG_DISK_SPACE_LIMIT_NAME
```
    Deprecated.
    
    The name of the "LogDiskSpaceLimit" property
    
    See Also:
    Constant Field Values
  - DEFAULT_LOG_DISK_SPACE_LIMIT
```
static final int DEFAULT_LOG_DISK_SPACE_LIMIT
```
    Deprecated.
    
    The default log disk space limit in megabytes (0)
    
    See Also:
    Constant Field Values
  - MIN_LOG_DISK_SPACE_LIMIT
```
static final int MIN_LOG_DISK_SPACE_LIMIT
```
    Deprecated.
    
    The minimum log disk space limit in megabytes (0)
    
    See Also:
    Constant Field Values
  - MAX_LOG_DISK_SPACE_LIMIT
```
static final int MAX_LOG_DISK_SPACE_LIMIT
```
    Deprecated.
    
    The minimum log disk space limit in megabytes (1000000)
    
    See Also:
    Constant Field Values
  - LOG_FILE_SIZE_LIMIT_NAME
```
static final String LOG_FILE_SIZE_LIMIT_NAME
```
    Deprecated.
    
    The name of the "LogFileSizeLimit" property
    
    See Also:
    Constant Field Values
  - DEFAULT_LOG_FILE_SIZE_LIMIT
```
static final int DEFAULT_LOG_FILE_SIZE_LIMIT
```
    Deprecated.
    
    The default log file size limit in megabytes (0)
    
    See Also:
    Constant Field Values
  - MIN_LOG_FILE_SIZE_LIMIT
```
static final int MIN_LOG_FILE_SIZE_LIMIT
```
    Deprecated.
    
    The minimum log file size limit in megabytes (0)
    
    See Also:
    Constant Field Values
  - MAX_LOG_FILE_SIZE_LIMIT
```
static final int MAX_LOG_FILE_SIZE_LIMIT
```
    Deprecated.
    
    The minimum log file size limit in megabytes (1000000)
    
    See Also:
    Constant Field Values
  - REFRESH_INTERVAL_NAME
```
static final String REFRESH_INTERVAL_NAME
```
    Deprecated.
    
    The name of the "refreshInterval" property which will apply to SystemMember, SystemMemberCache and StatisticResource refresh. This interval (in seconds) is used for auto-polling and updating AdminDistributedSystem constituents including SystemMember, CacheServer, SystemMemberCache and StatisticResource. This interval is read-only and retains the value set when the config is created. Note that the resource MBeans actually refresh and hit the DS only if there is an RMI client connected
    
    See Also:
    Constant Field Values
  - DEFAULT_REFRESH_INTERVAL
```
static final int DEFAULT_REFRESH_INTERVAL
```
    Deprecated.
    
    The default "refreshInterval" in seconds which will apply to REFRESH_INTERVAL_NAME property. The default value is 15 secs
    
    See Also:
    Constant Field Values
- Method Detail
  - getEntityConfigXMLFile
```
String getEntityConfigXMLFile()
```
    Deprecated.
    
    Returns the name of the XML file that specifies the configuration of the managed entities administered by the DistributedSystem. The XML file must conform to a dtd.
    
    Since:
    
    4.0
  - setEntityConfigXMLFile
```
void setEntityConfigXMLFile(String xmlFile)
```
    Deprecated.
    
    Sets the name of the XML file that specifies the configuration of managed entities administered by the DistributedSystem.
  - getSystemId
```
String getSystemId()
```
    Deprecated.
    
    Returns the string identity for the system
  - setSystemId
```
void setSystemId(String systemId)
```
    Deprecated.
    
    Sets the string identity for the system
  - getSystemName
```
String getSystemName()
```
    Deprecated.
    
    Returns the optional non-unique name for the system
  - setSystemName
```
void setSystemName(String name)
```
    Deprecated.
    
    Sets the optional non-unique name for the system
  - getMcastAddress
```
String getMcastAddress()
```
    Deprecated.
    
    Returns the multicast address for the system
  - setMcastAddress
```
void setMcastAddress(String mcastAddress)
```
    Deprecated.
    
    Sets the multicast address for the system
  - getMcastPort
```
int getMcastPort()
```
    Deprecated.
    
    Returns the multicast port for the system
  - setMcastPort
```
void setMcastPort(int mcastPort)
```
    Deprecated.
    
    Sets the multicast port for the system
  - getAckWaitThreshold
```
int getAckWaitThreshold()
```
    Deprecated.
    
    Returns the ack-wait-threshold for the system
  - setAckWaitThreshold
```
void setAckWaitThreshold(int seconds)
```
    Deprecated.
    
    Sets the ack-wait-threshold for the system
  - getAckSevereAlertThreshold
```
int getAckSevereAlertThreshold()
```
    Deprecated.
    
    Returns the ack-severe-alert-threshold for the system
  - setAckSevereAlertThreshold
```
void setAckSevereAlertThreshold(int seconds)
```
    Deprecated.
    
    Sets the ack-severe-alert-threshold for the system
  - getLocators
```
String getLocators()
```
    Deprecated.
    
    Returns a comma-delimited list of locators for the system
  - setLocators
```
void setLocators(String locators)
```
    Deprecated.
    
    Sets the comma-delimited list of locators for the system
  - getMembershipPortRange
```
String getMembershipPortRange()
```
    Deprecated.
    
    Returns the membership-port-range property of the Distributed System. This range is given as two numbers separated by a minus sign.
    
    Since:
    
    6.5
  - setMembershipPortRange
```
void setMembershipPortRange(String membershipPortRange)
```
    Deprecated.
    
    Sets the membership-port-range property of the Distributed System. This range is given as two numbers separated by a minus sign.
    
    Since:
    
    6.5
  - setTcpPort
```
void setTcpPort(int port)
```
    Deprecated.
    
    Sets the primary communication port number for the Distributed System.
    
    Since:
    
    6.5
  - getTcpPort
```
int getTcpPort()
```
    Deprecated.
    
    Returns the primary communication port number for the Distributed System.
    
    Since:
    
    6.5
  - setDisableTcp
```
void setDisableTcp(boolean flag)
```
    Deprecated.
    
    Sets the disable-tcp property for the system. When tcp is disabled, the cache uses udp for unicast messaging. This must be consistent across all members of the distributed system. The default is to enable tcp.
  - getDisableTcp
```
boolean getDisableTcp()
```
    Deprecated.
    
    Returns the disable-tcp property for the system. When tcp is disabled, the cache uses udp for unicast messaging. This must be consistent across all members of the distributed system. The default is to enable tcp.
  - setEnableNetworkPartitionDetection
```
void setEnableNetworkPartitionDetection(boolean newValue)
```
    Deprecated.
    
    Turns on network partition detection
  - getEnableNetworkPartitionDetection
```
boolean getEnableNetworkPartitionDetection()
```
    Deprecated.
    
    Returns true if network partition detection is enabled.
  - setDisableAutoReconnect
```
void setDisableAutoReconnect(boolean newValue)
```
    Deprecated.
    
    Disables auto reconnect after being forced out of the distributed system
  - getDisableAutoReconnect
```
boolean getDisableAutoReconnect()
```
    Deprecated.
    
    Returns true if auto reconnect is disabled
  - getMemberTimeout
```
int getMemberTimeout()
```
    Deprecated.
    
    Returns the member-timeout millisecond value used in failure-detection protocols
  - setMemberTimeout
```
void setMemberTimeout(int value)
```
    Deprecated.
    
    Set the millisecond value of the member-timeout used in failure-detection protocols. This timeout determines how long a member has to respond to a heartbeat request. The member is given three chances before being kicked out of the distributed system with a SystemConnectException.
  - getBindAddress
```
String getBindAddress()
```
    Deprecated.
    
    Returns the IP address to which the distributed system's server sockets are bound.
    
    Since:
    
    4.0
  - setBindAddress
```
void setBindAddress(String bindAddress)
```
    Deprecated.
    
    Sets the IP address to which the distributed system's server sockets are bound.
    
    Since:
    
    4.0
  - getServerBindAddress
```
String getServerBindAddress()
```
    Deprecated.
    
    Returns the IP address to which client/server server sockets are bound
  - setServerBindAddress
```
void setServerBindAddress(String bindAddress)
```
    Deprecated.
    
    Sets the IP address to which a server cache will bind when listening for client cache connections.
  - getRemoteCommand
```
String getRemoteCommand()
```
    Deprecated.
    
    Returns the remote command setting to use for remote administration
  - setRemoteCommand
```
void setRemoteCommand(String command)
```
    Deprecated.
    
    Sets the remote command setting to use for remote administration. This attribute may be modified after this DistributedSystemConfig has been used to create an AdminDistributedSystem.
  - isSSLEnabled
```
boolean isSSLEnabled()
```
    Deprecated.
    
    Returns the value of the "ssl-enabled" property.
  - setSSLEnabled
```
void setSSLEnabled(boolean enabled)
```
    Deprecated.
    
    Sets the value of the "ssl-enabled" property.
  - getSSLProtocols
```
String getSSLProtocols()
```
    Deprecated.
    
    Returns the value of the "ssl-protocols" property.
  - setSSLProtocols
```
void setSSLProtocols(String protocols)
```
    Deprecated.
    
    Sets the value of the "ssl-protocols" property.
  - getSSLCiphers
```
String getSSLCiphers()
```
    Deprecated.
    
    Returns the value of the "ssl-ciphers" property.
  - setSSLCiphers
```
void setSSLCiphers(String ciphers)
```
    Deprecated.
    
    Sets the value of the "ssl-ciphers" property.
  - isSSLAuthenticationRequired
```
boolean isSSLAuthenticationRequired()
```
    Deprecated.
    
    Returns the value of the "ssl-require-authentication" property.
  - setSSLAuthenticationRequired
```
void setSSLAuthenticationRequired(boolean authRequired)
```
    Deprecated.
    
    Sets the value of the "ssl-require-authentication" property.
  - getSSLProperties
```
Properties getSSLProperties()
```
    Deprecated.
    
    Returns the provider-specific properties for SSL.
  - setSSLProperties
```
void setSSLProperties(Properties sslProperties)
```
    Deprecated.
    
    Sets the provider-specific properties for SSL.
  - addSSLProperty
```
void addSSLProperty(String key,
                  String value)
```
    Deprecated.
    
    Adds an SSL property
  - removeSSLProperty
```
void removeSSLProperty(String key)
```
    Deprecated.
    
    Removes an SSL property
  - getLogFile
```
String getLogFile()
```
    Deprecated.
    
    Returns the name of the log file to which informational messages are written.
    
    See Also:
    LogWriterI18n
  - setLogFile
```
void setLogFile(String logFile)
```
    Deprecated.
    
    Sets the name of the log file to which informational messages are written.
    
    See Also:
    LogWriterI18n
  - getLogLevel
```
String getLogLevel()
```
    Deprecated.
    
    Returns the level at which informational messages are logged.
  - setLogLevel
```
void setLogLevel(String logLevel)
```
    Deprecated.
    
    Sets the level at which information messages are logged.
  - getLogDiskSpaceLimit
```
int getLogDiskSpaceLimit()
```
    Deprecated.
    
    Returns the log disk space limit in megabytes
  - setLogDiskSpaceLimit
```
void setLogDiskSpaceLimit(int limit)
```
    Deprecated.
    
    Sets the log disk space limit in megabytes
  - getLogFileSizeLimit
```
int getLogFileSizeLimit()
```
    Deprecated.
    
    Returns the log file size limit in megabytes
  - setLogFileSizeLimit
```
void setLogFileSizeLimit(int limit)
```
    Deprecated.
    
    Sets the log file size limit in megabytes
  - getRefreshInterval
```
int getRefreshInterval()
```
    Deprecated.
    
    Returns the refreshInterval in seconds used for auto-polling and updating AdminDistributedSystem constituents including SystemMember, CacheServer, SystemMemberCache and StatisticResource
    
    Since:
    
    6.0
  - setRefreshInterval
```
void setRefreshInterval(int timeInSecs)
```
    Deprecated.
    
    Sets the refreshInterval in seconds
    
    Since:
    
    6.0
  - getCacheServerConfigs
```
@Deprecated
CacheServerConfig[] getCacheServerConfigs()
```
    Deprecated. as of 5.7 use getCacheVmConfigs() instead.
    
    Returns an array of configurations for statically known CacheServers.
  - createCacheServerConfig
```
@Deprecated
CacheServerConfig createCacheServerConfig()
```
    Deprecated. as of 5.7 use createCacheVmConfig() instead.
    
    Creates the configuration for a CacheServer
  - removeCacheServerConfig
```
@Deprecated
void removeCacheServerConfig(CacheServerConfig managerConfig)
```
    Deprecated. as of 5.7 use removeCacheVmConfig(com.gemstone.gemfire.admin.CacheVmConfig) instead.
    
    Removes the configuration for a CacheServer
  - getCacheVmConfigs
```
CacheVmConfig[] getCacheVmConfigs()
```
    Deprecated.
    
    Returns an array of configurations for statically known CacheVms.
    
    Since:
    
    5.7
  - createCacheVmConfig
```
CacheVmConfig createCacheVmConfig()
```
    Deprecated.
    
    Creates the configuration for a CacheVm.
    
    Since:
    
    5.7
  - removeCacheVmConfig
```
void removeCacheVmConfig(CacheVmConfig existing)
```
    Deprecated.
    
    Removes the configuration for a CacheVm
    
    Since:
    
    5.7
  - getDistributionLocatorConfigs
```
DistributionLocatorConfig[] getDistributionLocatorConfigs()
```
    Deprecated.
    
    Returns configuration information about DistributionLocators that are managed by an AdminDistributedSystem.
  - createDistributionLocatorConfig
```
DistributionLocatorConfig createDistributionLocatorConfig()
```
    Deprecated.
    
    Creates a new DistributionLocatorConfig for a distribution locator that is managed in this distributed system. The default locator config is set to not use multicast
  - removeDistributionLocatorConfig
```
void removeDistributionLocatorConfig(DistributionLocatorConfig config)
```
    Deprecated.
    
    Removes a DistributionLocatorConfig from the distributed system.
  - addListener
```
void addListener(DistributedSystemConfig.ConfigListener listener)
```
    Deprecated.
    
    Registers listener for notification of changes in this config.
  - removeListener
```
void removeListener(DistributedSystemConfig.ConfigListener listener)
```
    Deprecated.
    
    Removes previously registered listener of this config.
  - validate
```
void validate()
```
    Deprecated.
    
    Validates that this distributed system configuration is correct and consistent.
    
    Throws:
    
    IllegalStateException - If this config is not valid
    
    AdminXmlException - If the entity config XML file is not valid
  - clone
```
Object clone()
             throws CloneNotSupportedException
```
    Deprecated.
    
    Returns a copy of this DistributedSystemConfig object whose configuration can be modified. Note that this ConfigListeners that are registered on this config object are not cloned.
    
    Throws:
    
    CloneNotSupportedException
    Since:
    
    4.0

Interface DistributedSystemConfig

Nested Class Summary

Field Summary

Method Summary

Field Detail

ENTITY_CONFIG_XML_FILE_NAME

DEFAULT_ENTITY_CONFIG_XML_FILE

SYSTEM_ID_NAME

DEFAULT_SYSTEM_ID

NAME_NAME

DEFAULT_NAME

MCAST_PORT_NAME

DEFAULT_MCAST_PORT

MIN_MCAST_PORT

MAX_MCAST_PORT

MCAST_ADDRESS_NAME

DEFAULT_MCAST_ADDRESS

MEMBERSHIP_PORT_RANGE_NAME

DEFAULT_MEMBERSHIP_PORT_RANGE

TCP_PORT_NAME

DEFAULT_TCP_PORT

DEFAULT_ACK_WAIT_THRESHOLD

MIN_ACK_WAIT_THRESHOLD

MAX_ACK_WAIT_THRESHOLD

DEFAULT_ACK_SEVERE_ALERT_THRESHOLD

MIN_ACK_SEVERE_ALERT_THRESHOLD

MAX_ACK_SEVERE_ALERT_THRESHOLD

LOCATORS_NAME

DEFAULT_LOCATORS

BIND_ADDRESS_NAME

DEFAULT_BIND_ADDRESS

REMOTE_COMMAND_NAME

DEFAULT_REMOTE_COMMAND

SSL_ENABLED_NAME

DEFAULT_SSL_ENABLED

SSL_PROTOCOLS_NAME

DEFAULT_SSL_PROTOCOLS

SSL_CIPHERS_NAME

DEFAULT_SSL_CIPHERS

SSL_REQUIRE_AUTHENTICATION_NAME

DEFAULT_SSL_REQUIRE_AUTHENTICATION

DEFAULT_DISABLE_TCP

DEFAULT_ENABLE_NETWORK_PARTITION_DETECTION

DEFAULT_DISABLE_AUTO_RECONNECT

DEFAULT_MEMBER_TIMEOUT

LOG_FILE_NAME

DEFAULT_LOG_FILE

LOG_LEVEL_NAME

DEFAULT_LOG_LEVEL

LOG_DISK_SPACE_LIMIT_NAME

DEFAULT_LOG_DISK_SPACE_LIMIT

MIN_LOG_DISK_SPACE_LIMIT

MAX_LOG_DISK_SPACE_LIMIT

LOG_FILE_SIZE_LIMIT_NAME

DEFAULT_LOG_FILE_SIZE_LIMIT

MIN_LOG_FILE_SIZE_LIMIT

MAX_LOG_FILE_SIZE_LIMIT

REFRESH_INTERVAL_NAME

DEFAULT_REFRESH_INTERVAL

Method Detail

getEntityConfigXMLFile

setEntityConfigXMLFile

getSystemId

setSystemId

getSystemName

setSystemName

getMcastAddress

setMcastAddress

getMcastPort

setMcastPort

getAckWaitThreshold

setAckWaitThreshold

getAckSevereAlertThreshold

setAckSevereAlertThreshold

getLocators

setLocators

getMembershipPortRange

setMembershipPortRange

setTcpPort

getTcpPort