|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XmlBlasterAccessMBean
Export methods for JMX to monitor and control the java client connection.
Method Summary | |
---|---|
java.lang.String |
disconnect(java.lang.String disconnectQos)
|
boolean |
forcePollingForTesting()
|
java.lang.String |
getBuildJavaVendor()
The java vendor of the compiler. |
java.lang.String |
getBuildJavaVersion()
The compiler java version. |
java.lang.String |
getBuildTimestamp()
Returns the date when xmlBlaster client library was compiled. |
java.lang.String |
getConnectionQueueId()
Access the unique id of my client side queue. |
long |
getConnectionQueueMaxMsgs()
How many messages are max. |
long |
getConnectionQueueNumMsgs()
How many messages are in this client side queue |
java.lang.String |
getConnectionState()
Get the connection state. |
boolean |
getDispatcherActive()
Access the dispatcher state. |
java.lang.String |
getId()
A unique name for this client, for logging only |
java.lang.String |
getLoginDate()
Get date when client logged in. |
java.lang.String |
getLoginName()
Get the login name. |
long |
getNumErase()
How many subscribe requests where send by this clients login session |
long |
getNumGet()
How many get requests where send by this clients login session |
long |
getNumPublish()
How many messages where send by this clients login session |
long |
getNumSubscribe()
How many subscribe requests where send by this clients login session |
long |
getNumUnSubscribe()
How many unsubscribe requests where send by this clients login session |
long |
getNumUpdate()
How many messages where received by this clients login session |
long |
getNumUpdateOneway()
How many oneway messages where received by this clients login session |
long |
getPingRoundTripDelay()
Measures the round trip for the last ping() invocation in milli seconds. |
long |
getPublicSessionId()
Get the sessions public session id. |
java.lang.String |
getRevisionNumber()
Returns the xmlBlaster client library SVN version control revision number. |
long |
getRoundTripDelay()
Measures the round trip for the last remote method invocation in milli seconds. |
java.lang.String |
getServerNodeId()
The cluster node id (name) to which we want to connect. |
long |
getUptime()
Uptime in seconds |
java.lang.String |
getVersion()
Get the xmlBlaster client library version number. |
java.lang.String[] |
invokeErase(java.lang.String url,
java.lang.String qos)
Invoke operation to erase() one/many topics. |
java.lang.String[] |
invokeGet(java.lang.String url,
java.lang.String qos)
Invoke operation to get() one/many topics. |
java.lang.String |
invokePublish(java.lang.String key,
java.lang.String content,
java.lang.String qos)
Publish a message. |
java.lang.String |
invokeSubscribe(java.lang.String url,
java.lang.String qos)
Invoke operation to subscribe the topic, given by its oid |
java.lang.String[] |
invokeUnSubscribe(java.lang.String url,
java.lang.String qos)
Invoke operation to unSubscribe one/many topics. |
boolean |
isCallbackConfigured()
Check if a callback was configured, if client has passed a callback address on connect. |
java.lang.String |
leaveServer()
|
java.lang.String[] |
peekClientMessages(int numOfEntries)
Peek messages from client queue, they are not removed |
java.lang.String[] |
peekClientMessagesToFile(int numOfEntries,
java.lang.String path)
Peek messages from client queue and dump them to a file, they are not removed. |
void |
refreshSession()
Send an event to xmlBlaster to refresh the login session life time. |
void |
setDispatcherActive(boolean dispatcherActive)
Activates/inhibits the dispatch of messages to this client. |
Method Detail |
---|
java.lang.String getId()
java.lang.String getLoginName()
boolean isCallbackConfigured()
java.lang.String getConnectionState()
long getPublicSessionId()
java.lang.String getConnectionQueueId()
java.lang.String getLoginDate()
void refreshSession() throws XmlBlasterException
XmlBlasterException
- like ErrorCode.USER_NOT_CONNECTED and otherslong getUptime()
long getNumPublish()
long getNumSubscribe()
long getNumUnSubscribe()
long getNumGet()
long getNumErase()
long getNumUpdateOneway()
long getNumUpdate()
long getConnectionQueueNumMsgs()
long getConnectionQueueMaxMsgs()
long getPingRoundTripDelay()
long getRoundTripDelay()
update(), publish(), subscribe()
boolean forcePollingForTesting()
java.lang.String invokePublish(java.lang.String key, java.lang.String content, java.lang.String qos) throws java.lang.Exception
key
- The publish key (e.g. <key oid="Hello"><South/></key>)qos
- The qos XML string (e.g. "" or "<qos><persistent/></qos>")
java.lang.Exception
java.lang.String[] invokeUnSubscribe(java.lang.String url, java.lang.String qos) throws java.lang.Exception
url
- The topic oid/xpath to unSubscribe (e.g. "Hello" or "xpath://key")qos
- The qos XML string (e.g. "" or "java.lang.Exception
java.lang.String invokeSubscribe(java.lang.String url, java.lang.String qos) throws java.lang.Exception
url
- The topic oid/xpath to subscribe (e.g. "Hello" or "xpath://key")qos
- The qos XML string (e.g. "" or "java.lang.Exception
java.lang.String[] invokeGet(java.lang.String url, java.lang.String qos) throws java.lang.Exception
url
- The topic oid/xpath to retrieve (e.g. "Hello" or "xpath://key")qos
- The qos XML string (e.g. "" or "java.lang.Exception
java.lang.String[] invokeErase(java.lang.String url, java.lang.String qos) throws java.lang.Exception
url
- The topic oid/xpath to erase (e.g. "Hello" or "xpath://key")qos
- The qos XML string (e.g. "" or "java.lang.Exception
void setDispatcherActive(boolean dispatcherActive)
boolean getDispatcherActive()
java.lang.String getServerNodeId()
java.lang.String[] peekClientMessages(int numOfEntries) throws java.lang.Exception
numOfEntries
- The number of messages to peek, taken from the front
java.lang.Exception
java.lang.String[] peekClientMessagesToFile(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
java.lang.String getVersion()
java.lang.String getRevisionNumber()
java.lang.String getBuildTimestamp()
java.lang.String getBuildJavaVendor()
java.lang.String getBuildJavaVersion()
java.lang.String leaveServer()
java.lang.String disconnect(java.lang.String disconnectQos)
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |