hydra

Class AgentHelper

java.lang.Object

hydra.AgentHelper

public class AgentHelper
extends Object

Provides support for management agents running in hydra client VMs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentHelper.Endpoint Represents the endpoint for an agent.

Constructor Summary

Constructors

Constructor and Description
AgentHelper()

Method Summary

Modifier and Type	Method and Description
static String	agentToString(com.gemstone.gemfire.admin.jmx.Agent agent) Returns the given agent as a string.
static com.gemstone.gemfire.admin.jmx.Agent	connectAgent() Connects the agent whose endpoint was created by createAgent(java.lang.String) to an admin distributed system, if it is not already connected, but does not start it.
static com.gemstone.gemfire.admin.jmx.Agent	createAgent(String agentConfig) Creates an unstarted and unconnected agent.
static void	disconnectAgent() Disconnects the agent if it is connected, leaving the adaptors running.
static com.gemstone.gemfire.admin.jmx.Agent	getAgent() Returns the current agent if it is created, otherwise null.
static AgentDescription	getAgentDescription(String agentConfig) Returns the AgentDescription with the given configuration name from AgentPrms.names.
static List	getEndpoints() Returns all agent endpoints from the AgentBlackboard map, a possibly empty list.
static com.gemstone.gemfire.admin.jmx.Agent	startAgent() Starts the agent whose endpoint was created by createAgent(java.lang.String), if it is not already started.
static com.gemstone.gemfire.admin.jmx.Agent	startConnectedAgent(String agentConfig) Creates, starts, and connects an agent using the given agent configuration.
static void	stopAgent() Stops the agent, if it is running.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgentHelper

public AgentHelper()

Method Detail

startConnectedAgent

public static com.gemstone.gemfire.admin.jmx.Agent startConnectedAgent(String agentConfig)

Creates, starts, and connects an agent using the given agent configuration.

See Also:

createAgent(String), startAgent(), connectAgent()

createAgent

public static com.gemstone.gemfire.admin.jmx.Agent createAgent(String agentConfig)

Creates an unstarted and unconnected agent. The agent is configured using the AgentDescription corresponding to the given agent configuration from AgentPrms.names.

Upon initial creation, selects a random port and registers the AgentHelper.Endpoint in the AgentBlackboard map for use by tools. Starts of any agent in this VM will always use this port.

To make modifications before connecting, invoke getConfig()/code> to get the AgentConfig and invoke its mutator methods.

To start the agent, use startAgent(). To connect it, use connectAgent().

Throws:

HydraRuntimeException - if an attempt is made to reconfigure an existing agent or there is an exception when creating it.

getAgent

public static com.gemstone.gemfire.admin.jmx.Agent getAgent()

Returns the current agent if it is created, otherwise null. Note that the agent might not be connected or started.

startAgent

public static com.gemstone.gemfire.admin.jmx.Agent startAgent()

Starts the agent whose endpoint was created by createAgent(java.lang.String), if it is not already started. This starts the adaptors but does not connect it to a distributed system. Use connectAgent() to connect the agent.

stopAgent

public static void stopAgent()

Stops the agent, if it is running. This stops the adaptors and disconnects the agent from the distributed system.

connectAgent

public static com.gemstone.gemfire.admin.jmx.Agent connectAgent()

Connects the agent whose endpoint was created by createAgent(java.lang.String) to an admin distributed system, if it is not already connected, but does not start it. To start the agent, use startAgent().

Throws:

HydraRuntimeException - if the agent has not been created or an exception occurs when connecting it.

disconnectAgent

public static void disconnectAgent()

Disconnects the agent if it is connected, leaving the adaptors running. To stop the adaptors, use stopAgent().

agentToString

public static String agentToString(com.gemstone.gemfire.admin.jmx.Agent agent)

Returns the given agent as a string.

getAgentDescription

public static AgentDescription getAgentDescription(String agentConfig)

Returns the AgentDescription with the given configuration name from AgentPrms.names.

getEndpoints

public static List getEndpoints()

Returns all agent endpoints from the AgentBlackboard map, a possibly empty list. This includes all agents that have ever been created, regardless of their current status.