org.mule.management.agents
Class DefaultJmxSupportAgent

java.lang.Object
  extended by org.mule.management.agents.DefaultJmxSupportAgent
All Implemented Interfaces:
Disposable, Initialisable, Lifecycle, Startable, Stoppable, UMOAgent

public class DefaultJmxSupportAgent
extends Object
implements UMOAgent

TODO document.


Field Summary
static String DEFAULT_HOST
           
static String DEFAULT_PORT
           
 
Constructor Summary
DefaultJmxSupportAgent()
           
 
Method Summary
protected  JdmkAgent createJdmkAgent()
           
protected  JmxAgent createJmxAgent()
           
protected  JmxServerNotificationAgent createJmxNotificationAgent()
           
protected  Log4jAgent createLog4jAgent()
           
protected  Mx4jAgent createMx4jAgent()
           
protected  YourKitProfilerAgent createProfilerAgent()
           
protected  RmiRegistryAgent createRmiAgent()
           
 void dispose()
          A lifecycle method where implementor should free up any resources.
 String getDescription()
          Should be a 1 line description of the agent
 String getHost()
          Getter for property 'host'.
 String getName()
          Gets the name of this agent
 String getPort()
          Getter for property 'port'.
 void initialise()
          Method used to perform any initialisation work.
protected  boolean isAgentRegistered(UMOAgent agent)
           
 boolean isLoadJdmkAgent()
          Getter for property 'loadJdmkAgent'.
 boolean isLoadMx4jAgent()
          Getter for property 'loadMx4jAgent'.
 boolean isLoadProfilerAgent()
          Getter for property 'loadProfilerAgent'.
 void registered()
          
 void setCredentials(Map credentials)
          Setter for property 'credentials'.
 void setHost(String host)
          Setter for property 'host'.
 void setLoadJdmkAgent(boolean loadJdmkAgent)
          Setter for property 'loadJdmkAgent'.
 void setLoadMx4jAgent(boolean loadMx4jAgent)
          Setter for property 'loadMx4jAgent'.
 void setLoadProfilerAgent(boolean loadProfilerAgent)
          Setter for property 'loadProfilerAgent'.
 void setName(String name)
          Sets the name of this agent
 void setPort(String port)
          Setter for property 'port'.
 void start()
          
 void stop()
          
 void unregistered()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST
See Also:
Constant Field Values

DEFAULT_PORT

public static final String DEFAULT_PORT
See Also:
Constant Field Values
Constructor Detail

DefaultJmxSupportAgent

public DefaultJmxSupportAgent()
Method Detail

getName

public String getName()
Gets the name of this agent

Specified by:
getName in interface UMOAgent
Returns:
the agent name

setName

public void setName(String name)
Sets the name of this agent

Specified by:
setName in interface UMOAgent
Parameters:
name - the name of the agent

getDescription

public String getDescription()
Should be a 1 line description of the agent

Specified by:
getDescription in interface UMOAgent
Returns:
agent description

registered

public void registered()

Specified by:
registered in interface UMOAgent

unregistered

public void unregistered()

Specified by:
unregistered in interface UMOAgent

start

public void start()
           throws UMOException

Specified by:
start in interface Startable
Throws:
UMOException

stop

public void stop()
          throws UMOException

Specified by:
stop in interface Stoppable
Throws:
UMOException

dispose

public void dispose()
A lifecycle method where implementor should free up any resources. If an exception is thrown it should just be logged and processing should continue. This method should not throw Runtime exceptions.

Specified by:
dispose in interface Disposable

initialise

public void initialise()
                throws InitialisationException
Method used to perform any initialisation work. If a fatal error occurs during initialisation an InitialisationException should be thrown, causing the Mule instance to shutdown. If the error is recoverable, say by retrying to connect, a RecoverableException should be thrown. There is no guarantee that by throwing a Recoverable exception that the Mule instance will not shut down.

Specified by:
initialise in interface Initialisable
Throws:
InitialisationException - if a fatal error occurs causing the Mule instance to shutdown
RecoverableException - if an error occurs that can be recovered from

createJmxAgent

protected JmxAgent createJmxAgent()

createLog4jAgent

protected Log4jAgent createLog4jAgent()

createRmiAgent

protected RmiRegistryAgent createRmiAgent()

createJmxNotificationAgent

protected JmxServerNotificationAgent createJmxNotificationAgent()

createMx4jAgent

protected Mx4jAgent createMx4jAgent()

createJdmkAgent

protected JdmkAgent createJdmkAgent()

createProfilerAgent

protected YourKitProfilerAgent createProfilerAgent()

isAgentRegistered

protected boolean isAgentRegistered(UMOAgent agent)

isLoadJdmkAgent

public boolean isLoadJdmkAgent()
Getter for property 'loadJdmkAgent'.

Returns:
Value for property 'loadJdmkAgent'.

setLoadJdmkAgent

public void setLoadJdmkAgent(boolean loadJdmkAgent)
Setter for property 'loadJdmkAgent'.

Parameters:
loadJdmkAgent - Value to set for property 'loadJdmkAgent'.

isLoadMx4jAgent

public boolean isLoadMx4jAgent()
Getter for property 'loadMx4jAgent'.

Returns:
Value for property 'loadMx4jAgent'.

setLoadMx4jAgent

public void setLoadMx4jAgent(boolean loadMx4jAgent)
Setter for property 'loadMx4jAgent'.

Parameters:
loadMx4jAgent - Value to set for property 'loadMx4jAgent'.

isLoadProfilerAgent

public boolean isLoadProfilerAgent()
Getter for property 'loadProfilerAgent'.

Returns:
Value for property 'loadProfilerAgent'.

setLoadProfilerAgent

public void setLoadProfilerAgent(boolean loadProfilerAgent)
Setter for property 'loadProfilerAgent'.

Parameters:
loadProfilerAgent - Value to set for property 'loadProfilerAgent'.

getPort

public String getPort()
Getter for property 'port'.

Returns:
Value for property 'port'.

setPort

public void setPort(String port)
Setter for property 'port'.

Parameters:
port - Value to set for property 'port'.

getHost

public String getHost()
Getter for property 'host'.

Returns:
Value for property 'host'.

setHost

public void setHost(String host)
Setter for property 'host'.

Parameters:
host - Value to set for property 'host'.

setCredentials

public void setCredentials(Map credentials)
Setter for property 'credentials'.

Parameters:
credentials - Value to set for property 'credentials'.


Copyright © 2003-2008 MuleSource, Inc.. All Rights Reserved.