org.xmlBlaster.engine.admin
Interface I_CommandHandler

All Known Implementing Classes:

CoreHandler, MsgHandler, PropertyHandler

public interface I_CommandHandler

Interface to allow different command processing implementations.

Since:

0.79f

Author:

xmlBlaster@marcelruff.info

Method Summary

MsgUnit[]	get(AddressServer addressServer, java.lang.String sessionId, CommandWrapper cmd) Your plugin should process the command.
java.lang.String	help()
java.lang.String	help(java.lang.String cmd)
void	initialize(ServerScope glob, CommandManager commandManager) This is called after creation of the plugin.
java.lang.String	set(AddressServer addressServer, java.lang.String sessionId, CommandWrapper cmd) Your plugin should process the set command.
void	shutdown()

Method Detail

initialize

public void initialize(ServerScope glob,
                       CommandManager commandManager)

This is called after creation of the plugin.

You should register yourself with commandManager.register() during initialization.

Parameters:

glob - The Global handle of this xmlBlaster server instance.

commandManager - My manager

get

public MsgUnit[] get(AddressServer addressServer,
                     java.lang.String sessionId,
                     CommandWrapper cmd)
              throws XmlBlasterException

Your plugin should process the command.

Parameters:

addressServer - The protocol plugin or external access layer calling us

sessionId - Is null if not logged in

cmd - The command to process, e.g. "clientList"

Returns:

An array of MsgUnitRaw object:

• Internal message are delivered as is, please don't manipulate them
• 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.

Throws:

XmlBlasterException

See Also:

command requirement

set

public java.lang.String set(AddressServer addressServer,
                            java.lang.String sessionId,
                            CommandWrapper cmd)
                     throws XmlBlasterException

Your plugin should process the set command.

Parameters:

addressServer - The protocol plugin or external access layer calling us

sessionId - Is null if not logged in

cmd - The command to process, e.g. ?trace=true

Returns:

null if not set

Throws:

XmlBlasterException

See Also:

command requirement

help

public java.lang.String help()

help

public java.lang.String help(java.lang.String cmd)

shutdown

public void shutdown()