org.mule.module.management.agent
Class Mx4jAgent

java.lang.Object
  extended by org.mule.AbstractAgent
      extended by org.mule.module.management.agent.Mx4jAgent
All Implemented Interfaces:
Agent, MuleContextAware, Disposable, Initialisable, Lifecycle, Startable, Stoppable, NamedObject

public class Mx4jAgent
extends AbstractAgent

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


Field Summary
static java.lang.String DEFAULT_HOSTNAME
           
static java.lang.String DEFAULT_JMX_ADAPTOR_URL
           
protected static java.lang.String DEFAULT_PATH_IN_JAR
           
static int DEFAULT_PORT
           
static java.lang.String HTTP_ADAPTER_OBJECT_NAME
           
 
Fields inherited from class org.mule.AbstractAgent
muleContext, name
 
Fields inherited from interface org.mule.api.lifecycle.Initialisable
PHASE_NAME
 
Fields inherited from interface org.mule.api.lifecycle.Startable
PHASE_NAME
 
Fields inherited from interface org.mule.api.lifecycle.Stoppable
PHASE_NAME
 
Fields inherited from interface org.mule.api.lifecycle.Disposable
PHASE_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.
 java.lang.String getAuthenticationMethod()
           
 java.lang.String getDescription()
          A description of the agent that gets displayed in the splash screen when the Mule Context starts up.
 java.lang.String getHost()
           
 java.lang.String getJmxAdaptorUrl()
           
 java.lang.String getLogin()
           
 java.lang.String getPassword()
           
 java.lang.String getPathInJar()
           
 java.lang.String getPort()
           
 java.util.Map getSocketFactoryProperties()
           
 java.lang.String getXslFilePath()
           
 void initialise()
          Method used to perform any initialisation work.
 boolean isCacheXsl()
           
 void setAuthenticationMethod(java.lang.String authenticationMethod)
           
 void setCacheXsl(boolean cacheXsl)
           
 void setHost(java.lang.String host)
           
 void setJmxAdaptorUrl(java.lang.String jmxAdaptorUrl)
           
 void setLogin(java.lang.String login)
           
 void setPassword(java.lang.String password)
           
 void setPathInJar(java.lang.String pathInJar)
           
 void setPort(java.lang.String port)
           
 void setSocketFactoryProperties(java.util.Map socketFactoryProperties)
           
 void setXslFilePath(java.lang.String xslFilePath)
           
 void start()
           
 void stop()
           
protected  void unregisterMBeansIfNecessary()
          Unregister all Mx4j MBeans if there are any left over the old deployment
 
Methods inherited from class org.mule.AbstractAgent
getName, setMuleContext, setName
 
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 java.lang.String HTTP_ADAPTER_OBJECT_NAME
See Also:
Constant Field Values

DEFAULT_PATH_IN_JAR

protected static final java.lang.String DEFAULT_PATH_IN_JAR

DEFAULT_HOSTNAME

public static final java.lang.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 java.lang.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 java.lang.Exception
Throws:
java.lang.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.

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 MuleException
Throws:
MuleException

stop

public void stop()
          throws MuleException
Throws:
MuleException

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.


getDescription

public java.lang.String getDescription()
Description copied from interface: Agent
A description of the agent that gets displayed in the splash screen when the Mule Context starts up.

Specified by:
getDescription in interface Agent
Overrides:
getDescription in class AbstractAgent
Returns:
a 1 line description of the agent.

getJmxAdaptorUrl

public java.lang.String getJmxAdaptorUrl()

setJmxAdaptorUrl

public void setJmxAdaptorUrl(java.lang.String jmxAdaptorUrl)

getSocketFactoryProperties

public java.util.Map getSocketFactoryProperties()

setSocketFactoryProperties

public void setSocketFactoryProperties(java.util.Map socketFactoryProperties)

getLogin

public java.lang.String getLogin()

setLogin

public void setLogin(java.lang.String login)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getAuthenticationMethod

public java.lang.String getAuthenticationMethod()

setAuthenticationMethod

public void setAuthenticationMethod(java.lang.String authenticationMethod)

getXslFilePath

public java.lang.String getXslFilePath()

setXslFilePath

public void setXslFilePath(java.lang.String xslFilePath)

getPathInJar

public java.lang.String getPathInJar()

setPathInJar

public void setPathInJar(java.lang.String pathInJar)

isCacheXsl

public boolean isCacheXsl()

setCacheXsl

public void setCacheXsl(boolean cacheXsl)

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)

getPort

public java.lang.String getPort()

setPort

public void setPort(java.lang.String port)


Copyright © 2003-2010 MuleSoft, Inc.. All Rights Reserved.