View Javadoc

1   /*
2    * $Id: Agent.java 11530 2008-04-08 12:49:14Z 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.api.agent;
12  
13  import org.mule.api.NamedObject;
14  import org.mule.api.lifecycle.Lifecycle;
15  
16  import java.util.List;
17  
18  /**
19   * <code>Agent</code> is a server plugin that can be initialised, started and
20   * destroyed along with the UMOManager itself. Agents can initialise or bind to
21   * external services such as a Jmx server.
22   */
23  public interface Agent extends Lifecycle, NamedObject
24  {
25      /**
26       * Should be a 1 line description of the agent
27       * 
28       * @return
29       */
30      String getDescription();
31  
32      void registered();
33  
34      void unregistered();
35      
36      /**
37       * @return List of Class objects (agent classes) that this Agent requires to be
38       *          started before it can start itself. The implementation of this class may never
39       *          return <code>null</code>.
40       */
41      List/*<Class<? extends Agent>>*/ getDependentAgents();
42  }