GemFire 6.6.2

com.gemstone.gemfire.admin.jmx
Interface AgentConfig

All Superinterfaces:
Cloneable, DistributedSystemConfig

public interface AgentConfig
extends DistributedSystemConfig

A configuration object for a JMX administration agent that is hosted by a GemFire application VM. A file named "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 Agents, a copy of the AgentConfig object can be made by invoking its clone() method.

JMX Administation Agent Configuration Properties

auto-connect
Description: whether or not a JMX agent will automatically connect to the distributed system it is configured to administer.
Default: false
JMX Agent SSL 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.

agent-ssl-enabled
Description: whether or not connections to the JMX agent require SSL
Default: false
agent-ssl-protocols
Description: the SSL protocols to be used when connecting to the JMX agent
Default: any
agent-ssl-ciphers
Description: the SSL ciphers to be used when connecting to the JMX agent
Default: any
agent-ssl-require-authentication
Description: whether or not SSL connections to the RMI adapter require authentication
Default: true
http-ssl-require-authentication
Description: whether or not SSL connections to the HTTP adapter require authentication
Default: false
HTTP Adapter Configuration
http-enabled
Description: whether or not the HTTP adapter is enabled in the JMX agent.
Default: true
http-port
Description: the port on which the HTTP adapter should listen for client connections.
Default: 8080
http-bind-address
Description: the machine name or IP address to which the HTTP listening socket should be bound. If this value is "localhost", then the socket will be bound to the loopback address (127.0.0.1) and the adapter will only be accessible via the URL http://localhost:8080.
Default: "" (all network addresses)
http-authentication-enabled
Description: Whether or not connections to the HTTP adapter should be authenticated with a user name and password.
Default: false
http-authentication-user
Description: the user name for authenticating secure communication.
Default: admin
http-authentication-password
Description: the password for authenticating secure communication.
Default: password
RMI Adapter Configuration Properties
rmi-enabled
Description: whether or not the RMI JMX adapter is enabled
Default: true
rmi-registry-enabled
Description: whether or not the JMX agent should start an RMI registry. Alternatively, a registry outside of the JMX agent VM can be used.
Default: true
rmi-port
Description: the port of the RMI registry in which the JMX Agent should bind remote objects.
Default: 1099
rmi-server-port
Description: the port to be used by the RMI Server started by JMX Agent.
Default: 0
rmi-bind-address
Description: the bind address on which the RMI registry binds its sockets.
Default: "" (all network addresses)
AdventNet SNMP Adapter Configuration Properties
snmp-enabled
Description: whether or not the SNMP JMX adapter is enabled
Default: false
snmp-bind-address
Description: the host name to which sockets used by the SNMP adapter should be bound.
Default: the name of the local machine (not localhost)
snmp-directory
Description: the deployment directory for AdventNet SNMP Adaptor
Default: ""
JMX Agent Email Notification Properties (for statistics alerts)
email-notification-enabled
Description: Whether or not email notifications are enabled for statistics alerts.
Default: false
email-notification-from
Description: Email address to be used to send email notifications.
Default: ""
email-notification-host
Description: The host name of the mail server to be used for email communication.
Default: ""
email-notification-to
Description: Email address where the email notifications should be sent.
Default: ""
state-save-file
Description: The name of the file to be used for saving agent state. The file is stored in the same directory in which the agent.properties file is located
Default: ""

Since:
4.0

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.gemstone.gemfire.admin.DistributedSystemConfig
DistributedSystemConfig.ConfigListener
 
Field Summary
static String AGENT_SSL_CIPHERS_NAME
          The name of the "agent-ssl-ciphers" property
static String AGENT_SSL_ENABLED_NAME
          The name of the "agent-ssl-enabled" property
static String AGENT_SSL_PROTOCOLS_NAME
          The name of the "agent-ssl-protocols" property
static String AGENT_SSL_REQUIRE_AUTHENTICATION_NAME
          The name of the "agent-ssl-require-authentication" property
static String AUTO_CONNECT_NAME
          The name of the "auto-connect" property
static String DEFAULT_AGENT_SSL_CIPHERS
          The default value of the "agent-ssl-ciphers" property
static boolean DEFAULT_AGENT_SSL_ENABLED
          The default value of the "agent-ssl-enabled" property
static String DEFAULT_AGENT_SSL_PROTOCOLS
          The default value of the "agent-ssl-protocols" property
static boolean DEFAULT_AGENT_SSL_REQUIRE_AUTHENTICATION
          The default value of the "agent-ssl-require-authentication" property
static boolean DEFAULT_AUTO_CONNECT
          The default value of the "auto-connect" property
static String DEFAULT_EMAIL_FROM
          The default value of the "email-notification-from" property
static String DEFAULT_EMAIL_HOST
          The default value of the "email-notification-host" property
static boolean DEFAULT_EMAIL_NOTIFICATIONS_ENABLED
          The default value of the "email-notification-enabled" property
static String DEFAULT_EMAIL_TO_LIST
          The default value of the "email-notification-to" property
static boolean DEFAULT_HTTP_AUTHENTICATION_ENABLED
          The default value of the "http-authentication-enabled" property
static String DEFAULT_HTTP_AUTHENTICATION_PASSWORD
          The default value of the "http-authentication-password" property
static String DEFAULT_HTTP_AUTHENTICATION_USER
          The default value of the "http-authentication-user" property
static String DEFAULT_HTTP_BIND_ADDRESS
          The default value of the "httpBindAddress" property
static boolean DEFAULT_HTTP_ENABLED
          The default value of the "httpEnabled" property
static int DEFAULT_HTTP_PORT
          The default value of the "httpPort" property (8080)
static boolean DEFAULT_HTTP_SSL_REQUIRE_AUTHENTICATION
          The default value of the "http-ssl-require-authentication" property
static String DEFAULT_PROPERTY_FILE
          The default "propertyFile" value
static String DEFAULT_RMI_BIND_ADDRESS
          The default value of the rmi-bind-address property
static boolean DEFAULT_RMI_ENABLED
          The default value of the rmi-enabled property
static int DEFAULT_RMI_PORT
          The default value of the rmi-port property (1099)
static boolean DEFAULT_RMI_REGISTRY_ENABLED
          The default value of the rmi-registry-enabled property
static int DEFAULT_RMI_SERVER_PORT
          The default value of the rmi-server-port property (0)
static String DEFAULT_SNMP_BIND_ADDRESS
          The default value of the "snmpBindAddress" property
static String DEFAULT_SNMP_DIRECTORY
          The default value of the "snmpDirectory" property
static boolean DEFAULT_SNMP_ENABLED
          The default value of the "snmpEnabled" property
static String DEFAULT_STATE_SAVE_FILE
          The default name for file that has "agent state saved serialized"
static String EMAIL_NOTIFICATIONS_ENABLED_NAME
          The name of the "email-notification-enabled" property
static String EMAIL_NOTIFICATIONS_FROM_NAME
          The name of the "email-notification-from" property
static String EMAIL_NOTIFICATIONS_HOST_NAME
          The name of the "email-notification-host" property
static String EMAIL_NOTIFICATIONS_TO_LIST_NAME
          The name of the "email-notification-to" property
static String HTTP_AUTHENTICATION_ENABLED_NAME
          The name of the "http-authentication-enabled" property
static String HTTP_AUTHENTICATION_PASSWORD_NAME
          The name of the "http-authentication-password" property
static String HTTP_AUTHENTICATION_USER_NAME
          The name of the "http-authentication-user" property
static String HTTP_BIND_ADDRESS_NAME
          The name of the "httpBindAddress" property
static String HTTP_ENABLED_NAME
          The name of the "httpEnabled" property
static String HTTP_PORT_NAME
          The name of the "httpPort" property
static String HTTP_SSL_REQUIRE_AUTHENTICATION_NAME
          The name of the "http-ssl-require-authentication" property
static int MAX_HTTP_PORT
          The maximum httpPort (65535)
static int MAX_RMI_PORT
          The maximum value for rmi-port or rmi-server-port (65535)
static int MIN_HTTP_PORT
          The minimum httpPort (0)
static int MIN_RMI_PORT
          The minimum value for rmi-port or rmi-server-port (0)
static String RMI_BIND_ADDRESS_NAME
          The name of the "rmiBindAddress" property
static String RMI_ENABLED_NAME
          The name of the "rmiEnabled" property
static String RMI_PORT_NAME
          The name of the "rmiPort" property
static String RMI_REGISTRY_ENABLED_NAME
          The name of the "rmi-registry-enabled" property
static String RMI_SERVER_PORT_NAME
          The name of the "rmi-server-port" property
static String SNMP_BIND_ADDRESS_NAME
          The name of the "snmpBindAddress" property
static String SNMP_DIRECTORY_NAME
          The name of the "snmpDirectory" property
static String SNMP_ENABLED_NAME
          The name of the "snmpEnabled" property
static String STATE_SAVE_FILE_NAME
          The name of the "state-save-file-name" property
static String SYSTEM_PROPERTY_PREFIX
          The prefix for JMX Agent configuration system properties
 
Fields inherited from interface com.gemstone.gemfire.admin.DistributedSystemConfig
BIND_ADDRESS_NAME, DEFAULT_ACK_SEVERE_ALERT_THRESHOLD, DEFAULT_ACK_WAIT_THRESHOLD, DEFAULT_BIND_ADDRESS, DEFAULT_DEPARTURE_CORRELATION_WINDOW, 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_SSL_CIPHERS, DEFAULT_SSL_ENABLED, DEFAULT_SSL_PROTOCOLS, DEFAULT_SSL_REQUIRE_AUTHENTICATION, 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, SSL_CIPHERS_NAME, SSL_ENABLED_NAME, SSL_PROTOCOLS_NAME, SSL_REQUIRE_AUTHENTICATION_NAME, SYSTEM_ID_NAME, TCP_PORT_NAME
 
Method Summary
 Object clone()
          Returns an AgentConfig with the same configuration as this AgentConfig.
 String getAgentSSLCiphers()
          Returns the SSL ciphers used when connecting to the JMX agent.
 String getAgentSSLProtocols()
          Returns the SSL protocols used when connecting to the JMX agent.
 boolean getAutoConnect()
          Returns whether or not the JMX agent will automatically connect to the distributed system it administers.
 String getEmailNotificationFrom()
          Returns the EmailID from whom notification emails are sent.
 String getEmailNotificationHost()
          Returns the Host Name using which notification emails are sent.
 String getEmailNotificationToList()
          Returns the comma separated EmailID list to whom notification emails are sent.
 String getHttpAuthPassword()
          Returns the password for HTTP adapter authentication.
 String getHttpAuthUser()
          Returns the user name for HTTP adapter authentication.
 String getHttpBindAddress()
          Returns the bind address to which the HTTP adapter's listening socket is bound.
 int getHttpPort()
          Returns the port of the HTTP adapter.
 String getRmiBindAddress()
          Returns the bind address to which the RMI adapter's listening sockets are bound.
 int getRmiPort()
          Returns the port of the RMI adapter.
 int getRmiServerPort()
          Returns the port of the RMI Connector Server.
 String getSnmpBindAddress()
          Returns the bind address used with the SNMP adapter.
 String getSnmpDirectory()
          Returns the directory for the SNMP adapater.
 String getStateSaveFile()
          Returns the name of the file to be used for saving agent state See description above.
 boolean isAgentSSLEnabled()
          Returns whether or not SSL is required for the JMX agent.
 boolean isAgentSSLRequireAuth()
          Returns whether SSL authentication is used when connecting to the RMI connector.
 boolean isEmailNotificationEnabled()
          Returns whether Emails for Notifications is enabled See description above.
 boolean isHttpAuthEnabled()
          Returns whether or not the HTTP adapter authenticates connections.
 boolean isHttpEnabled()
          Returns whether or not the HTTP adapter is enabled.
 boolean isHttpSSLRequireAuth()
          Returns whether SSL authentication is used when connecting to the HTTP connector.
 boolean isRmiEnabled()
          Returns whether or not the RMI adapter is enabled.
 boolean isRmiRegistryEnabled()
          Returns whether or not the agent hosts an RMI registry.
 boolean isSnmpEnabled()
          Returns whether or not the SNMP adapter is enabled.
 void setAgentSSLCiphers(String ciphers)
          Sets the SSL ciphers used when connecting to the JMX agent.
 void setAgentSSLEnabled(boolean enabled)
          Sets whether or not SSL is required for the JMX agent.
 void setAgentSSLProtocols(String protocols)
          Sets the SSL protocols used when connecting to the JMX agent.
 void setAgentSSLRequireAuth(boolean require)
          Sets whether SSL authentication is used when connecting to the RMI connector.
 void setAutoConnect(boolean autoConnect)
          Sets whether or not the JMX agent will automatically connect to the distributed system it administers.
 void setEmailNotificationEnabled(boolean enabled)
          Sets whether Emails for Notifications is enabled See description above.
 void setEmailNotificationFrom(String emailID)
          Sets the EmailID from whom notification emails are sent.
 void setEmailNotificationHost(String hostName)
          Sets the Host Name from whom notification emails are sent.
 void setEmailNotificationToList(String emailIDs)
          Sets the EmailID from whom notification emails are sent as a comma separated list.
 void setHttpAuthEnabled(boolean enabled)
          Sets whether or not the HTTP adapter authenticates connections.
 void setHttpAuthPassword(String password)
          Sets the password for HTTP adapter authentication.
 void setHttpAuthUser(String user)
          Sets the user name for HTTP adapter authentication.
 void setHttpBindAddress(String address)
          Sets the bind address to which the HTTP adapter's listening socket is bound.
 void setHttpEnabled(boolean httpEnabled)
          Sets whether or not the HTTP adapter is enabled.
 void setHttpPort(int port)
          Sets the port of the HTTP adapter.
 void setHttpSSLRequireAuth(boolean require)
          Sets whether SSL authentication is used when connecting to the HTTP connector.
 void setRmiBindAddress(String address)
          Sets the bind address to which the RMI adapter's listening sockets are bound.
 void setRmiEnabled(boolean rmiEnabled)
          Sets whether or not the RMI adapter is enabled.
 void setRmiPort(int port)
          Sets the port of the RMI adapter.
 void setRmiRegistryEnabled(boolean enabled)
          Sets whether or not the agent hosts an RMI registry.
 void setRmiServerPort(int port)
          Sets the port of the RMI Connector Server.
 void setSnmpBindAddress(String address)
          Sets the bind address used with the SNMP adapter.
 void setSnmpDirectory(String snmpDirectory)
          Sets the directory for the SNMP adapater.
 void setSnmpEnabled(boolean enabled)
          Sets whether or not the SNMP adapter is enabled.
 void setStateSaveFile(String file)
          Sets the name of the file to be used for saving agent state See description above.
 
Methods inherited from interface com.gemstone.gemfire.admin.DistributedSystemConfig
addListener, addSSLProperty, createCacheServerConfig, createCacheVmConfig, createDistributionLocatorConfig, getAckSevereAlertThreshold, getAckWaitThreshold, getBindAddress, getCacheServerConfigs, getCacheVmConfigs, getDepartureCorrelationWindow, 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, setDepartureCorrelationWindow, setDisableTcp, setEnableNetworkPartitionDetection, setEntityConfigXMLFile, setLocators, setLogDiskSpaceLimit, setLogFile, setLogFileSizeLimit, setLogLevel, setMcastAddress, setMcastPort, setMembershipPortRange, setMemberTimeout, setRefreshInterval, setRemoteCommand, setServerBindAddress, setSSLAuthenticationRequired, setSSLCiphers, setSSLEnabled, setSSLProperties, setSSLProtocols, setSystemId, setSystemName, setTcpPort, validate
 

Field Detail

SYSTEM_PROPERTY_PREFIX

static final String SYSTEM_PROPERTY_PREFIX
The prefix for JMX Agent configuration system properties

See Also:
Constant Field Values

DEFAULT_PROPERTY_FILE

static final String DEFAULT_PROPERTY_FILE
The default "propertyFile" value

See Also:
Constant Field Values

DEFAULT_STATE_SAVE_FILE

static final String DEFAULT_STATE_SAVE_FILE
The default name for file that has "agent state saved serialized"

See Also:
Constant Field Values

AUTO_CONNECT_NAME

static final String AUTO_CONNECT_NAME
The name of the "auto-connect" property

See Also:
Constant Field Values

DEFAULT_AUTO_CONNECT

static final boolean DEFAULT_AUTO_CONNECT
The default value of the "auto-connect" property

See Also:
Constant Field Values

HTTP_ENABLED_NAME

static final String HTTP_ENABLED_NAME
The name of the "httpEnabled" property

See Also:
Constant Field Values

DEFAULT_HTTP_ENABLED

static final boolean DEFAULT_HTTP_ENABLED
The default value of the "httpEnabled" property

See Also:
Constant Field Values

HTTP_BIND_ADDRESS_NAME

static final String HTTP_BIND_ADDRESS_NAME
The name of the "httpBindAddress" property

See Also:
Constant Field Values

DEFAULT_HTTP_BIND_ADDRESS

static final String DEFAULT_HTTP_BIND_ADDRESS
The default value of the "httpBindAddress" property

See Also:
Constant Field Values

HTTP_PORT_NAME

static final String HTTP_PORT_NAME
The name of the "httpPort" property

See Also:
Constant Field Values

DEFAULT_HTTP_PORT

static final int DEFAULT_HTTP_PORT
The default value of the "httpPort" property (8080)

See Also:
Constant Field Values

MIN_HTTP_PORT

static final int MIN_HTTP_PORT
The minimum httpPort (0)

See Also:
Constant Field Values

MAX_HTTP_PORT

static final int MAX_HTTP_PORT
The maximum httpPort (65535)

See Also:
Constant Field Values

STATE_SAVE_FILE_NAME

static final String STATE_SAVE_FILE_NAME
The name of the "state-save-file-name" property

See Also:
Constant Field Values

HTTP_AUTHENTICATION_ENABLED_NAME

static final String HTTP_AUTHENTICATION_ENABLED_NAME
The name of the "http-authentication-enabled" property

See Also:
Constant Field Values

DEFAULT_HTTP_AUTHENTICATION_ENABLED

static final boolean DEFAULT_HTTP_AUTHENTICATION_ENABLED
The default value of the "http-authentication-enabled" property

See Also:
Constant Field Values

HTTP_AUTHENTICATION_USER_NAME

static final String HTTP_AUTHENTICATION_USER_NAME
The name of the "http-authentication-user" property

See Also:
Constant Field Values

DEFAULT_HTTP_AUTHENTICATION_USER

static final String DEFAULT_HTTP_AUTHENTICATION_USER
The default value of the "http-authentication-user" property

See Also:
Constant Field Values

HTTP_AUTHENTICATION_PASSWORD_NAME

static final String HTTP_AUTHENTICATION_PASSWORD_NAME
The name of the "http-authentication-password" property

See Also:
Constant Field Values

DEFAULT_HTTP_AUTHENTICATION_PASSWORD

static final String DEFAULT_HTTP_AUTHENTICATION_PASSWORD
The default value of the "http-authentication-password" property

See Also:
Constant Field Values

EMAIL_NOTIFICATIONS_ENABLED_NAME

static final String EMAIL_NOTIFICATIONS_ENABLED_NAME
The name of the "email-notification-enabled" property

See Also:
Constant Field Values

DEFAULT_EMAIL_NOTIFICATIONS_ENABLED

static final boolean DEFAULT_EMAIL_NOTIFICATIONS_ENABLED
The default value of the "email-notification-enabled" property

See Also:
Constant Field Values

EMAIL_NOTIFICATIONS_FROM_NAME

static final String EMAIL_NOTIFICATIONS_FROM_NAME
The name of the "email-notification-from" property

See Also:
Constant Field Values

DEFAULT_EMAIL_FROM

static final String DEFAULT_EMAIL_FROM
The default value of the "email-notification-from" property

See Also:
Constant Field Values

EMAIL_NOTIFICATIONS_HOST_NAME

static final String EMAIL_NOTIFICATIONS_HOST_NAME
The name of the "email-notification-host" property

See Also:
Constant Field Values

DEFAULT_EMAIL_HOST

static final String DEFAULT_EMAIL_HOST
The default value of the "email-notification-host" property

See Also:
Constant Field Values

EMAIL_NOTIFICATIONS_TO_LIST_NAME

static final String EMAIL_NOTIFICATIONS_TO_LIST_NAME
The name of the "email-notification-to" property

See Also:
Constant Field Values

DEFAULT_EMAIL_TO_LIST

static final String DEFAULT_EMAIL_TO_LIST
The default value of the "email-notification-to" property

See Also:
Constant Field Values

RMI_ENABLED_NAME

static final String RMI_ENABLED_NAME
The name of the "rmiEnabled" property

See Also:
Constant Field Values

DEFAULT_RMI_ENABLED

static final boolean DEFAULT_RMI_ENABLED
The default value of the rmi-enabled property

See Also:
Constant Field Values

RMI_REGISTRY_ENABLED_NAME

static final String RMI_REGISTRY_ENABLED_NAME
The name of the "rmi-registry-enabled" property

See Also:
Constant Field Values

DEFAULT_RMI_REGISTRY_ENABLED

static final boolean DEFAULT_RMI_REGISTRY_ENABLED
The default value of the rmi-registry-enabled property

See Also:
Constant Field Values

RMI_BIND_ADDRESS_NAME

static final String RMI_BIND_ADDRESS_NAME
The name of the "rmiBindAddress" property

See Also:
Constant Field Values

DEFAULT_RMI_BIND_ADDRESS

static final String DEFAULT_RMI_BIND_ADDRESS
The default value of the rmi-bind-address property

See Also:
Constant Field Values

RMI_PORT_NAME

static final String RMI_PORT_NAME
The name of the "rmiPort" property

See Also:
Constant Field Values

DEFAULT_RMI_PORT

static final int DEFAULT_RMI_PORT
The default value of the rmi-port property (1099)

See Also:
Constant Field Values

RMI_SERVER_PORT_NAME

static final String RMI_SERVER_PORT_NAME
The name of the "rmi-server-port" property

Since:
6.5
See Also:
Constant Field Values

DEFAULT_RMI_SERVER_PORT

static final int DEFAULT_RMI_SERVER_PORT
The default value of the rmi-server-port property (0)

Since:
6.5
See Also:
Constant Field Values

MIN_RMI_PORT

static final int MIN_RMI_PORT
The minimum value for rmi-port or rmi-server-port (0)

See Also:
Constant Field Values

MAX_RMI_PORT

static final int MAX_RMI_PORT
The maximum value for rmi-port or rmi-server-port (65535)

See Also:
Constant Field Values

SNMP_ENABLED_NAME

static final String SNMP_ENABLED_NAME
The name of the "snmpEnabled" property

See Also:
Constant Field Values

DEFAULT_SNMP_ENABLED

static final boolean DEFAULT_SNMP_ENABLED
The default value of the "snmpEnabled" property

See Also:
Constant Field Values

SNMP_BIND_ADDRESS_NAME

static final String SNMP_BIND_ADDRESS_NAME
The name of the "snmpBindAddress" property

See Also:
Constant Field Values

DEFAULT_SNMP_BIND_ADDRESS

static final String DEFAULT_SNMP_BIND_ADDRESS
The default value of the "snmpBindAddress" property

See Also:
Constant Field Values

SNMP_DIRECTORY_NAME

static final String SNMP_DIRECTORY_NAME
The name of the "snmpDirectory" property

See Also:
Constant Field Values

DEFAULT_SNMP_DIRECTORY

static final String DEFAULT_SNMP_DIRECTORY
The default value of the "snmpDirectory" property

See Also:
Constant Field Values

AGENT_SSL_ENABLED_NAME

static final String AGENT_SSL_ENABLED_NAME
The name of the "agent-ssl-enabled" property

See Also:
Constant Field Values

DEFAULT_AGENT_SSL_ENABLED

static final boolean DEFAULT_AGENT_SSL_ENABLED
The default value of the "agent-ssl-enabled" property

See Also:
Constant Field Values

AGENT_SSL_PROTOCOLS_NAME

static final String AGENT_SSL_PROTOCOLS_NAME
The name of the "agent-ssl-protocols" property

See Also:
Constant Field Values

DEFAULT_AGENT_SSL_PROTOCOLS

static final String DEFAULT_AGENT_SSL_PROTOCOLS
The default value of the "agent-ssl-protocols" property

See Also:
Constant Field Values

AGENT_SSL_CIPHERS_NAME

static final String AGENT_SSL_CIPHERS_NAME
The name of the "agent-ssl-ciphers" property

See Also:
Constant Field Values

DEFAULT_AGENT_SSL_CIPHERS

static final String DEFAULT_AGENT_SSL_CIPHERS
The default value of the "agent-ssl-ciphers" property

See Also:
Constant Field Values

AGENT_SSL_REQUIRE_AUTHENTICATION_NAME

static final String AGENT_SSL_REQUIRE_AUTHENTICATION_NAME
The name of the "agent-ssl-require-authentication" property

See Also:
Constant Field Values

DEFAULT_AGENT_SSL_REQUIRE_AUTHENTICATION

static final boolean DEFAULT_AGENT_SSL_REQUIRE_AUTHENTICATION
The default value of the "agent-ssl-require-authentication" property

See Also:
Constant Field Values

HTTP_SSL_REQUIRE_AUTHENTICATION_NAME

static final String HTTP_SSL_REQUIRE_AUTHENTICATION_NAME
The name of the "http-ssl-require-authentication" property

See Also:
Constant Field Values

DEFAULT_HTTP_SSL_REQUIRE_AUTHENTICATION

static final boolean DEFAULT_HTTP_SSL_REQUIRE_AUTHENTICATION
The default value of the "http-ssl-require-authentication" property

See Also:
Constant Field Values
Method Detail

getAutoConnect

boolean getAutoConnect()
Returns whether or not the JMX agent will automatically connect to the distributed system it administers. See description above.


setAutoConnect

void setAutoConnect(boolean autoConnect)
Sets whether or not the JMX agent will automatically connect to the distributed system it administers. See description above.


isHttpEnabled

boolean isHttpEnabled()
Returns whether or not the HTTP adapter is enabled. See description above.


setHttpEnabled

void setHttpEnabled(boolean httpEnabled)
Sets whether or not the HTTP adapter is enabled. See description above.


getHttpPort

int getHttpPort()
Returns the port of the HTTP adapter. See description above.


setHttpPort

void setHttpPort(int port)
Sets the port of the HTTP adapter. See description above.


getHttpBindAddress

String getHttpBindAddress()
Returns the bind address to which the HTTP adapter's listening socket is bound. See description above.


setHttpBindAddress

void setHttpBindAddress(String address)
Sets the bind address to which the HTTP adapter's listening socket is bound. See description above.


isHttpAuthEnabled

boolean isHttpAuthEnabled()
Returns whether or not the HTTP adapter authenticates connections. See description above.


setHttpAuthEnabled

void setHttpAuthEnabled(boolean enabled)
Sets whether or not the HTTP adapter authenticates connections. See description above.


getHttpAuthUser

String getHttpAuthUser()
Returns the user name for HTTP adapter authentication. See description above.


setHttpAuthUser

void setHttpAuthUser(String user)
Sets the user name for HTTP adapter authentication. See description above.


getHttpAuthPassword

String getHttpAuthPassword()
Returns the password for HTTP adapter authentication. See description above.


setHttpAuthPassword

void setHttpAuthPassword(String password)
Sets the password for HTTP adapter authentication. See description above.


isRmiEnabled

boolean isRmiEnabled()
Returns whether or not the RMI adapter is enabled. See description above.


setRmiEnabled

void setRmiEnabled(boolean rmiEnabled)
Sets whether or not the RMI adapter is enabled. See description above.


isRmiRegistryEnabled

boolean isRmiRegistryEnabled()
Returns whether or not the agent hosts an RMI registry. See description above.


setRmiRegistryEnabled

void setRmiRegistryEnabled(boolean enabled)
Sets whether or not the agent hosts an RMI registry. See description above.


getRmiPort

int getRmiPort()
Returns the port of the RMI adapter. See description above.


setRmiPort

void setRmiPort(int port)
Sets the port of the RMI adapter. See description above.


getRmiServerPort

int getRmiServerPort()
Returns the port of the RMI Connector Server. See description above.

Returns:
the value set for rmi-server-port
Since:
6.5

setRmiServerPort

void setRmiServerPort(int port)
Sets the port of the RMI Connector Server. See description above.

Parameters:
port - rmi-server-port to set.
Since:
6.5

getRmiBindAddress

String getRmiBindAddress()
Returns the bind address to which the RMI adapter's listening sockets are bound. See description above.


setRmiBindAddress

void setRmiBindAddress(String address)
Sets the bind address to which the RMI adapter's listening sockets are bound. See description above.


isSnmpEnabled

boolean isSnmpEnabled()
Returns whether or not the SNMP adapter is enabled. See description above.


setSnmpEnabled

void setSnmpEnabled(boolean enabled)
Sets whether or not the SNMP adapter is enabled. See description above.


getSnmpBindAddress

String getSnmpBindAddress()
Returns the bind address used with the SNMP adapter. See description above.


setSnmpBindAddress

void setSnmpBindAddress(String address)
Sets the bind address used with the SNMP adapter. See description above.


getSnmpDirectory

String getSnmpDirectory()
Returns the directory for the SNMP adapater. See description above.


setSnmpDirectory

void setSnmpDirectory(String snmpDirectory)
Sets the directory for the SNMP adapater. See description above.


isAgentSSLEnabled

boolean isAgentSSLEnabled()
Returns whether or not SSL is required for the JMX agent. See description above.


setAgentSSLEnabled

void setAgentSSLEnabled(boolean enabled)
Sets whether or not SSL is required for the JMX agent. See description above.


getAgentSSLProtocols

String getAgentSSLProtocols()
Returns the SSL protocols used when connecting to the JMX agent. See description above.


setAgentSSLProtocols

void setAgentSSLProtocols(String protocols)
Sets the SSL protocols used when connecting to the JMX agent. See description above.


getAgentSSLCiphers

String getAgentSSLCiphers()
Returns the SSL ciphers used when connecting to the JMX agent. See description above.


setAgentSSLCiphers

void setAgentSSLCiphers(String ciphers)
Sets the SSL ciphers used when connecting to the JMX agent. See description above.


isAgentSSLRequireAuth

boolean isAgentSSLRequireAuth()
Returns whether SSL authentication is used when connecting to the RMI connector. See description above.


setAgentSSLRequireAuth

void setAgentSSLRequireAuth(boolean require)
Sets whether SSL authentication is used when connecting to the RMI connector. See description above.


isHttpSSLRequireAuth

boolean isHttpSSLRequireAuth()
Returns whether SSL authentication is used when connecting to the HTTP connector. See description above.


setHttpSSLRequireAuth

void setHttpSSLRequireAuth(boolean require)
Sets whether SSL authentication is used when connecting to the HTTP connector. See description above.


isEmailNotificationEnabled

boolean isEmailNotificationEnabled()
Returns whether Emails for Notifications is enabled See description above.


setEmailNotificationEnabled

void setEmailNotificationEnabled(boolean enabled)
Sets whether Emails for Notifications is enabled See description above.


getEmailNotificationFrom

String getEmailNotificationFrom()
Returns the EmailID from whom notification emails are sent. See description above.


setEmailNotificationFrom

void setEmailNotificationFrom(String emailID)
Sets the EmailID from whom notification emails are sent. See description above.


getEmailNotificationHost

String getEmailNotificationHost()
Returns the Host Name using which notification emails are sent. See description above.


setEmailNotificationHost

void setEmailNotificationHost(String hostName)
Sets the Host Name from whom notification emails are sent. See description above.


getEmailNotificationToList

String getEmailNotificationToList()
Returns the comma separated EmailID list to whom notification emails are sent. See description above.


setEmailNotificationToList

void setEmailNotificationToList(String emailIDs)
Sets the EmailID from whom notification emails are sent as a comma separated list. See description above.


getStateSaveFile

String getStateSaveFile()
Returns the name of the file to be used for saving agent state See description above.


setStateSaveFile

void setStateSaveFile(String file)
Sets the name of the file to be used for saving agent state See description above.


clone

Object clone()
             throws CloneNotSupportedException
Returns an AgentConfig with the same configuration as this AgentConfig.

Specified by:
clone in interface DistributedSystemConfig
Throws:
CloneNotSupportedException

GemFire 6.6.2

Copyright © 1997-2012 VMware, Inc. All rights reserved.