|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xmlBlaster.engine.admin.CommandManager
public final class CommandManager
The manager instance for administrative commands.
Each xmlBlaster server instance has one instance of this class to manage its administrative behavior. See the command requirement for a detailed description.
Field Summary | |
---|---|
private java.util.Map |
externMap
Map of external gateways to SNMP, telnet etc. |
private ServerScope |
glob
|
private java.util.Map |
handlerMap
Map to internal handlers like sysprop,client,msg etc |
private static java.util.logging.Logger |
log
|
private java.lang.String |
ME
|
private SessionInfo |
sessionInfo
|
Constructor Summary | |
---|---|
CommandManager(ServerScope glob,
SessionInfo sessionInfo)
You need to call postInit() after all drivers are loaded. |
Method Summary | |
---|---|
MsgUnit[] |
get(AddressServer addressServer,
java.lang.String sessionId,
QueryKeyData keyData,
java.lang.String querySpec)
|
MsgUnit[] |
get(AddressServer addressServer,
java.lang.String sessionId,
java.lang.String oid,
java.lang.String[] args)
|
java.lang.String |
getName()
A human readable name of the listener for logging. |
java.lang.String |
help()
|
java.lang.String |
help(java.lang.String cmd)
|
private void |
initializeExternal()
|
private void |
initializeInternal()
Create internal gateways. |
void |
register(java.lang.String key,
I_CommandHandler handler)
Register internal handler for specific tasks. |
void |
runlevelChange(int from,
int to,
boolean force)
Invoked on run level change, see RunlevelManager.RUNLEVEL_HALTED and RunlevelManager.RUNLEVEL_RUNNING Enforced by I_RunlevelListener |
SetReturn |
set(AddressServer addressServer,
java.lang.String sessionId,
java.lang.String cmd)
|
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 |
---|
private final java.lang.String ME
private final ServerScope glob
private static java.util.logging.Logger log
private final SessionInfo sessionInfo
private final java.util.Map handlerMap
private final java.util.Map externMap
Constructor Detail |
---|
public CommandManager(ServerScope glob, SessionInfo sessionInfo)
sessionInfo
- Internal handle to be used directly with RequestBroker
NOTE: We (the command code) are responsible for security checks
as we directly write into RequestBroker.Method Detail |
---|
private void initializeInternal()
private void initializeExternal()
public final void register(java.lang.String key, I_CommandHandler handler)
public final MsgUnit[] get(AddressServer addressServer, java.lang.String sessionId, QueryKeyData keyData, java.lang.String querySpec) throws XmlBlasterException
sessionId
- Is null if not logged inkeyData
- the key containing the cmd.qosData
- the qos. It can be null. It is null if the request comes
from the telnet or snmp gateway (since in these cases the qos is
wrapped inside the cmd, i.e. here it is inside the oid of the key).
XmlBlasterException
public final MsgUnit[] get(AddressServer addressServer, java.lang.String sessionId, java.lang.String oid, java.lang.String[] args) throws XmlBlasterException
addressServer
- sessionId
- oid
- "__cmd:...."args
- Can be null
XmlBlasterException
public final SetReturn set(AddressServer addressServer, java.lang.String sessionId, java.lang.String cmd) throws XmlBlasterException
sessionId
- Is null if not logged incmd
- The query string
XmlBlasterException
public java.lang.String help()
public java.lang.String help(java.lang.String cmd)
public void shutdown()
public java.lang.String getName()
getName
in interface I_RunlevelListener
public void runlevelChange(int from, int to, boolean force) throws XmlBlasterException
runlevelChange
in interface I_RunlevelListener
from
- The current runlevelto
- The runlevel we want to switch toforce
- If true force the change even if messages are lost
XmlBlasterException
public final java.lang.String toXml()
public final java.lang.String toXml(java.lang.String extraOffset)
extraOffset
- indenting of tags for nice output
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |