View Javadoc

1   /*
2    * $Id: UMOAgent.java 7976 2007-08-21 14:26:13Z dirk.olmes $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSource, Inc.  All rights reserved.  http://www.mulesource.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.umo.manager;
12  
13  import org.mule.umo.lifecycle.Initialisable;
14  import org.mule.umo.lifecycle.Lifecycle;
15  
16  /**
17   * <code>UMOAgent</code> is a server plugin that can be initialised, started and
18   * destroyed along with the UMOManager itself. Agents can initialise or bind to
19   * external services such as a Jmx server.
20   * 
21   * @author <a href="mailto:ross.mason@symphonysoft.com">Ross Mason</a>
22   * @version $Revision: 7976 $
23   */
24  public interface UMOAgent extends Lifecycle, Initialisable
25  {
26      /**
27       * Gets the name of this agent
28       * 
29       * @return the agent name
30       */
31      String getName();
32  
33      /**
34       * Sets the name of this agent
35       * 
36       * @param name the name of the agent
37       */
38      void setName(String name);
39  
40      /**
41       * Should be a 1 line description of the agent
42       * 
43       * @return
44       */
45      String getDescription();
46  
47      void registered();
48  
49      void unregistered();
50  }