management
package instead@Deprecated public interface AgentConfig extends DistributedSystemConfig
"agent.properties"
can be
used to override the default values of AgentConfig
attributes. The
"gfAgentPropertyFile" system property can be
used to specify an agent properties file other than "agent.properties". System properties
prefixed with "gemfire.agent." can be used to override the
values in the properties file. For instance "-Dgemfire.agent.http-port=8081" can be used to
override the default port for the HTTP adapter. Configuration related to the distributed system
that the JMX agent administers is inherited from and described in AgentConfig
's
superinterface, DistributedSystemConfig
.
An AgentConfig
can be modified using a number of mutator methods until it is used to
create an Agent
. After that, attempts to modify most attributes in the
AgentConfig
will result in an IllegalStateException
being thrown. If you
wish to use the same AgentConfig
to configure multiple Agent
s, a copy
of the AgentConfig
object can be made by invoking its clone()
method.
JMX Administation Agent Configuration Properties
These parameters configure sockets that are created by the GemFire JMX Agent regardless of which adapters are enabled. These setting apply to all adapters. For example, if clients connect to the RMI adapter using SSL, then clients must also connect to the HTTP adapter using SSL (HTTPS). Note that these configuration attributes do not effect how the agent connects to the distributed system it administers, only how JMX clients connect to the agent.
http://localhost:8080
.localhost
)DistributedSystemConfig.ConfigListener
Modifier and Type | Field and Description |
---|---|
static String |
AGENT_SSL_CIPHERS_NAME
Deprecated.
The name of the "agent-ssl-ciphers" property
|
static String |
AGENT_SSL_ENABLED_NAME
Deprecated.
The name of the "agent-ssl-enabled" property
|
static String |
AGENT_SSL_PROTOCOLS_NAME
Deprecated.
The name of the "agent-ssl-protocols" property
|
static String |
AGENT_SSL_REQUIRE_AUTHENTICATION_NAME
Deprecated.
The name of the "agent-ssl-require-authentication" property
|
static String |
AUTO_CONNECT_NAME
Deprecated.
The name of the "auto-connect" property
|
static String |
DEFAULT_AGENT_SSL_CIPHERS
Deprecated.
The default value of the "agent-ssl-ciphers" property
|
static boolean |
DEFAULT_AGENT_SSL_ENABLED
Deprecated.
The default value of the "agent-ssl-enabled" property
|
static String |
DEFAULT_AGENT_SSL_PROTOCOLS
Deprecated.
The default value of the "agent-ssl-protocols" property
|
static boolean |
DEFAULT_AGENT_SSL_REQUIRE_AUTHENTICATION
Deprecated.
The default value of the "agent-ssl-require-authentication" property
|
static boolean |
DEFAULT_AUTO_CONNECT
Deprecated.
The default value of the "auto-connect" property
|
static String |
DEFAULT_EMAIL_FROM
Deprecated.
The default value of the "email-notification-from" property
|
static String |
DEFAULT_EMAIL_HOST
Deprecated.
The default value of the "email-notification-host" property
|
static boolean |
DEFAULT_EMAIL_NOTIFICATIONS_ENABLED
Deprecated.
The default value of the "email-notification-enabled" property
|
static String |
DEFAULT_EMAIL_TO_LIST
Deprecated.
The default value of the "email-notification-to" property
|
static boolean |
DEFAULT_HTTP_AUTHENTICATION_ENABLED
Deprecated.
The default value of the "http-authentication-enabled" property
|
static String |
DEFAULT_HTTP_AUTHENTICATION_PASSWORD
Deprecated.
The default value of the "http-authentication-password" property
|
static String |
DEFAULT_HTTP_AUTHENTICATION_USER
Deprecated.
The default value of the "http-authentication-user" property
|
static String |
DEFAULT_HTTP_BIND_ADDRESS
Deprecated.
The default value of the "httpBindAddress" property
|
static boolean |
DEFAULT_HTTP_ENABLED
Deprecated.
The default value of the "httpEnabled" property
|
static int |
DEFAULT_HTTP_PORT
Deprecated.
The default value of the "httpPort" property (8080)
|
static boolean |
DEFAULT_HTTP_SSL_REQUIRE_AUTHENTICATION
Deprecated.
The default value of the "http-ssl-require-authentication" property
|
static String |
DEFAULT_PROPERTY_FILE
Deprecated.
The default "propertyFile" value
|
static String |
DEFAULT_RMI_BIND_ADDRESS
Deprecated.
The default value of the rmi-bind-address property
|
static boolean |
DEFAULT_RMI_ENABLED
Deprecated.
The default value of the rmi-enabled property
|
static int |
DEFAULT_RMI_PORT
Deprecated.
The default value of the rmi-port property (1099)
|
static boolean |
DEFAULT_RMI_REGISTRY_ENABLED
Deprecated.
The default value of the rmi-registry-enabled property
|
static int |
DEFAULT_RMI_SERVER_PORT
Deprecated.
The default value of the rmi-server-port property (0)
|
static String |
DEFAULT_SNMP_BIND_ADDRESS
Deprecated.
The default value of the "snmpBindAddress" property
|
static String |
DEFAULT_SNMP_DIRECTORY
Deprecated.
The default value of the "snmpDirectory" property
|
static boolean |
DEFAULT_SNMP_ENABLED
Deprecated.
The default value of the "snmpEnabled" property
|
static String |
DEFAULT_STATE_SAVE_FILE
Deprecated.
The default name for file that has "agent state saved serialized"
|
static String |
EMAIL_NOTIFICATIONS_ENABLED_NAME
Deprecated.
The name of the "email-notification-enabled" property
|
static String |
EMAIL_NOTIFICATIONS_FROM_NAME
Deprecated.
The name of the "email-notification-from" property
|
static String |
EMAIL_NOTIFICATIONS_HOST_NAME
Deprecated.
The name of the "email-notification-host" property
|
static String |
EMAIL_NOTIFICATIONS_TO_LIST_NAME
Deprecated.
The name of the "email-notification-to" property
|
static String |
HTTP_AUTHENTICATION_ENABLED_NAME
Deprecated.
The name of the "http-authentication-enabled" property
|
static String |
HTTP_AUTHENTICATION_PASSWORD_NAME
Deprecated.
The name of the "http-authentication-password" property
|
static String |
HTTP_AUTHENTICATION_USER_NAME
Deprecated.
The name of the "http-authentication-user" property
|
static String |
HTTP_BIND_ADDRESS_NAME
Deprecated.
The name of the "httpBindAddress" property
|
static String |
HTTP_ENABLED_NAME
Deprecated.
The name of the "httpEnabled" property
|
static String |
HTTP_PORT_NAME
Deprecated.
The name of the "httpPort" property
|
static String |
HTTP_SSL_REQUIRE_AUTHENTICATION_NAME
Deprecated.
The name of the "http-ssl-require-authentication" property
|
static int |
MAX_HTTP_PORT
Deprecated.
The maximum httpPort (65535)
|
static int |
MAX_RMI_PORT
Deprecated.
The maximum value for rmi-port or rmi-server-port (65535)
|
static int |
MIN_HTTP_PORT
Deprecated.
The minimum httpPort (0)
|
static int |
MIN_RMI_PORT
Deprecated.
The minimum value for rmi-port or rmi-server-port (0)
|
static String |
RMI_BIND_ADDRESS_NAME
Deprecated.
The name of the "rmiBindAddress" property
|
static String |
RMI_ENABLED_NAME
Deprecated.
The name of the "rmiEnabled" property
|
static String |
RMI_PORT_NAME
Deprecated.
The name of the "rmiPort" property
|
static String |
RMI_REGISTRY_ENABLED_NAME
Deprecated.
The name of the "rmi-registry-enabled" property
|
static String |
RMI_SERVER_PORT_NAME
Deprecated.
The name of the "rmi-server-port" property
|
static String |
SNMP_BIND_ADDRESS_NAME
Deprecated.
The name of the "snmpBindAddress" property
|
static String |
SNMP_DIRECTORY_NAME
Deprecated.
The name of the "snmpDirectory" property
|
static String |
SNMP_ENABLED_NAME
Deprecated.
The name of the "snmpEnabled" property
|
static String |
STATE_SAVE_FILE_NAME
Deprecated.
The name of the "state-save-file-name" property
|
static String |
SYSTEM_PROPERTY_PREFIX
Deprecated.
The prefix for JMX Agent configuration system properties
|
BIND_ADDRESS_NAME, DEFAULT_ACK_SEVERE_ALERT_THRESHOLD, DEFAULT_ACK_WAIT_THRESHOLD, DEFAULT_BIND_ADDRESS, DEFAULT_DISABLE_AUTO_RECONNECT, DEFAULT_DISABLE_JMX, DEFAULT_DISABLE_TCP, DEFAULT_ENABLE_NETWORK_PARTITION_DETECTION, DEFAULT_ENTITY_CONFIG_XML_FILE, DEFAULT_LOCATORS, DEFAULT_LOG_DISK_SPACE_LIMIT, DEFAULT_LOG_FILE, DEFAULT_LOG_FILE_SIZE_LIMIT, DEFAULT_LOG_LEVEL, DEFAULT_MCAST_ADDRESS, DEFAULT_MCAST_PORT, DEFAULT_MEMBER_TIMEOUT, DEFAULT_MEMBERSHIP_PORT_RANGE, DEFAULT_NAME, DEFAULT_REFRESH_INTERVAL, DEFAULT_REMOTE_COMMAND, DEFAULT_SYSTEM_ID, DEFAULT_TCP_PORT, ENTITY_CONFIG_XML_FILE_NAME, LOCATORS_NAME, LOG_DISK_SPACE_LIMIT_NAME, LOG_FILE_NAME, LOG_FILE_SIZE_LIMIT_NAME, LOG_LEVEL_NAME, MAX_ACK_SEVERE_ALERT_THRESHOLD, MAX_ACK_WAIT_THRESHOLD, MAX_LOG_DISK_SPACE_LIMIT, MAX_LOG_FILE_SIZE_LIMIT, MAX_MCAST_PORT, MCAST_ADDRESS_NAME, MCAST_PORT_NAME, MEMBERSHIP_PORT_RANGE_NAME, MIN_ACK_SEVERE_ALERT_THRESHOLD, MIN_ACK_WAIT_THRESHOLD, MIN_LOG_DISK_SPACE_LIMIT, MIN_LOG_FILE_SIZE_LIMIT, MIN_MCAST_PORT, NAME_NAME, REFRESH_INTERVAL_NAME, REMOTE_COMMAND_NAME, SYSTEM_ID_NAME, TCP_PORT_NAME
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Deprecated.
Returns an
AgentConfig with the same configuration as this
AgentConfig . |
String |
getAgentSSLCiphers()
Deprecated.
Returns the SSL ciphers used when connecting to the JMX agent.
|
String |
getAgentSSLProtocols()
Deprecated.
Returns the SSL protocols used when connecting to the JMX agent.
|
boolean |
getAutoConnect()
Deprecated.
Returns whether or not the JMX agent will automatically connect to the distributed system it
administers.
|
String |
getEmailNotificationFrom()
Deprecated.
Returns the EmailID from whom notification emails are sent.
|
String |
getEmailNotificationHost()
Deprecated.
Returns the Host Name using which notification emails are sent.
|
String |
getEmailNotificationToList()
Deprecated.
Returns the comma separated EmailID list to whom notification emails are sent.
|
String |
getHttpAuthPassword()
Deprecated.
Returns the password for HTTP adapter authentication.
|
String |
getHttpAuthUser()
Deprecated.
Returns the user name for HTTP adapter authentication.
|
String |
getHttpBindAddress()
Deprecated.
Returns the bind address to which the HTTP adapter's listening socket is bound.
|
int |
getHttpPort()
Deprecated.
Returns the port of the HTTP adapter.
|
String |
getRmiBindAddress()
Deprecated.
Returns the bind address to which the RMI adapter's listening sockets are bound.
|
int |
getRmiPort()
Deprecated.
Returns the port of the RMI adapter.
|
int |
getRmiServerPort()
Deprecated.
Returns the port of the RMI Connector Server.
|
String |
getSnmpBindAddress()
Deprecated.
Returns the bind address used with the SNMP adapter.
|
String |
getSnmpDirectory()
Deprecated.
Returns the directory for the SNMP adapter.
|
String |
getStateSaveFile()
Deprecated.
Returns the name of the file to be used for saving agent state
See description above.
|
boolean |
isAgentSSLEnabled()
Deprecated.
Returns whether or not SSL is required for the JMX agent.
|
boolean |
isAgentSSLRequireAuth()
Deprecated.
Returns whether SSL authentication is used when connecting to the RMI connector.
|
boolean |
isEmailNotificationEnabled()
Deprecated.
Returns whether Emails for Notifications is enabled
See description above.
|
boolean |
isHttpAuthEnabled()
Deprecated.
Returns whether or not the HTTP adapter authenticates connections.
|
boolean |
isHttpEnabled()
Deprecated.
Returns whether or not the HTTP adapter is enabled.
|
boolean |
isHttpSSLRequireAuth()
Deprecated.
Returns whether SSL authentication is used when connecting to the HTTP connector.
|
boolean |
isRmiEnabled()
Deprecated.
Returns whether or not the RMI adapter is enabled.
|
boolean |
isRmiRegistryEnabled()
Deprecated.
Returns whether or not the agent hosts an RMI registry.
|
boolean |
isSnmpEnabled()
Deprecated.
Returns whether or not the SNMP adapter is enabled.
|
void |
setAgentSSLCiphers(String ciphers)
Deprecated.
Sets the SSL ciphers used when connecting to the JMX agent.
|
void |
setAgentSSLEnabled(boolean enabled)
Deprecated.
Sets whether or not SSL is required for the JMX agent.
|
void |
setAgentSSLProtocols(String protocols)
Deprecated.
Sets the SSL protocols used when connecting to the JMX agent.
|
void |
setAgentSSLRequireAuth(boolean require)
Deprecated.
Sets whether SSL authentication is used when connecting to the RMI connector.
|
void |
setAutoConnect(boolean autoConnect)
Deprecated.
Sets whether or not the JMX agent will automatically connect to the distributed system it
administers.
|
void |
setEmailNotificationEnabled(boolean enabled)
Deprecated.
Sets whether Emails for Notifications is enabled
See description above.
|
void |
setEmailNotificationFrom(String emailID)
Deprecated.
Sets the EmailID from whom notification emails are sent.
|
void |
setEmailNotificationHost(String hostName)
Deprecated.
Sets the Host Name from whom notification emails are sent.
|
void |
setEmailNotificationToList(String emailIDs)
Deprecated.
Sets the EmailID from whom notification emails are sent as a comma separated list.
|
void |
setHttpAuthEnabled(boolean enabled)
Deprecated.
Sets whether or not the HTTP adapter authenticates connections.
|
void |
setHttpAuthPassword(String password)
Deprecated.
Sets the password for HTTP adapter authentication.
|
void |
setHttpAuthUser(String user)
Deprecated.
Sets the user name for HTTP adapter authentication.
|
void |
setHttpBindAddress(String address)
Deprecated.
Sets the bind address to which the HTTP adapter's listening socket is bound.
|
void |
setHttpEnabled(boolean httpEnabled)
Deprecated.
Sets whether or not the HTTP adapter is enabled.
|
void |
setHttpPort(int port)
Deprecated.
Sets the port of the HTTP adapter.
|
void |
setHttpSSLRequireAuth(boolean require)
Deprecated.
Sets whether SSL authentication is used when connecting to the HTTP connector.
|
void |
setRmiBindAddress(String address)
Deprecated.
Sets the bind address to which the RMI adapter's listening sockets are bound.
|
void |
setRmiEnabled(boolean rmiEnabled)
Deprecated.
Sets whether or not the RMI adapter is enabled.
|
void |
setRmiPort(int port)
Deprecated.
Sets the port of the RMI adapter.
|
void |
setRmiRegistryEnabled(boolean enabled)
Deprecated.
Sets whether or not the agent hosts an RMI registry.
|
void |
setRmiServerPort(int port)
Deprecated.
Sets the port of the RMI Connector Server.
|
void |
setSnmpBindAddress(String address)
Deprecated.
Sets the bind address used with the SNMP adapter.
|
void |
setSnmpDirectory(String snmpDirectory)
Deprecated.
Sets the directory for the SNMP adapter.
|
void |
setSnmpEnabled(boolean enabled)
Deprecated.
Sets whether or not the SNMP adapter is enabled.
|
void |
setStateSaveFile(String file)
Deprecated.
Sets the name of the file to be used for saving agent state
See description above.
|
addListener, addSSLProperty, createCacheServerConfig, createCacheVmConfig, createDistributionLocatorConfig, getAckSevereAlertThreshold, getAckWaitThreshold, getBindAddress, getCacheServerConfigs, getCacheVmConfigs, getDisableAutoReconnect, getDisableJmx, getDisableTcp, getDistributionLocatorConfigs, getEnableNetworkPartitionDetection, getEntityConfigXMLFile, getLocators, getLogDiskSpaceLimit, getLogFile, getLogFileSizeLimit, getLogLevel, getMcastAddress, getMcastPort, getMembershipPortRange, getMemberTimeout, getRefreshInterval, getRemoteCommand, getServerBindAddress, getSSLCiphers, getSSLProperties, getSSLProtocols, getSystemId, getSystemName, getTcpPort, isSSLAuthenticationRequired, isSSLEnabled, removeCacheServerConfig, removeCacheVmConfig, removeDistributionLocatorConfig, removeListener, removeSSLProperty, setAckSevereAlertThreshold, setAckWaitThreshold, setBindAddress, setDisableAutoReconnect, setDisableJmx, setDisableTcp, setEnableNetworkPartitionDetection, setEntityConfigXMLFile, setLocators, setLogDiskSpaceLimit, setLogFile, setLogFileSizeLimit, setLogLevel, setMcastAddress, setMcastPort, setMembershipPortRange, setMemberTimeout, setRefreshInterval, setRemoteCommand, setServerBindAddress, setSSLAuthenticationRequired, setSSLCiphers, setSSLEnabled, setSSLProperties, setSSLProtocols, setSystemId, setSystemName, setTcpPort, validate
static final String SYSTEM_PROPERTY_PREFIX
static final String DEFAULT_PROPERTY_FILE
static final String DEFAULT_STATE_SAVE_FILE
static final String AUTO_CONNECT_NAME
static final boolean DEFAULT_AUTO_CONNECT
static final String HTTP_ENABLED_NAME
static final boolean DEFAULT_HTTP_ENABLED
static final String HTTP_BIND_ADDRESS_NAME
static final String DEFAULT_HTTP_BIND_ADDRESS
static final String HTTP_PORT_NAME
static final int DEFAULT_HTTP_PORT
static final int MIN_HTTP_PORT
static final int MAX_HTTP_PORT
static final String STATE_SAVE_FILE_NAME
static final String HTTP_AUTHENTICATION_ENABLED_NAME
static final boolean DEFAULT_HTTP_AUTHENTICATION_ENABLED
static final String HTTP_AUTHENTICATION_USER_NAME
static final String DEFAULT_HTTP_AUTHENTICATION_USER
static final String HTTP_AUTHENTICATION_PASSWORD_NAME
static final String DEFAULT_HTTP_AUTHENTICATION_PASSWORD
static final String EMAIL_NOTIFICATIONS_ENABLED_NAME
static final boolean DEFAULT_EMAIL_NOTIFICATIONS_ENABLED
static final String EMAIL_NOTIFICATIONS_FROM_NAME
static final String DEFAULT_EMAIL_FROM
static final String EMAIL_NOTIFICATIONS_HOST_NAME
static final String DEFAULT_EMAIL_HOST
static final String EMAIL_NOTIFICATIONS_TO_LIST_NAME
static final String DEFAULT_EMAIL_TO_LIST
static final String RMI_ENABLED_NAME
static final boolean DEFAULT_RMI_ENABLED
static final String RMI_REGISTRY_ENABLED_NAME
static final boolean DEFAULT_RMI_REGISTRY_ENABLED
static final String RMI_BIND_ADDRESS_NAME
static final String DEFAULT_RMI_BIND_ADDRESS
static final String RMI_PORT_NAME
static final int DEFAULT_RMI_PORT
static final String RMI_SERVER_PORT_NAME
static final int DEFAULT_RMI_SERVER_PORT
static final int MIN_RMI_PORT
static final int MAX_RMI_PORT
static final String SNMP_ENABLED_NAME
static final boolean DEFAULT_SNMP_ENABLED
static final String SNMP_BIND_ADDRESS_NAME
static final String DEFAULT_SNMP_BIND_ADDRESS
static final String SNMP_DIRECTORY_NAME
static final String DEFAULT_SNMP_DIRECTORY
static final String AGENT_SSL_ENABLED_NAME
static final boolean DEFAULT_AGENT_SSL_ENABLED
static final String AGENT_SSL_PROTOCOLS_NAME
static final String DEFAULT_AGENT_SSL_PROTOCOLS
static final String AGENT_SSL_CIPHERS_NAME
static final String DEFAULT_AGENT_SSL_CIPHERS
static final String AGENT_SSL_REQUIRE_AUTHENTICATION_NAME
static final boolean DEFAULT_AGENT_SSL_REQUIRE_AUTHENTICATION
static final String HTTP_SSL_REQUIRE_AUTHENTICATION_NAME
static final boolean DEFAULT_HTTP_SSL_REQUIRE_AUTHENTICATION
boolean getAutoConnect()
void setAutoConnect(boolean autoConnect)
autoConnect
- whether or not the JMX agent will automatically connect to the distributed
system it administersboolean isHttpEnabled()
void setHttpEnabled(boolean httpEnabled)
httpEnabled
- whether or not the HTTP adapter is enabledint getHttpPort()
void setHttpPort(int port)
port
- the port of the HTTP adapterString getHttpBindAddress()
void setHttpBindAddress(String address)
address
- the bind address to which the HTTP adapter's listening socket is boundboolean isHttpAuthEnabled()
void setHttpAuthEnabled(boolean enabled)
enabled
- whether or not the HTTP adapter authenticates connectionsString getHttpAuthUser()
void setHttpAuthUser(String user)
user
- the user name for HTTP adapter authenticationString getHttpAuthPassword()
void setHttpAuthPassword(String password)
password
- the password for HTTP adapter authenticationboolean isRmiEnabled()
void setRmiEnabled(boolean rmiEnabled)
rmiEnabled
- whether or not the RMI adapter is enabledboolean isRmiRegistryEnabled()
void setRmiRegistryEnabled(boolean enabled)
enabled
- whether or not the agent hosts an RMI registryint getRmiPort()
void setRmiPort(int port)
port
- the port of the RMI adapterint getRmiServerPort()
void setRmiServerPort(int port)
port
- rmi-server-port to set.String getRmiBindAddress()
void setRmiBindAddress(String address)
address
- the bind address to which the RMI adapter's listening sockets are boundboolean isSnmpEnabled()
void setSnmpEnabled(boolean enabled)
enabled
- whether or not the SNMP adapter is enabledString getSnmpBindAddress()
void setSnmpBindAddress(String address)
address
- the bind address used with the SNMP adapterString getSnmpDirectory()
void setSnmpDirectory(String snmpDirectory)
snmpDirectory
- the directory for the SNMP adapterboolean isAgentSSLEnabled()
void setAgentSSLEnabled(boolean enabled)
enabled
- whether or not SSL is required for the JMX agentString getAgentSSLProtocols()
void setAgentSSLProtocols(String protocols)
protocols
- the SSL protocols used when connecting to the JMX agentString getAgentSSLCiphers()
void setAgentSSLCiphers(String ciphers)
ciphers
- the SSL ciphers used when connecting to the JMX agentboolean isAgentSSLRequireAuth()
void setAgentSSLRequireAuth(boolean require)
require
- whether SSL authentication is used when connecting to the RMI connectorboolean isHttpSSLRequireAuth()
void setHttpSSLRequireAuth(boolean require)
require
- whether SSL authentication is used when connecting to the HTTP connectorboolean isEmailNotificationEnabled()
void setEmailNotificationEnabled(boolean enabled)
enabled
- whether Emails for Notifications is enabledString getEmailNotificationFrom()
void setEmailNotificationFrom(String emailID)
emailID
- the EmailID from whom notification emails are sentString getEmailNotificationHost()
void setEmailNotificationHost(String hostName)
hostName
- the Host Name from whom notification emails are sentString getEmailNotificationToList()
void setEmailNotificationToList(String emailIDs)
emailIDs
- the EmailID from whom notification emails are sent as a comma separated listString getStateSaveFile()
void setStateSaveFile(String file)
file
- the name of the file to be used for saving agent stateObject clone() throws CloneNotSupportedException
AgentConfig
with the same configuration as this
AgentConfig
.clone
in interface DistributedSystemConfig
DistributedSystemConfig
object whose configuration can be
modifiedCloneNotSupportedException
- if the object's class does not support the Cloneable
interface