|
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.authentication.SubjectInfoProtector
public final class SubjectInfoProtector
SubjectInfoProtector protects SubjectInfo.java from direct access by administrative tasks.
See javadoc of SubjectInfo.java for a description
Field Summary | |
---|---|
private SubjectInfo |
subjectInfo
|
Constructor Summary | |
---|---|
SubjectInfoProtector(SubjectInfo subjectInfo)
|
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. |
java.lang.String |
getUsageUrl()
JMX |
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 maxSessions)
Configure the maximum allowed login sessions for this subject. |
void |
setUsageUrl(java.lang.String url)
|
java.lang.String |
usage()
JMX |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private final SubjectInfo subjectInfo
Constructor Detail |
---|
public SubjectInfoProtector(SubjectInfo subjectInfo)
Method Detail |
---|
public long getUptime()
I_AdminSubject
getUptime
in interface I_AdminSubject
public java.lang.String getCreationDate()
I_AdminSubject
getCreationDate
in interface I_AdminSubject
public long getNumUpdate()
I_AdminSubject
getNumUpdate
in interface I_AdminSubject
public long getSubjectQueueNumMsgs()
I_AdminSubject
getSubjectQueueNumMsgs
in interface I_AdminSubject
public long getSubjectQueueMaxMsgs()
I_AdminSubject
getSubjectQueueMaxMsgs
in interface I_AdminSubject
public int getNumSessions()
I_AdminSubject
getNumSessions
in interface I_AdminSubject
public int getMaxSessions()
I_AdminSubject
getMaxSessions
in interface I_AdminSubject
public void setMaxSessions(int maxSessions)
I_AdminSubject
setMaxSessions
in interface I_AdminSubject
maxSessions
- The maximum number of sessions for this subjectpublic boolean isBlockClientLogin()
I_AdminSubject
isBlockClientLogin
in interface I_AdminSubject
public java.lang.String setBlockClientLogin(boolean blockClient)
I_AdminSubject
setBlockClientLogin
in interface I_AdminSubject
blockClient
- true to prevent client loginspublic java.lang.String blockClientAndResetConnections()
I_AdminSubject
blockClientAndResetConnections
in interface I_AdminSubject
public java.lang.String getSessionList()
I_AdminSubject
getSessionList
in interface I_AdminSubject
public java.lang.String[] getSessions()
I_AdminSubject
getSessions
in interface I_AdminSubject
public I_AdminSession getSessionByPubSessionId(long pubSessionId)
I_AdminSubject
getSessionByPubSessionId
in interface I_AdminSubject
pubSessionId
- The public session ID of the session to lookup
public java.lang.String killClient() throws XmlBlasterException
I_AdminSubject
killClient
in interface I_AdminSubject
XmlBlasterException
public java.lang.String[] peekSubjectMessages(int numOfEntries) throws XmlBlasterException
I_AdminSubject
peekSubjectMessages
in interface I_AdminSubject
numOfEntries
- The number of messages to peek, taken from the front
XmlBlasterException
public java.lang.String[] peekSubjectMessagesToFile(int numOfEntries, java.lang.String path) throws java.lang.Exception
I_AdminSubject
peekSubjectMessagesToFile
in interface I_AdminSubject
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
public MsgUnit[] getSubjectQueueEntries(java.lang.String querySpec) throws XmlBlasterException
I_AdminSubject
getSubjectQueueEntries
in interface I_AdminSubject
querySpec
- Can be configured to be consuming
e.g. "maxEntries=3&maxSize=-1&consumable=true&waitingDelay=0"
XmlBlasterException
public java.lang.String usage()
usage
in interface I_AdminUsage
public java.lang.String getUsageUrl()
getUsageUrl
in interface I_AdminUsage
public void setUsageUrl(java.lang.String url)
setUsageUrl
in interface I_AdminUsage
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |