org.xmlBlaster.engine.admin.extern
Class MomClientGateway

java.lang.Object
  org.xmlBlaster.engine.admin.extern.MomClientGateway

All Implemented Interfaces:

I_ExternGateway

public final class MomClientGateway
extends java.lang.Object
implements I_ExternGateway

The gateway allows to do administration with xmlBlaster messages.

XmlBlaster messages having an oid that starts with "__cmd:" are handled as administration messages.
Example:

   <key oid="__cmd:/node/heron/sysprop/?trace[core]"/>
 

Since:

0.79f

Author:

xmlBlaster@marcelruff.info

See Also:

admin requirement, admin.commands requirement

Field Summary

private CommandManager	commandManager
private ServerScope	glob
private static int	instanceCounter
private static java.util.logging.Logger	log
private java.lang.String	ME

Constructor Summary

MomClientGateway()

Method Summary

MsgUnit[]	getCommand(SessionInfo sessionInfo, QueryKeyData keyData, QueryQosData qosData) Called by RequestBroker on get() of command messages.
java.lang.String	getName() Get a human readable name of this filter implementation
boolean	initialize(ServerScope glob, CommandManager commandManager) Creates the remote console server.
java.lang.String	setCommand(SessionInfo sessionInfo, KeyData xmlKey, MsgUnit msgUnit, PublishQosServer publishQos, boolean isClusterUpdate) Called by RequestBroker on publish() of command messages.
void	shutdown()
java.lang.String	toXml() Dump state of this object into a XML ASCII string.
java.lang.String	toXml(java.lang.String extraOffset) Dump state of this object into a XML ASCII string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ME

private java.lang.String ME

glob

private ServerScope glob

log

private static java.util.logging.Logger log

commandManager

private CommandManager commandManager

instanceCounter

private static int instanceCounter

Constructor Detail

MomClientGateway

public MomClientGateway()

Method Detail

initialize

public boolean initialize(ServerScope glob,
                          CommandManager commandManager)
                   throws XmlBlasterException

Creates the remote console server.

Specified by:

initialize in interface I_ExternGateway

Parameters:

glob - The Global handle of this xmlBlaster server instance.

commandManager - My manager

Returns:

false Ignore this implementation (gateway is switched off)

Throws:

XmlBlasterException

getCommand

public MsgUnit[] getCommand(SessionInfo sessionInfo,
                            QueryKeyData keyData,
                            QueryQosData qosData)
                     throws XmlBlasterException

Called by RequestBroker on get() of command messages.

Parameters:

sessionInfo - The client

command - The key oid, for example "__cmd:/node/heron/?numClients"

Throws:

XmlBlasterException

setCommand

public java.lang.String setCommand(SessionInfo sessionInfo,
                                   KeyData xmlKey,
                                   MsgUnit msgUnit,
                                   PublishQosServer publishQos,
                                   boolean isClusterUpdate)
                            throws XmlBlasterException

Called by RequestBroker on publish() of command messages.

Parameters:

sessionInfo - The client

xmlKey - The key oid, for example "__cmd:/node/heron/?numClients=5"

Throws:

XmlBlasterException

getName

public java.lang.String getName()

Description copied from interface: I_ExternGateway

Get a human readable name of this filter implementation

Specified by:

getName in interface I_ExternGateway

shutdown

public void shutdown()

Specified by:

shutdown in interface I_ExternGateway

toXml

public final java.lang.String toXml()

Dump state of this object into a XML ASCII string.

toXml

public final java.lang.String toXml(java.lang.String extraOffset)

Dump state of this object into a XML ASCII string.

Parameters:

extraOffset - indenting of tags for nice output