GemFire 5.5

com.gemstone.gemfire.admin
Interface DistributedSystemConfig

All Superinterfaces:
Cloneable
All Known Subinterfaces:
AgentConfig

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 servers 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
static interface DistributedSystemConfig.ConfigListener
          A listener whose callback methods are invoked when this config changes.
 
Field Summary
static String BIND_ADDRESS_NAME
          The name of the "bindAddress" property
static String DEFAULT_BIND_ADDRESS
          The default value of the "bindAddress" property
static boolean DEFAULT_DISABLE_TCP
          The default disable-tcp value (false)
static String DEFAULT_ENTITY_CONFIG_XML_FILE
          The default value of the "entity-config-xml-file" property ("distributed-system.xml").
static String DEFAULT_LOCATORS
          The default value of the "locators" property ("")
static int DEFAULT_LOG_DISK_SPACE_LIMIT
          The default log disk space limit in megabytes (0)
static String DEFAULT_LOG_FILE
          The default log-file value ("" which directs logging to standard output)
static int DEFAULT_LOG_FILE_SIZE_LIMIT
          The default log file size limit in megabytes (0)
static String DEFAULT_LOG_LEVEL
          The default log level ("config")
static String DEFAULT_MCAST_ADDRESS
          The default value of the "mcastAddress" property (239.192.81.1).
static int DEFAULT_MCAST_PORT
          The default value of the "mcastPort" property (10334)
static String DEFAULT_REMOTE_COMMAND
          The default value of the remote-command property
static String DEFAULT_SSL_CIPHERS
          The default ssl-ciphers value.
static boolean DEFAULT_SSL_ENABLED
          The default ssl-enabled state (false)
static String DEFAULT_SSL_PROTOCOLS
          The default ssl-protocols value (any)
static boolean DEFAULT_SSL_REQUIRE_AUTHENTICATION
          The default ssl-require-authentication value (true)
static String DEFAULT_SYSTEM_ID
          The default value of the "system-id" property ("")
static String ENTITY_CONFIG_XML_FILE_NAME
          The name of an XML file that specifies the configuration for the managed entities administered by the DistributedSystem.
static String LOCATORS_NAME
          The name of the "locators" property (comma-delimited host[port] list)
static String LOG_DISK_SPACE_LIMIT_NAME
          The name of the "LogDiskSpaceLimit" property
static String LOG_FILE_NAME
          The name of the "logFile" property
static String LOG_FILE_SIZE_LIMIT_NAME
          The name of the "LogFileSizeLimit" property
static String LOG_LEVEL_NAME
          The name of the "logLevel" property
static int MAX_LOG_DISK_SPACE_LIMIT
          The minimum log disk space limit in megabytes (1000000)
static int MAX_LOG_FILE_SIZE_LIMIT
          The minimum log file size limit in megabytes (1000000)
static int MAX_MCAST_PORT
          The maximum mcastPort (65535)
static String MCAST_ADDRESS_NAME
          The name of the "mcastAddress" property
static String MCAST_PORT_NAME
          The name of the "mcastPort" property
static int MIN_LOG_DISK_SPACE_LIMIT
          The minimum log disk space limit in megabytes (0)
static int MIN_LOG_FILE_SIZE_LIMIT
          The minimum log file size limit in megabytes (0)
static int MIN_MCAST_PORT
          The minimum mcastPort (0)
static String REMOTE_COMMAND_NAME
          The name of the remote-command property
static String SSL_CIPHERS_NAME
          The name of the "SSLCiphers" property
static String SSL_ENABLED_NAME
          The name of the "SSLEnabled" property
static String SSL_PROTOCOLS_NAME
          The name of the "SSLProtocols" property
static String SSL_REQUIRE_AUTHENTICATION_NAME
          The name of the "SSLRequireAuthentication" property
static String SYSTEM_ID_NAME
          The name of the "system-id" property
 
Method Summary
 void addListener(DistributedSystemConfig.ConfigListener listener)
          Registers listener for notification of changes in this config.
 void addSSLProperty(String key, String value)
          Adds an SSL property
 Object clone()
          Returns a copy of this DistributedSystemConfig object whose configuration can be modified.
 CacheServerConfig createCacheServerConfig()
          Creates the configuration for a CacheServer
 DistributionLocatorConfig createDistributionLocatorConfig()
          Creates a new DistributionLocatorConfig for a distribution locator that is managed in this distributed system.
 String getBindAddress()
          Returns the IP address to which the distributed system's server sockets are bound.
 CacheServerConfig[] getCacheServerConfigs()
          Returns an array of configurations for statically known CacheServers
 boolean getDisableTcp()
          Returns the disable-tcp property for the system.
 DistributionLocatorConfig[] getDistributionLocatorConfigs()
          Returns configuration information about DistributionLocators that are managed by an AdminDistributedSystem.
 String getEntityConfigXMLFile()
          Returns the name of the XML file that specifies the configuration of the managed entities administered by the DistributedSystem.
 String getLocators()
          Returns a comma-delimited list of locators for the system
 int getLogDiskSpaceLimit()
          Returns the log disk space limit in megabytes
 String getLogFile()
          Returns the name of the log file to which informational messages are written.
 int getLogFileSizeLimit()
          Returns the log file size limit in megabytes
 String getLogLevel()
          Returns the level at which informational messages are logged.
 String getMcastAddress()
          Returns the multicast address for the system
 int getMcastPort()
          Returns the multicast port for the system
 String getRemoteCommand()
          Returns the remote command setting to use for remote administration
 String getSSLCiphers()
          Returns the value of the "ssl-ciphers" property.
 Properties getSSLProperties()
          Returns the provider-specific properties for SSL.
 String getSSLProtocols()
          Returns the value of the "ssl-protocols" property.
 String getSystemId()
          Returns the string identity for the system
 String getSystemName()
          Returns the optional non-unique name for the system
 boolean isSSLAuthenticationRequired()
          Returns the value of the "ssl-require-authentication" property.
 boolean isSSLEnabled()
          Returns the value of the "ssl-enabled" property.
 void removeCacheServerConfig(CacheServerConfig managerConfig)
          Removes the configuration for a CacheServer
 void removeDistributionLocatorConfig(DistributionLocatorConfig config)
          Removes a DistributionLocatorConfig from the distributed system.
 void removeListener(DistributedSystemConfig.ConfigListener listener)
          Removes previously registered listener of this config.
 void removeSSLProperty(String key)
          Removes an SSL property
 void setBindAddress(String bindAddress)
          Sets the IP address to which the distributed system's server sockets are bound.
 void setDisableTcp(boolean flag)
          Sets the disable-tcp property for the system.
 void setEntityConfigXMLFile(String xmlFile)
          Sets the name of the XML file that specifies the configuration of managed entities administered by the DistributedSystem.
 void setLocators(String locators)
          Sets the comma-delimited list of locators for the system
 void setLogDiskSpaceLimit(int limit)
          Sets the log disk space limit in megabytes
 void setLogFile(String logFile)
          Sets the name of the log file to which informational messages are written.
 void setLogFileSizeLimit(int limit)
          Sets the log file size limit in megabytes
 void setLogLevel(String logLevel)
          Sets the level at which information messages are logged.
 void setMcastAddress(String mcastAddress)
          Sets the multicast address for the system
 void setMcastPort(int mcastPort)
          Sets the multicast port for the system
 void setRemoteCommand(String command)
          Sets the remote command setting to use for remote administration.
 void setSSLAuthenticationRequired(boolean authRequired)
          Sets the value of the "ssl-require-authentication" property.
 void setSSLCiphers(String ciphers)
          Sets the value of the "ssl-ciphers" property.
 void setSSLEnabled(boolean enabled)
          Sets the value of the "ssl-enabled" property.
 void setSSLProperties(Properties sslProperties)
          Sets the provider-specific properties for SSL.
 void setSSLProtocols(String protocols)
          Sets the value of the "ssl-protocols" property.
 void setSystemId(String systemId)
          Sets the string identity for the system
 void setSystemName(String name)
          Sets the optional non-unique name for the system
 void validate()
          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
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
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
The name of the "system-id" property

See Also:
Constant Field Values

DEFAULT_SYSTEM_ID

static final String DEFAULT_SYSTEM_ID
The default value of the "system-id" property ("")

See Also:
Constant Field Values

MCAST_PORT_NAME

static final String MCAST_PORT_NAME
The name of the "mcastPort" property

See Also:
Constant Field Values

DEFAULT_MCAST_PORT

static final int DEFAULT_MCAST_PORT
The default value of the "mcastPort" property (10334)

See Also:
Constant Field Values

MIN_MCAST_PORT

static final int MIN_MCAST_PORT
The minimum mcastPort (0)

See Also:
Constant Field Values

MAX_MCAST_PORT

static final int MAX_MCAST_PORT
The maximum mcastPort (65535)

See Also:
Constant Field Values

MCAST_ADDRESS_NAME

static final String MCAST_ADDRESS_NAME
The name of the "mcastAddress" property

See Also:
Constant Field Values

DEFAULT_MCAST_ADDRESS

static final String DEFAULT_MCAST_ADDRESS
The default value of the "mcastAddress" property (239.192.81.1).


LOCATORS_NAME

static final String LOCATORS_NAME
The name of the "locators" property (comma-delimited host[port] list)

See Also:
Constant Field Values

DEFAULT_LOCATORS

static final String DEFAULT_LOCATORS
The default value of the "locators" property ("")

See Also:
Constant Field Values

BIND_ADDRESS_NAME

static final String BIND_ADDRESS_NAME
The name of the "bindAddress" property

See Also:
Constant Field Values

DEFAULT_BIND_ADDRESS

static final String DEFAULT_BIND_ADDRESS
The default value of the "bindAddress" property

See Also:
Constant Field Values

REMOTE_COMMAND_NAME

static final String REMOTE_COMMAND_NAME
The name of the remote-command property

See Also:
Constant Field Values

DEFAULT_REMOTE_COMMAND

static final String DEFAULT_REMOTE_COMMAND
The default value of the remote-command property

See Also:
Constant Field Values

SSL_ENABLED_NAME

static final String SSL_ENABLED_NAME
The name of the "SSLEnabled" property

See Also:
Constant Field Values

DEFAULT_SSL_ENABLED

static final boolean DEFAULT_SSL_ENABLED
The default ssl-enabled state (false)

See Also:
Constant Field Values

SSL_PROTOCOLS_NAME

static final String SSL_PROTOCOLS_NAME
The name of the "SSLProtocols" property

See Also:
Constant Field Values

DEFAULT_SSL_PROTOCOLS

static final String DEFAULT_SSL_PROTOCOLS
The default ssl-protocols value (any)

See Also:
Constant Field Values

SSL_CIPHERS_NAME

static final String SSL_CIPHERS_NAME
The name of the "SSLCiphers" property

See Also:
Constant Field Values

DEFAULT_SSL_CIPHERS

static final String DEFAULT_SSL_CIPHERS
The default ssl-ciphers value. (any)

See Also:
Constant Field Values

SSL_REQUIRE_AUTHENTICATION_NAME

static final String SSL_REQUIRE_AUTHENTICATION_NAME
The name of the "SSLRequireAuthentication" property

See Also:
Constant Field Values

DEFAULT_SSL_REQUIRE_AUTHENTICATION

static final boolean DEFAULT_SSL_REQUIRE_AUTHENTICATION
The default ssl-require-authentication value (true)

See Also:
Constant Field Values

DEFAULT_DISABLE_TCP

static final boolean DEFAULT_DISABLE_TCP
The default disable-tcp value (false)

See Also:
Constant Field Values

LOG_FILE_NAME

static final String LOG_FILE_NAME
The name of the "logFile" property

See Also:
Constant Field Values

DEFAULT_LOG_FILE

static final String DEFAULT_LOG_FILE
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
The name of the "logLevel" property

See Also:
Constant Field Values

DEFAULT_LOG_LEVEL

static final String DEFAULT_LOG_LEVEL
The default log level ("config")

See Also:
Constant Field Values

LOG_DISK_SPACE_LIMIT_NAME

static final String LOG_DISK_SPACE_LIMIT_NAME
The name of the "LogDiskSpaceLimit" property

See Also:
Constant Field Values

DEFAULT_LOG_DISK_SPACE_LIMIT

static final int DEFAULT_LOG_DISK_SPACE_LIMIT
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
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
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
The name of the "LogFileSizeLimit" property

See Also:
Constant Field Values

DEFAULT_LOG_FILE_SIZE_LIMIT

static final int DEFAULT_LOG_FILE_SIZE_LIMIT
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
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
The minimum log file size limit in megabytes (1000000)

See Also:
Constant Field Values
Method Detail

getEntityConfigXMLFile

String getEntityConfigXMLFile()
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)
Sets the name of the XML file that specifies the configuration of managed entities administered by the DistributedSystem.


getSystemId

String getSystemId()
Returns the string identity for the system


setSystemId

void setSystemId(String systemId)
Sets the string identity for the system


getSystemName

String getSystemName()
Returns the optional non-unique name for the system


setSystemName

void setSystemName(String name)
Sets the optional non-unique name for the system


getMcastAddress

String getMcastAddress()
Returns the multicast address for the system


setMcastAddress

void setMcastAddress(String mcastAddress)
Sets the multicast address for the system


getMcastPort

int getMcastPort()
Returns the multicast port for the system


setMcastPort

void setMcastPort(int mcastPort)
Sets the multicast port for the system


getLocators

String getLocators()
Returns a comma-delimited list of locators for the system


setLocators

void setLocators(String locators)
Sets the comma-delimited list of locators for the system


setDisableTcp

void setDisableTcp(boolean flag)
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()
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.


getBindAddress

String getBindAddress()
Returns the IP address to which the distributed system's server sockets are bound.

Since:
4.0

setBindAddress

void setBindAddress(String bindAddress)
Sets the IP address to which the distributed system's server sockets are bound.

Since:
4.0

getRemoteCommand

String getRemoteCommand()
Returns the remote command setting to use for remote administration


setRemoteCommand

void setRemoteCommand(String command)
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()
Returns the value of the "ssl-enabled" property.


setSSLEnabled

void setSSLEnabled(boolean enabled)
Sets the value of the "ssl-enabled" property.


getSSLProtocols

String getSSLProtocols()
Returns the value of the "ssl-protocols" property.


setSSLProtocols

void setSSLProtocols(String protocols)
Sets the value of the "ssl-protocols" property.


getSSLCiphers

String getSSLCiphers()
Returns the value of the "ssl-ciphers" property.


setSSLCiphers

void setSSLCiphers(String ciphers)
Sets the value of the "ssl-ciphers" property.


isSSLAuthenticationRequired

boolean isSSLAuthenticationRequired()
Returns the value of the "ssl-require-authentication" property.


setSSLAuthenticationRequired

void setSSLAuthenticationRequired(boolean authRequired)
Sets the value of the "ssl-require-authentication" property.


getSSLProperties

Properties getSSLProperties()
Returns the provider-specific properties for SSL.


setSSLProperties

void setSSLProperties(Properties sslProperties)
Sets the provider-specific properties for SSL.


addSSLProperty

void addSSLProperty(String key,
                    String value)
Adds an SSL property


removeSSLProperty

void removeSSLProperty(String key)
Removes an SSL property


getLogFile

String getLogFile()
Returns the name of the log file to which informational messages are written.

See Also:
LogWriter

setLogFile

void setLogFile(String logFile)
Sets the name of the log file to which informational messages are written.

See Also:
LogWriter

getLogLevel

String getLogLevel()
Returns the level at which informational messages are logged.


setLogLevel

void setLogLevel(String logLevel)
Sets the level at which information messages are logged.


getLogDiskSpaceLimit

int getLogDiskSpaceLimit()
Returns the log disk space limit in megabytes


setLogDiskSpaceLimit

void setLogDiskSpaceLimit(int limit)
Sets the log disk space limit in megabytes


getLogFileSizeLimit

int getLogFileSizeLimit()
Returns the log file size limit in megabytes


setLogFileSizeLimit

void setLogFileSizeLimit(int limit)
Sets the log file size limit in megabytes


getCacheServerConfigs

CacheServerConfig[] getCacheServerConfigs()
Returns an array of configurations for statically known CacheServers


createCacheServerConfig

CacheServerConfig createCacheServerConfig()
Creates the configuration for a CacheServer


removeCacheServerConfig

void removeCacheServerConfig(CacheServerConfig managerConfig)
Removes the configuration for a CacheServer


getDistributionLocatorConfigs

DistributionLocatorConfig[] getDistributionLocatorConfigs()
Returns configuration information about DistributionLocators that are managed by an AdminDistributedSystem.


createDistributionLocatorConfig

DistributionLocatorConfig createDistributionLocatorConfig()
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)
Removes a DistributionLocatorConfig from the distributed system.


addListener

void addListener(DistributedSystemConfig.ConfigListener listener)
Registers listener for notification of changes in this config.


removeListener

void removeListener(DistributedSystemConfig.ConfigListener listener)
Removes previously registered listener of this config.


validate

void validate()
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
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

GemFire 5.5

Copyright © 2002-2008 GemStone Systems, Inc. All Rights Reserved.