MuleContext (Mule ESB 2.2.1 API)
Keywords: org.mule.api.MuleContext interface

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.api
Interface MuleContext

All Superinterfaces:
  Disposable, Initialisable, Lifecycle, Startable, Stoppable

All Known Implementing Classes:
  DefaultMuleContext

    public interface MuleContext

extends Lifecycle

Field Summary

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`

Method Summary
`void` | `addRegistry(long id, Registry registry)`
`void` | `fireNotification(ServerNotification notification)` Fires a server notification to all regiistered listeners
`MuleConfiguration` | `getConfiguration()`
`ThreadingProfile` | `getDefaultMessageDispatcherThreadingProfile()`
`ThreadingProfile` | `getDefaultMessageReceiverThreadingProfile()`
`ThreadingProfile` | `getDefaultMessageRequesterThreadingProfile()`
`ThreadingProfile` | `getDefaultServiceThreadingProfile()`
`ThreadingProfile` | `getDefaultThreadingProfile()`
`ExpressionManager` | `getExpressionManager()` Returns the Expression Manager configured for this instance of Mule
`LifecycleManager` | `getLifecycleManager()`
`ServerNotificationManager` | `getNotificationManager()`
`QueueManager` | `getQueueManager()` Gets the queue manager used by mule for queuing events.
`MuleRegistry` | `getRegistry()`
`SecurityManager` | `getSecurityManager()` Gets the security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations
`long` | `getStartDate()` Returns the date when the server was started.
`AllStatistics` | `getStatistics()`
`TransactionManager` | `getTransactionManager()` Returns the Jta transaction manager used by this Mule server instance.
`javax.resource.spi.work.WorkListener` | `getWorkListener()`
`WorkManager` | `getWorkManager()` Obtains a workManager instance that can be used to schedule work in a thread pool.
`boolean` | `isDisposed()`
`boolean` | `isDisposing()`
`boolean` | `isInitialised()` Determines if the server has been initialised
`boolean` | `isInitialising()` Determines if the server is being initialised
`boolean` | `isStarted()` Determines if the server has been started
`void` | `registerListener(ServerNotificationListener l)` Registers an intenal server event listener.
`void` | `registerListener(ServerNotificationListener l, String resourceIdentifier)` Registers an intenal server event listener.
`void` | `removeRegistry(long id)`
`void` | `setQueueManager(QueueManager queueManager)` Sets the queue manager used by mule for queuing events.
`void` | `setSecurityManager(SecurityManager securityManager)` Sets the security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations
`void` | `setTransactionManager(TransactionManager manager)` Sets the Jta Transaction Manager to use with this Mule server instance
`void` | `unregisterListener(ServerNotificationListener l)` Unregisters a previously registered listener.

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`

Method Detail

### setTransactionManager

    void setTransactionManager(TransactionManager manager)
                               throws Exception

  Sets the Jta Transaction Manager to use with this Mule server instance

  Parameters:
    `manager` - the manager to use
  Throws:
    `Exception`

### getTransactionManager

    TransactionManager getTransactionManager()

  Returns the Jta transaction manager used by this Mule server instance. or null if a transaction manager has not been set

  Returns:
    the Jta transaction manager used by this Mule server instance. or null if a transaction manager has not been set

### getNotificationManager

    ServerNotificationManager getNotificationManager()

### isStarted

    boolean isStarted()

  Determines if the server has been started

  Returns:
    true if the server has been started

### isInitialised

    boolean isInitialised()

  Determines if the server has been initialised

  Returns:
    true if the server has been initialised

### isInitialising

    boolean isInitialising()

  Determines if the server is being initialised

  Returns:
    true if the server is beening initialised

### isDisposed

    boolean isDisposed()

### isDisposing

    boolean isDisposing()

### registerListener

    void registerListener(ServerNotificationListener l)
                          throws NotificationException

  Registers an intenal server event listener. The listener will be notified when a particular event happens within the server. Typically this is not an event in the same sense as an MuleEvent (although there is nothing stopping the implementation of this class triggering listeners when a MuleEvent is received).

  The types of notifications fired is entirely defined by the implementation of this class

  Parameters:
    `l` - the listener to register
  Throws:
    `NotificationException`

### registerListener

    void registerListener(ServerNotificationListener l,
                          String resourceIdentifier)
                          throws NotificationException

  Registers an intenal server event listener. The listener will be notified when a particular event happens within the server. Typically this is not an event in the same sense as an MuleEvent (although there is nothing stopping the implementation of this class triggering listeners when a MuleEvent is received).

  The types of notifications fired is entirely defined by the implementation of this class

  Parameters:
    `l` - the listener to register
    `resourceIdentifier` - a particular resource name for the given type of listener For example, the resourceName could be the name of a service if the listener was a ServiceNotificationListener
  Throws:
    `NotificationException`

### unregisterListener

    void unregisterListener(ServerNotificationListener l)

  Unregisters a previously registered listener. If the listener has not already been registered, this method should return without exception

  Parameters:
    `l` - the listener to unregister

### fireNotification

    void fireNotification(ServerNotification notification)

  Fires a server notification to all regiistered listeners

  Parameters:
    `notification` - the notification to fire

### setSecurityManager

    void setSecurityManager(SecurityManager securityManager)
                            throws InitialisationException,
                                   RegistrationException

  Sets the security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations

  Parameters:
    `securityManager` - the security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations
  Throws:
    `RegistrationException`
    `InitialisationException`

### getSecurityManager

    SecurityManager getSecurityManager()

  Gets the security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations

  Returns:
    he security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations

### getWorkManager

    WorkManager getWorkManager()

  Obtains a workManager instance that can be used to schedule work in a thread pool. This will be used primarially by Agents wanting to schedule work. This work Manager must never be used by provider implementations as they have their own workManager accible on the connector.

  Returns:
    a workManager instance used by the current MuleManager

### getWorkListener

    javax.resource.spi.work.WorkListener getWorkListener()

### setQueueManager

    void setQueueManager(QueueManager queueManager)
                         throws RegistrationException

  Sets the queue manager used by mule for queuing events. This is used for service queues

  Parameters:
    `queueManager` -
  Throws:
    `RegistrationException`

### getQueueManager

    QueueManager getQueueManager()

  Gets the queue manager used by mule for queuing events. This is used for service queues.

  Returns:

### getStatistics

    AllStatistics getStatistics()

### getLifecycleManager

    LifecycleManager getLifecycleManager()

### getRegistry

    MuleRegistry getRegistry()

### getConfiguration

    MuleConfiguration getConfiguration()

### getDefaultMessageDispatcherThreadingProfile

    ThreadingProfile getDefaultMessageDispatcherThreadingProfile()

### getDefaultMessageRequesterThreadingProfile

    ThreadingProfile getDefaultMessageRequesterThreadingProfile()

### getDefaultMessageReceiverThreadingProfile

    ThreadingProfile getDefaultMessageReceiverThreadingProfile()

### getDefaultServiceThreadingProfile

    ThreadingProfile getDefaultServiceThreadingProfile()

### getDefaultThreadingProfile

    ThreadingProfile getDefaultThreadingProfile()

### addRegistry

    void addRegistry(long id,
                     Registry registry)

### removeRegistry

    void removeRegistry(long id)

### getStartDate

    long getStartDate()

  Returns the date when the server was started.

  Returns:
    the date when the server was started.

### getExpressionManager

    ExpressionManager getExpressionManager()

  Returns the Expression Manager configured for this instance of Mule

  Returns:
    the Expression Manager configured for this instance of Mule
  See Also:
    `ExpressionManager`

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-2009 MuleSource, Inc.. All Rights Reserved.