org.mule.impl.internal.admin
Class MuleAdminAgent

java.lang.Object
  extended by org.mule.impl.internal.admin.MuleAdminAgent
All Implemented Interfaces:
Disposable, Initialisable, Lifecycle, Startable, Stoppable, UMOAgent

public class MuleAdminAgent
extends Object
implements UMOAgent

MuleAdminAgent manages the server endpoint that receives Admin and remote client requests


Field Summary
static String AGENT_NAME
           
static String DEFAULT_MANAGER_ENDPOINT
           
protected static Log logger
          logger used by this class
 
Constructor Summary
MuleAdminAgent()
           
 
Method Summary
 void dispose()
          A lifecycle method where implementor should free up any resources.
 String getDescription()
          Should be a 1 line description of the agent
 String getName()
          Gets the name of this agent
 WireFormat getWireFormat()
           
 void initialise()
          Method used to perform any initialisation work.
 void registered()
           
 void setName(String name)
          Sets the name of this agent
 void setWireFormat(WireFormat wireFormat)
           
 void start()
           
 void stop()
           
 String toString()
           
 void unregistered()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_MANAGER_ENDPOINT

public static final String DEFAULT_MANAGER_ENDPOINT
See Also:
Constant Field Values

AGENT_NAME

public static final String AGENT_NAME
See Also:
Constant Field Values

logger

protected static final Log logger
logger used by this class

Constructor Detail

MuleAdminAgent

public MuleAdminAgent()
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:

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()
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

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

toString

public String toString()
Overrides:
toString in class Object

getWireFormat

public WireFormat getWireFormat()

setWireFormat

public void setWireFormat(WireFormat wireFormat)


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