management
package instead@Deprecated public interface DistributedSystemConfig extends Cloneable
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 AdminDistributedSystem
s,
a copy of the DistributedSystemConfig
object can be made by invoking the
clone()
method.
Modifier and Type | Interface and Description |
---|---|
static interface |
DistributedSystemConfig.ConfigListener
Deprecated.
A listener whose callback methods are invoked when this config changes.
|
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_JMX
Deprecated.
The default disable-jmx value (
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_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 |
SYSTEM_ID_NAME
Deprecated.
The name of the "system-id" property
|
static String |
TCP_PORT_NAME
Deprecated.
settings for tcp-port
|
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 |
getDisableJmx()
Deprecated.
Returns the disable-jmx property for the process.
|
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(org.apache.geode.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 |
setDisableJmx(boolean flag)
Deprecated.
Sets the disable-jmx property for the 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.
|
static final String ENTITY_CONFIG_XML_FILE_NAME
DistributedSystem
. The XML file must conform
to a dtd.static final String DEFAULT_ENTITY_CONFIG_XML_FILE
static final String SYSTEM_ID_NAME
static final String DEFAULT_SYSTEM_ID
static final String NAME_NAME
getSystemName()
.static final String DEFAULT_NAME
getSystemName()
.static final String MCAST_PORT_NAME
static final int DEFAULT_MCAST_PORT
static final int MIN_MCAST_PORT
static final int MAX_MCAST_PORT
static final String MCAST_ADDRESS_NAME
static final String DEFAULT_MCAST_ADDRESS
static final String MEMBERSHIP_PORT_RANGE_NAME
static final int[] DEFAULT_MEMBERSHIP_PORT_RANGE
Actual value is [41000,61000]
.
static final String TCP_PORT_NAME
static final int DEFAULT_TCP_PORT
Actual value is 0
.
static final int DEFAULT_ACK_WAIT_THRESHOLD
Actual value of this constant is 15
seconds.
static final int MIN_ACK_WAIT_THRESHOLD
Actual value of this constant is 1
second.
static final int MAX_ACK_WAIT_THRESHOLD
Actual value of this constant is MAX_INT
seconds.
static final int DEFAULT_ACK_SEVERE_ALERT_THRESHOLD
Actual value of this constant is 0
seconds, which turns off forced disconnects
based on ack wait periods.
static final int MIN_ACK_SEVERE_ALERT_THRESHOLD
Actual value of this constant is 0
second, which turns off forced disconnects
based on ack wait periods.
static final int MAX_ACK_SEVERE_ALERT_THRESHOLD
Actual value of this constant is MAX_INT
seconds.
static final String LOCATORS_NAME
static final String DEFAULT_LOCATORS
static final String BIND_ADDRESS_NAME
static final String DEFAULT_BIND_ADDRESS
static final String REMOTE_COMMAND_NAME
static final String DEFAULT_REMOTE_COMMAND
static final boolean DEFAULT_DISABLE_TCP
false
)static final boolean DEFAULT_DISABLE_JMX
false
)static final boolean DEFAULT_ENABLE_NETWORK_PARTITION_DETECTION
false
)static final boolean DEFAULT_DISABLE_AUTO_RECONNECT
false
)static final int DEFAULT_MEMBER_TIMEOUT
static final String LOG_FILE_NAME
static final String DEFAULT_LOG_FILE
static final String LOG_LEVEL_NAME
static final String DEFAULT_LOG_LEVEL
static final String LOG_DISK_SPACE_LIMIT_NAME
static final int DEFAULT_LOG_DISK_SPACE_LIMIT
static final int MIN_LOG_DISK_SPACE_LIMIT
static final int MAX_LOG_DISK_SPACE_LIMIT
static final String LOG_FILE_SIZE_LIMIT_NAME
static final int DEFAULT_LOG_FILE_SIZE_LIMIT
static final int MIN_LOG_FILE_SIZE_LIMIT
static final int MAX_LOG_FILE_SIZE_LIMIT
static final String REFRESH_INTERVAL_NAME
static final int DEFAULT_REFRESH_INTERVAL
String getEntityConfigXMLFile()
DistributedSystem
. The XML file must conform to a
dtd.DistributedSystem
void setEntityConfigXMLFile(String xmlFile)
DistributedSystem
.xmlFile
- the name of the XML file that specifies the configuration of managed entities
administered by the DistributedSystem
String getSystemId()
void setSystemId(String systemId)
systemId
- the string identity for the systemString getSystemName()
void setSystemName(String name)
name
- the optional non-unique name for the systemString getMcastAddress()
void setMcastAddress(String mcastAddress)
mcastAddress
- the multicast address for the systemint getMcastPort()
void setMcastPort(int mcastPort)
mcastPort
- the multicast port for the systemint getAckWaitThreshold()
void setAckWaitThreshold(int seconds)
seconds
- the ack-wait-threshold for the systemint getAckSevereAlertThreshold()
void setAckSevereAlertThreshold(int seconds)
seconds
- the ack-severe-alert-threshold for the systemString getLocators()
void setLocators(String locators)
locators
- the comma-delimited list of locators for the systemString getMembershipPortRange()
void setMembershipPortRange(String membershipPortRange)
membershipPortRange
- the membership-port-range property of the Distributed Systemvoid setTcpPort(int port)
port
- the primary communication port number for the Distributed Systemint getTcpPort()
void setDisableTcp(boolean flag)
flag
- the disable-tcp property for the systemboolean getDisableTcp()
void setDisableJmx(boolean flag)
flag
- the disable-jmx property for the processboolean getDisableJmx()
void setEnableNetworkPartitionDetection(boolean newValue)
newValue
- whether network partition detection is enabledboolean getEnableNetworkPartitionDetection()
void setDisableAutoReconnect(boolean newValue)
newValue
- whether auto reconnect is disabledboolean getDisableAutoReconnect()
int getMemberTimeout()
void setMemberTimeout(int value)
value
- the millisecond value of the member-timeout used in failure-detection protocolsString getBindAddress()
void setBindAddress(String bindAddress)
bindAddress
- the IP address to which the distributed system's server sockets are boundString getServerBindAddress()
void setServerBindAddress(String bindAddress)
bindAddress
- the IP address to which a server cache will bind when listening for client
cache connectionsString getRemoteCommand()
void setRemoteCommand(String command)
DistributedSystemConfig
has been used to create an
AdminDistributedSystem
.command
- the remote command setting to use for remote administrationboolean isSSLEnabled()
void setSSLEnabled(boolean enabled)
enabled
- the value of the "ssl-enabled" propertyString getSSLProtocols()
void setSSLProtocols(String protocols)
protocols
- the value of the "ssl-protocols" propertyString getSSLCiphers()
void setSSLCiphers(String ciphers)
ciphers
- the value of the "ssl-ciphers" propertyboolean isSSLAuthenticationRequired()
void setSSLAuthenticationRequired(boolean authRequired)
authRequired
- the value of the "ssl-require-authentication" propertyProperties getSSLProperties()
void setSSLProperties(Properties sslProperties)
sslProperties
- the provider-specific properties for SSLvoid addSSLProperty(String key, String value)
key
- the name of the property to addvalue
- the value of the property to addvoid removeSSLProperty(String key)
key
- the name of the property to removeString getLogFile()
LogWriter
void setLogFile(String logFile)
logFile
- the name of the log file to which informational messages are writtenLogWriter
String getLogLevel()
void setLogLevel(String logLevel)
logLevel
- the level at which information messages are loggedint getLogDiskSpaceLimit()
void setLogDiskSpaceLimit(int limit)
limit
- the log disk space limit in megabytesint getLogFileSizeLimit()
void setLogFileSizeLimit(int limit)
limit
- the log file size limit in megabytesint getRefreshInterval()
void setRefreshInterval(int timeInSecs)
timeInSecs
- the refreshInterval in seconds@Deprecated CacheServerConfig[] getCacheServerConfigs()
getCacheVmConfigs()
instead.CacheServers
.CacheServers
@Deprecated CacheServerConfig createCacheServerConfig()
createCacheVmConfig()
instead.@Deprecated void removeCacheServerConfig(CacheServerConfig managerConfig)
removeCacheVmConfig(org.apache.geode.admin.CacheVmConfig)
instead.managerConfig
- the configuration to removeCacheVmConfig[] getCacheVmConfigs()
CacheVm
s.CacheVm
sCacheVmConfig createCacheVmConfig()
CacheVm
.void removeCacheVmConfig(CacheVmConfig existing)
CacheVm
existing
- the configuration to removeDistributionLocatorConfig[] getDistributionLocatorConfigs()
DistributionLocator
s that are managed by an
AdminDistributedSystem
.DistributionLocator
s that are managed by an
AdminDistributedSystem
DistributionLocatorConfig createDistributionLocatorConfig()
DistributionLocatorConfig
for a distribution locator that is managed
in this distributed system. The default locator config is set to not use multicastDistributionLocatorConfig
void removeDistributionLocatorConfig(DistributionLocatorConfig config)
DistributionLocatorConfig
from the distributed system.config
- the DistributionLocatorConfig
to removevoid addListener(DistributedSystemConfig.ConfigListener listener)
listener
- the listener to registervoid removeListener(DistributedSystemConfig.ConfigListener listener)
listener
- the listener to removevoid validate()
IllegalStateException
- If this config is not validAdminXmlException
- If the entity config XML file is
not validObject clone() throws CloneNotSupportedException
DistributedSystemConfig
object whose configuration can be
modified. Note that this ConfigListener
s that
are registered on this config object are not cloned.DistributedSystemConfig
object whose configuration can be
modifiedCloneNotSupportedException
- if the object's class does not support the Cloneable
interface