|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface I_AdminSession
Declares available methods of a session for administration.
SNMP or telnet tools can access only the here declared properties.
Method Summary | |
---|---|
java.lang.String |
addRemoteProperty(java.lang.String key,
java.lang.String value)
Add a remote property. |
long |
clearCallbackQueue()
Removes all callback entries. |
void |
clearLastCallbackException()
Clear the last exception text. |
java.lang.String |
clearRemoteProperties()
Remove all remote properties from this session. |
java.lang.String |
clearRemotePropertiesStartingWith(java.lang.String prefix)
Remove remote properties which key starts with the given prefix |
java.lang.String |
disconnectClientKeepSession()
|
java.lang.String |
getAliveSinceDate()
Get the date when last time a ALIVE state was reached. |
MsgUnit[] |
getCallbackQueueEntries(java.lang.String querySpec)
Gets the entries in the callback queue according to what is specified in the querySpec |
long |
getCbQueueBytes()
Number of bytes used by the callback queue. |
long |
getCbQueueBytesCache()
Number of bytes used on the RAM part of the callback queue. |
long |
getCbQueueMaxMsgs()
How many messages are max. |
long |
getCbQueueMaxMsgsCache()
How many messages are max. |
long |
getCbQueueNumMsgs()
How many messages are in this clients session callback queue |
long |
getCbQueueNumMsgsCache()
How many messages are in this clients session callback queue and are cached |
java.lang.String |
getConnectionState()
Access the callback connection status. |
ConnectQosServer |
getConnectQos()
|
long |
getCurrBytesWritten()
The number of bytes read from the currently outgoing message or response. |
boolean |
getDispatcherActive()
true if the dispatcher is currently able to dispatch asyncronously |
java.lang.String |
getId()
Access the cluster wide unique identifier: /node/heron/client/ |
java.lang.String |
getLastCallbackException()
Holds the last exception text for JMX. |
java.lang.String |
getLoginDate()
Get date when client logged in. |
java.lang.String |
getLoginName()
Get the login name. |
long |
getNumBytesToWrite()
The size of the currently outgoing message or response Note: Currently only implemented by the SOCKET protocol driver |
int |
getNumCallbackExceptions()
Holds the total amount of exceptions since startup. |
long |
getNumErase()
How many subscribe requests where received from this clients login session |
long |
getNumGet()
How many get requests where received from this clients login session |
long |
getNumPublish()
How many messages where received from this clients login session |
long |
getNumSubscribe()
How many subscribe requests where received from this clients login session |
long |
getNumUnSubscribe()
How many unsubscribe requests where received from this clients login session |
long |
getNumUpdate()
How many messages where sent to this clients login session |
long |
getNumUpdateOneway()
How many oneway messages where sent to this clients login session |
long |
getOverallBytesWritten()
Overall bytes send since startup Note: Currently only implemented by the SOCKET protocol driver |
long |
getPingRoundTripDelay()
Measures the round trip for the last ping() invocation in milli seconds. |
java.lang.String |
getPollingSinceDate()
Get the date when last time a POLLING state was reached. |
long |
getPublicSessionId()
Get the sessions public session id. |
java.lang.String |
getQos()
Access the configuration |
java.lang.String[] |
getRemoteProperties()
Access all known remote properties kept in this session. |
java.lang.String[] |
getRootSubscriptions()
If XPATH, the parent XPATH is returned and not all its children |
long |
getRoundTripDelay()
Measures the round trip for the last remote method invocation in milli seconds. |
java.lang.String |
getSessionTimeoutExpireDate()
Get the estimated date when the session expires if no refresh occures |
java.lang.String[] |
getSubscribedTopics()
Comma separated list of all subscribed topic oids of this login session |
java.lang.String |
getSubscriptionDump()
An XML dump of all subscriptions of this login session |
java.lang.String[] |
getSubscriptions()
Access a list of all subscriptionId of this login session |
long |
getUptime()
Uptime in seconds |
java.util.Map<java.lang.String,java.lang.Object> |
getUserObjectMap()
|
boolean |
isAcceptWrongSenderAddress()
Configure server with '-xmlBlaster/acceptWrongSenderAddress true' or "-xmlBlaster/acceptWrongSenderAddress/joe true". |
boolean |
isBlockClientSessionLogin()
Prevent clients session from login. |
boolean |
isCallbackConfigured()
Check if a callback was configured, if client has passed a callback address on connect. |
boolean |
isStalled()
Returns true if the connection is currently stalled (detected in the dispatch statistics when pinging). |
java.lang.String |
killSession()
Invoke operation to destroy the session (force logout) |
java.lang.String[] |
peekCallbackMessages(int numOfEntries)
Peek messages from callback queue, they are not removed |
java.lang.String[] |
peekCallbackMessagesToFile(int numOfEntries,
java.lang.String path)
Peek messages from callback queue and dump them to a file, they are not removed. |
java.lang.String |
pingClientCallbackServer()
Send a ping to the clients callback server. |
java.lang.String |
reactivateDispatcherThread(boolean force)
|
void |
refreshSession()
Invoke operation to reactivate the session expiry to full value |
long |
removeFromCallbackQueue(long numOfEntries)
Removes max num messages. |
void |
setAcceptWrongSenderAddress(boolean acceptWrongSenderAddress)
|
java.lang.String |
setBlockClientSessionLogin(boolean blockClient)
Allow or prevent the clients session to login. |
void |
setDispatcherActive(boolean dispatcherActive)
Activates/inhibits the dispatch of messages to this session. |
java.lang.String |
subscribe(java.lang.String url,
java.lang.String qos)
Invoke operation to subscribe the topic, given by its oid |
java.lang.String[] |
unSubscribe(java.lang.String url,
java.lang.String qos)
Invoke operation to unSubscribe one/many topics. |
java.lang.String[] |
unSubscribeByIndex(int index,
java.lang.String qos)
Invoke operation to unSubscribe one topic by index listed. |
Methods inherited from interface org.xmlBlaster.util.qos.ConnectQosDataMBean |
---|
getMaxSessions, getSessionTimeout, isPersistent, isPtpAllowed, setSessionTimeout |
Methods inherited from interface org.xmlBlaster.util.admin.I_AdminUsage |
---|
getUsageUrl, setUsageUrl, usage |
Method Detail |
---|
java.lang.String getId()
java.lang.String getQos()
java.lang.String getLoginName()
boolean isCallbackConfigured()
java.lang.String getConnectionState()
long getPublicSessionId()
java.lang.String getLoginDate()
java.lang.String getSessionTimeoutExpireDate()
java.lang.String getAliveSinceDate()
java.lang.String getPollingSinceDate()
java.lang.String getLastCallbackException()
void clearLastCallbackException()
int getNumCallbackExceptions()
void refreshSession() throws XmlBlasterException
XmlBlasterException
long getUptime()
long getNumPublish()
long getNumSubscribe()
long getNumUnSubscribe()
long getNumGet()
long getNumErase()
long getNumUpdateOneway()
long getNumUpdate()
long getCurrBytesWritten()
long getNumBytesToWrite()
long getOverallBytesWritten()
long getCbQueueNumMsgs()
long getCbQueueBytes()
long getCbQueueNumMsgsCache()
long getCbQueueBytesCache()
long getCbQueueMaxMsgs()
long getCbQueueMaxMsgsCache()
java.lang.String pingClientCallbackServer()
long getPingRoundTripDelay()
long getRoundTripDelay()
update(), publish(), subscribe()
java.lang.String[] getSubscribedTopics()
java.lang.String[] unSubscribe(java.lang.String url, java.lang.String qos) throws XmlBlasterException
url
- The topic oid/xpath to unSubscribe (e.g. "Hello" or "xpath://key")qos
- The qos XML string (e.g. "" or "XmlBlasterException
java.lang.String[] unSubscribeByIndex(int index, java.lang.String qos) throws XmlBlasterException
index
- 0 will kill the first listed subscription, 1 the second and so forthqos
- The qos XML string (e.g. "" or "XmlBlasterException
java.lang.String subscribe(java.lang.String url, java.lang.String qos) throws XmlBlasterException
url
- The topic oid/xpath to subscribe (e.g. "Hello" or "xpath://key")qos
- The qos XML string (e.g. "" or "XmlBlasterException
java.lang.String[] getSubscriptions() throws java.lang.Exception
java.lang.Exception
java.lang.String[] getRootSubscriptions() throws java.lang.Exception
java.lang.Exception
java.lang.String getSubscriptionDump() throws XmlBlasterException
XmlBlasterException
java.lang.String killSession() throws XmlBlasterException
XmlBlasterException
java.util.Map<java.lang.String,java.lang.Object> getUserObjectMap()
void setDispatcherActive(boolean dispatcherActive)
dispatcherActive
- true: callback messages are send to the client if connected
false: messages are hold backboolean getDispatcherActive()
java.lang.String reactivateDispatcherThread(boolean force)
java.lang.String[] peekCallbackMessages(int numOfEntries) throws XmlBlasterException
numOfEntries
- The number of messages to peek, taken from the front
XmlBlasterException
java.lang.String[] peekCallbackMessagesToFile(int numOfEntries, java.lang.String path) throws java.lang.Exception
numOfEntries
- The number of messages to peek, taken from the frontpath
- The path to dump the messages to, it is automatically created if missing.
java.lang.Exception
MsgUnit[] getCallbackQueueEntries(java.lang.String querySpec) throws XmlBlasterException
querySpec
- maxEntries=3&maxSize=-1&consumable=false&waitingDelay=0
XmlBlasterException
http://www.xmlblaster.org/xmlBlaster/doc/requirements/engine.qos.queryspec.QueueQuery.html
long clearCallbackQueue()
long removeFromCallbackQueue(long numOfEntries) throws java.lang.Exception
numOfEntries
- Erase num entries or less if less entries are available, -1 erases everything
java.lang.Exception
- if the underlying implementation gets an exception.java.lang.String[] getRemoteProperties()
java.lang.String clearRemotePropertiesStartingWith(java.lang.String prefix)
prefix
- For examlpe "logging/"
java.lang.String clearRemoteProperties()
java.lang.String addRemoteProperty(java.lang.String key, java.lang.String value)
key
- The unique key (no multimap)value
- The value, it is assumed to be of type "String"
ConnectQosServer getConnectQos()
boolean isStalled()
boolean isAcceptWrongSenderAddress()
void setAcceptWrongSenderAddress(boolean acceptWrongSenderAddress)
acceptWrongSenderAddress
- the acceptWrongSenderAddress to setboolean isBlockClientSessionLogin()
java.lang.String setBlockClientSessionLogin(boolean blockClient)
blockClient
- true to prevent this clients session loginjava.lang.String disconnectClientKeepSession()
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |