org.mule.management.agents
Class Mx4jAgent

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

public class Mx4jAgent
extends Object
implements UMOAgent

Mx4jAgent configures an Mx4J Http Adaptor for Jmx management, statistics and configuration viewing of a Mule instance.

TODO MULE-1353


Field Summary
static String DEFAULT_HOSTNAME
           
static String DEFAULT_JMX_ADAPTOR_URL
           
protected static String DEFAULT_PATH_IN_JAR
           
static int DEFAULT_PORT
           
static String HTTP_ADAPTER_OBJECT_NAME
           
 
Constructor Summary
Mx4jAgent()
           
 
Method Summary
protected  mx4j.tools.adaptor.http.HttpAdaptor createAdaptor()
           
 void dispose()
          A lifecycle method where implementor should free up any resources.
 String getAuthenticationMethod()
           
 String getDescription()
          Should be a 1 line description of the agent
 String getHost()
           
 String getJmxAdaptorUrl()
           
 String getLogin()
           
 String getName()
          Gets the name of this agent
 String getPassword()
           
 String getPathInJar()
           
 String getPort()
           
 Map getSocketFactoryProperties()
           
 String getXslFilePath()
           
 void initialise()
          Method used to perform any initialisation work.
 boolean isCacheXsl()
           
 void registered()
           
 void setAuthenticationMethod(String authenticationMethod)
           
 void setCacheXsl(boolean cacheXsl)
           
 void setHost(String host)
           
 void setJmxAdaptorUrl(String jmxAdaptorUrl)
           
 void setLogin(String login)
           
 void setName(String name)
          Sets the name of this agent
 void setPassword(String password)
           
 void setPathInJar(String pathInJar)
           
 void setPort(String port)
           
 void setSocketFactoryProperties(Map socketFactoryProperties)
           
 void setXslFilePath(String xslFilePath)
           
 void start()
           
 void stop()
           
 void unregistered()
           
protected  void unregisterMBeansIfNecessary()
          Unregister all Mx4j MBeans if there are any left over the old deployment
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HTTP_ADAPTER_OBJECT_NAME

public static final String HTTP_ADAPTER_OBJECT_NAME
See Also:
Constant Field Values

DEFAULT_PATH_IN_JAR

protected static final String DEFAULT_PATH_IN_JAR

DEFAULT_HOSTNAME

public static final String DEFAULT_HOSTNAME
See Also:
Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT
See Also:
Constant Field Values

DEFAULT_JMX_ADAPTOR_URL

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

Mx4jAgent

public Mx4jAgent()
Method Detail

createAdaptor

protected mx4j.tools.adaptor.http.HttpAdaptor createAdaptor()
                                                     throws Exception
Throws:
Exception

initialise

public void initialise()
                throws InitialisationException
Description copied from interface: Initialisable
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

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

unregisterMBeansIfNecessary

protected void unregisterMBeansIfNecessary()
                                    throws javax.management.MalformedObjectNameException,
                                           javax.management.InstanceNotFoundException,
                                           javax.management.MBeanRegistrationException
Unregister all Mx4j MBeans if there are any left over the old deployment

Throws:
javax.management.MalformedObjectNameException
javax.management.InstanceNotFoundException
javax.management.MBeanRegistrationException

dispose

public void dispose()
Description copied from interface: Disposable
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

registered

public void registered()
Specified by:
registered in interface UMOAgent

unregistered

public void unregistered()
Specified by:
unregistered in interface UMOAgent

getDescription

public String getDescription()
Description copied from interface: UMOAgent
Should be a 1 line description of the agent

Specified by:
getDescription in interface UMOAgent
Returns:

getName

public String getName()
Description copied from interface: UMOAgent
Gets the name of this agent

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

setName

public void setName(String name)
Description copied from interface: UMOAgent
Sets the name of this agent

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

getJmxAdaptorUrl

public String getJmxAdaptorUrl()
Returns:
Returns the jmxAdaptorUrl.

setJmxAdaptorUrl

public void setJmxAdaptorUrl(String jmxAdaptorUrl)
Parameters:
jmxAdaptorUrl - The jmxAdaptorUrl to set.

getSocketFactoryProperties

public Map getSocketFactoryProperties()

setSocketFactoryProperties

public void setSocketFactoryProperties(Map socketFactoryProperties)

getLogin

public String getLogin()

setLogin

public void setLogin(String login)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getAuthenticationMethod

public String getAuthenticationMethod()

setAuthenticationMethod

public void setAuthenticationMethod(String authenticationMethod)

getXslFilePath

public String getXslFilePath()

setXslFilePath

public void setXslFilePath(String xslFilePath)

getPathInJar

public String getPathInJar()

setPathInJar

public void setPathInJar(String pathInJar)

isCacheXsl

public boolean isCacheXsl()

setCacheXsl

public void setCacheXsl(boolean cacheXsl)

getHost

public String getHost()

setHost

public void setHost(String host)

getPort

public String getPort()

setPort

public void setPort(String port)


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