i_commandhandler.java

java开源的企业总线.xmlBlaster

/*------------------------------------------------------------------------------
Name:      I_CommandHandler.java
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
Comment:   Interface to hide command handling code
------------------------------------------------------------------------------*/
package org.xmlBlaster.engine.admin;

import org.xmlBlaster.util.MsgUnit;
import org.xmlBlaster.util.XmlBlasterException;
import org.xmlBlaster.engine.ServerScope;
import org.xmlBlaster.engine.qos.AddressServer;

/**
 * Interface to allow different command processing implementations. 
 * <p />
 * @author [e-mail]
 * @since 0.79f
 */
public interface I_CommandHandler {
   /**
    * This is called after creation of the plugin. 
    * <p />
    * You should register yourself with commandManager.register() during initialization.
    *
    * @param glob The Global handle of this xmlBlaster server instance.
    * @param commandManager My manager
    */
   public void initialize(ServerScope glob, CommandManager commandManager);

   /**
    * Your plugin should process the command. 
    * <p />
    * @param addressServer The protocol plugin or external access layer calling us
    * @param sessionId Is null if not logged in
    * @param cmd The command to process, e.g. "clientList"
    * @return An array of MsgUnitRaw object:
    *       <ul>
    *         <li>Internal message are delivered as is, please don't manipulate them</li>
    *         <li>System properties and internal state queries are marked with msgUnit.getQos() == "text/plain"
    *             and the key contains the plain key and the content the plain value. The MsgUnitRaw
    *             is just misused to carry the key/value data.
    *         </li>
    *       </ul>
    * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/admin.commands.html">command requirement</a>
    */
   public MsgUnit[] get(AddressServer addressServer, String sessionId, CommandWrapper cmd) throws XmlBlasterException;

   /**
    * Your plugin should process the set command. 
    * <p />
    * @param addressServer The protocol plugin or external access layer calling us
    * @param sessionId Is null if not logged in
    * @param cmd The command to process, e.g. ?trace=true
    * @return null if not set
    * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/admin.commands.html">command requirement</a>
    */
   public String set(AddressServer addressServer, String sessionId, CommandWrapper cmd) throws XmlBlasterException;

   public String help();

   public String help(String cmd);

   public void shutdown();
}