|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface I_AdminSubject
Declares available methods of a client for administration.
SNMP or telnet tools can access only the here declared properties.
Method Summary | |
---|---|
java.lang.String |
blockClientAndResetConnections()
Prevent client login and reset all its ALIVE protocol connections. |
java.lang.String |
getCreationDate()
Get date when this subject was created. |
int |
getMaxSessions()
Returns the maximum allowed login sessions for this subject. |
int |
getNumSessions()
Returns how many login sessions this subject currently has. |
long |
getNumUpdate()
How many messages where sent to all of this clients login sessions. |
I_AdminSession |
getSessionByPubSessionId(long pubSessionId)
Navigate to a session instance. |
java.lang.String |
getSessionList()
Get a list of all session names for this subject. |
java.lang.String[] |
getSessions()
Get a list of all session names for this subject. |
MsgUnit[] |
getSubjectQueueEntries(java.lang.String querySpec)
Query the history queue, can be peeking or consuming. |
long |
getSubjectQueueMaxMsgs()
Returns the maximum allowed PtP messages in this queue. |
long |
getSubjectQueueNumMsgs()
Returns how many PtP messages are currently in my subject queue. |
long |
getUptime()
Get elapsed seconds since this subject was created. |
boolean |
isBlockClientLogin()
Prevent client from login. |
java.lang.String |
killClient()
Destroy the client with all its sessions. |
java.lang.String[] |
peekSubjectMessages(int numOfEntries)
Peek point to point messages from subject queue, they are not removed |
java.lang.String[] |
peekSubjectMessagesToFile(int numOfEntries,
java.lang.String path)
Peek messages from PtP subject queue and dump them to a file, they are not removed. |
java.lang.String |
setBlockClientLogin(boolean blockClient)
Allow or prevent client login. |
void |
setMaxSessions(int max)
Configure the maximum allowed login sessions for this subject. |
Methods inherited from interface org.xmlBlaster.util.admin.I_AdminUsage |
---|
getUsageUrl, setUsageUrl, usage |
Method Detail |
---|
long getUptime()
java.lang.String getCreationDate()
long getNumUpdate()
long getSubjectQueueNumMsgs()
long getSubjectQueueMaxMsgs()
int getNumSessions()
int getMaxSessions()
void setMaxSessions(int max)
max
- The maximum number of sessions for this subjectboolean isBlockClientLogin()
java.lang.String setBlockClientLogin(boolean blockClient)
blockClient
- true to prevent client loginsjava.lang.String blockClientAndResetConnections()
java.lang.String getSessionList()
java.lang.String[] getSessions()
I_AdminSession getSessionByPubSessionId(long pubSessionId)
pubSessionId
- The public session ID of the session to lookup
java.lang.String killClient() throws XmlBlasterException
XmlBlasterException
java.lang.String[] peekSubjectMessages(int numOfEntries) throws XmlBlasterException
numOfEntries
- The number of messages to peek, taken from the front
XmlBlasterException
java.lang.String[] peekSubjectMessagesToFile(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[] getSubjectQueueEntries(java.lang.String querySpec) throws XmlBlasterException
keyData
- Is currently unused but it is needed to be consistent with the
admin get convention (i.e. either take no parameters or always take a key
and a qos).querySpec
- Can be configured to be consuming
e.g. "maxEntries=3&maxSize=-1&consumable=true&waitingDelay=0"
XmlBlasterException
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |