Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.mule
Class AbstractAgent

    java.lang.Object
      org.mule.AbstractAgent

All Implemented Interfaces:
  Agent, MuleContextAware, Disposable, Initialisable, Lifecycle, Startable, Stoppable, NamedObject

Direct Known Subclasses:
  AbstractNotificationLoggerAgent, DefaultJmxSupportAgent, HeartbeatAgent, JdmkAgent, JmxAgent, Log4jAgent, Mx4jAgent, RemoteDispatcherAgent, RmiRegistryAgent, WrapperManagerAgent

    public abstract class AbstractAgent

extends Object
implements Agent, MuleContextAware

Implements common methods for all Agents. Importantly, the MuleContext is made available to Agents that extend this.

Field Summary
`protected MuleContext` | `muleContext`
`protected String` | `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
`protected` | `AbstractAgent(String name)`

Method Summary
`String` | `getDescription()` A description of the agent that gets displayed in the splash screen when the Mule Context starts up.
`String` | `getName()` Gets the name of the object
`void` | `setMuleContext(MuleContext context)`
`void` | `setName(String name)` Sets the name of the object

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.mule.api.lifecycle.Initialisable
`initialise`

Methods inherited from interface org.mule.api.lifecycle.Startable
`start`

Methods inherited from interface org.mule.api.lifecycle.Stoppable
`stop`

Methods inherited from interface org.mule.api.lifecycle.Disposable
`dispose`

Field Detail

### muleContext

    protected MuleContext muleContext

### name

    protected String name

Constructor Detail

### AbstractAgent

    protected AbstractAgent(String name)

Method Detail

### getName

    public final String getName()

  Description copied from interface: `NamedObject`
  Gets the name of the object

  Specified by:
    `getName` in interface `NamedObject`
  Returns:
    the name of the object

### setName

    public final void setName(String name)

  Description copied from interface: `NamedObject`
  Sets the name of the object

  Specified by:
    `setName` in interface `NamedObject`
  Parameters:
    `name` - the name of the object

### getDescription

    public 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`
  Returns:
    a 1 line description of the agent.

### setMuleContext

    public void setMuleContext(MuleContext context)

  Specified by:
    `setMuleContext` in interface `MuleContextAware`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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