|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface I_AdminTopic
Declares available methods of a topic for administration.
JMX, SNMP or telnet tools can access only the here declared properties.
Method Summary | |
---|---|
long |
clearHistoryQueue()
|
java.lang.String |
eraseTopic()
Invoke operation to erase the topic |
java.lang.String |
getContentMime()
Access the topics content mime. |
java.lang.String |
getContentMimeExtended()
Access the topics content mime extended. |
long |
getDestroyDelay()
The configured delay in milli seconds until the topic is destroyed in state UNREFERENCED. |
boolean |
getDomTreeExists()
Check if this topic is query-able by XPath. |
boolean |
getExactSubscribersExist()
|
MsgUnit[] |
getHistoryQueueEntries(java.lang.String querySpec)
Query the history queue, can be peeking or consuming. |
java.lang.String |
getId()
The unique identifier of this topic. |
long |
getNumOfCacheEntries()
Get number of queued history messages which are in the cache. |
long |
getNumOfHistoryEntries()
Get number of queued history messages. |
int |
getNumSubscribers()
Access the number of registered subscribers on this topic. |
java.lang.String |
getStateStr()
Get the life cycle status of this topic. |
java.lang.String[] |
getSubscribers()
Get a list of all subscribers of this topic. |
java.lang.String |
getTopicXml()
Access the topics xml key. |
boolean |
getTopicXmlExists()
|
java.lang.String |
getUniqueKey()
Access the topic key oid. |
java.lang.String[] |
peekHistoryMessages(int numOfEntries)
Peek messages from history queue, they are not removed. |
java.lang.String[] |
peekHistoryMessagesToFile(int numOfEntries,
java.lang.String path)
Peek messages from history queue and dump them to a file, they are not removed. |
java.lang.String |
toXml()
Get status dump. |
java.lang.String[] |
unSubscribeAll(java.lang.String qos)
Invoke operation to unSubscribe all clients. |
java.lang.String[] |
unSubscribeByIndex(int index,
java.lang.String qos)
Invoke operation to unSubscribe one client by index of getSubscribers() listed. |
java.lang.String[] |
unSubscribeBySessionName(java.lang.String sessionName,
java.lang.String qos)
Invoke operation to unSubscribe one client by index of getSubscribers() listed. |
Methods inherited from interface org.xmlBlaster.util.admin.I_AdminUsage |
---|
getUsageUrl, setUsageUrl, usage |
Method Detail |
---|
java.lang.String getId()
boolean getDomTreeExists()
boolean getTopicXmlExists()
java.lang.String getTopicXml() throws XmlBlasterException
XmlBlasterException
java.lang.String getUniqueKey()
java.lang.String getContentMime()
java.lang.String getContentMimeExtended()
int getNumSubscribers()
boolean getExactSubscribersExist()
long getNumOfHistoryEntries()
long getNumOfCacheEntries()
long clearHistoryQueue()
java.lang.String getStateStr()
java.lang.String[] getSubscribers()
java.lang.String[] unSubscribeByIndex(int index, java.lang.String qos) throws XmlBlasterException
index
- 0 will kill the first listed subscribing client, 1 the second and so forthqos
- The qos XML string (e.g. "" or "XmlBlasterException
java.lang.String[] unSubscribeBySessionName(java.lang.String sessionName, java.lang.String qos) throws XmlBlasterException
sessionName
- You can specify a relative name "client/joe/1" or an absolute name "/node/heron/client/joe/1"qos
- The qos XML string (e.g. "" or "XmlBlasterException
java.lang.String[] unSubscribeAll(java.lang.String qos) throws XmlBlasterException
qos
- The qos XML string (e.g. "" or "XmlBlasterException
java.lang.String toXml()
java.lang.String[] peekHistoryMessages(int numOfEntries) throws XmlBlasterException
numOfEntries
- The number of messages to peek, the newest first
XmlBlasterException
java.lang.String[] peekHistoryMessagesToFile(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[] getHistoryQueueEntries(java.lang.String querySpec) throws XmlBlasterException
querySpec
- Can be configured to be consuming
XmlBlasterException
java.lang.String eraseTopic() throws XmlBlasterException
XmlBlasterException
long getDestroyDelay()
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |