management package insteadpublic interface Agent
Agent is created, it
registers an MBean that represents itself.
Click here for a
description of the attributes, operations, and notifications of
this and other GemFire JMX MBeans.
The GemFire JMX Agent currently supports three JMX "adapters"
through which clients can access the GemFire management beans: an
"HTTP adapter" that allows a web browser client to view and modify
management beans via HTTP or HTTPS, an "RMI adapter" that allows
Java programs to access management beans using Remote Method
Invocation, and an "SNMP adapter" that allows SNMP to access
management beans. Information about configuring these adapters can
be found in AgentConfig.
In most distributed caching architectures, JMX administration
agents are run in their own processes. A stand-alone JMX agent is
managed using the agent command line utility:
$ agent startThis class allows a GemFire application VM to host a JMX management agent. Architectures with "co-located" JMX agents reduce the number of overall proceses required. However, hosting a JMX management agent in the same VM as a GemFire application is not generally recommended because it adds extra burden to an application VM and in the event that the application VM exits the administration information will no longer be available.
AgentConfig,
AgentFactory| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
JNDI_NAME
Deprecated.
Lookup name for RMIConnector when rmi-registry-enabled is true
|
| Modifier and Type | Method and Description |
|---|---|
javax.management.ObjectName |
connectToSystem()
Deprecated.
Connects to the distributed system described by this
Agent's
configuration. |
void |
disconnectFromSystem()
Deprecated.
Disconnects this agent from the distributed system and
unregisters the management beans that provided information about
it.
|
AgentConfig |
getConfig()
Deprecated.
Returns the configuration object for this JMX Agent.
|
AdminDistributedSystem |
getDistributedSystem()
Deprecated.
Returns the
AdminDistributedSystem that underlies
this JMX Agent or null is this agent is
not connected. |
LogWriter |
getLogWriter()
Deprecated.
Returns the
LogWriter used for logging information. |
javax.management.MBeanServer |
getMBeanServer()
Deprecated.
Returns the JMX
MBeanServer with which GemFire
MBeans are registered or null if this
Agent is not started. |
javax.management.ObjectName |
getObjectName()
Deprecated.
Returns the
ObjectName of the JMX management bean
that represents this agent or null if this
Agent has not been started. |
boolean |
isConnected()
Deprecated.
Returns whether or not this JMX
Agent is currently
providing information about a distributed system. |
javax.management.ObjectName |
manageDistributedSystem()
Deprecated.
Returns the object name of the JMX MBean that represents the
distributed system administered by this
Agent or
null if this Agent has not connected to the distributed system. |
void |
saveProperties()
Deprecated.
Saves the configuration for this
Agent to the file
specified by @link AgentConfig#getPropertyFile. |
void |
start()
Deprecated.
Starts this JMX Agent and its associated adapters.
|
void |
stop()
Deprecated.
Disconnects from the
distributed system and stops this JMX Agent and all of its
associated adapters.
|
static final java.lang.String JNDI_NAME
AgentConfig getConfig()
void start()
javax.management.MBeanServer getMBeanServer()
MBeanServer with which GemFire
MBeans are registered or null if this
Agent is not started.void stop()
javax.management.ObjectName getObjectName()
ObjectName of the JMX management bean
that represents this agent or null if this
Agent has not been started.boolean isConnected()
Agent is currently
providing information about a distributed system.javax.management.ObjectName connectToSystem()
throws AdminException,
javax.management.MalformedObjectNameException
Agent's
configuration.Agent
is now connected to.AdminExceptionjavax.management.MalformedObjectNameExceptionAdminDistributedSystem getDistributedSystem()
AdminDistributedSystem that underlies
this JMX Agent or null is this agent is
not connected.javax.management.ObjectName manageDistributedSystem()
throws javax.management.MalformedObjectNameException
Agent or
null if this Agent has not connected to the distributed system.javax.management.MalformedObjectNameExceptionvoid disconnectFromSystem()
Agent to connect to
another distributed system.void saveProperties()
Agent to the file
specified by @link AgentConfig#getPropertyFile.LogWriter getLogWriter()
LogWriter used for logging information.