|
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.SessionInfoProtector
public class SessionInfoProtector
SessionInfoProtector protects SessionInfo.java from direct access by administrative tasks.
See javadoc of SessionInfo.java
Field Summary | |
---|---|
private SessionInfo |
sessionInfo
|
Constructor Summary | |
---|---|
SessionInfoProtector(SessionInfo sessionInfo)
|
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 |
getCurrBytesRead()
|
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 |
getMaxSessions()
Enforced by ConnectQosDataMBean interface. |
long |
getNumBytesToRead()
|
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 |
getOverallBytesRead()
|
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. |
long |
getSessionTimeout()
Enforced by ConnectQosDataMBean interface. |
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.lang.String |
getUsageUrl()
JMX |
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 |
isPersistent()
Enforced by ConnectQosDataMBean interface. |
boolean |
isPtpAllowed()
Enforced by ConnectQosDataMBean interface. |
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. |
void |
setSessionTimeout(long timeout)
Enforced by ConnectQosDataMBean interface. |
void |
setUsageUrl(java.lang.String url)
|
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. |
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 SessionInfo sessionInfo
Constructor Detail |
---|
public SessionInfoProtector(SessionInfo sessionInfo)
Method Detail |
---|
public final java.lang.String getId()
I_AdminSession
getId
in interface I_AdminSession
public final java.lang.String getLoginName()
I_AdminSession
getLoginName
in interface I_AdminSession
public final java.lang.String getQos()
I_AdminSession
getQos
in interface I_AdminSession
public final boolean isCallbackConfigured()
I_AdminSession
isCallbackConfigured
in interface I_AdminSession
public final java.lang.String getConnectionState()
I_AdminSession
getConnectionState
in interface I_AdminSession
public final long getPublicSessionId()
I_AdminSession
getPublicSessionId
in interface I_AdminSession
public final java.lang.String getLoginDate()
I_AdminSession
getLoginDate
in interface I_AdminSession
public final java.lang.String getSessionTimeoutExpireDate()
I_AdminSession
getSessionTimeoutExpireDate
in interface I_AdminSession
public final java.lang.String getAliveSinceDate()
I_AdminSession
getAliveSinceDate
in interface I_AdminSession
public final java.lang.String getPollingSinceDate()
I_AdminSession
getPollingSinceDate
in interface I_AdminSession
public final java.lang.String getLastCallbackException()
I_AdminSession
getLastCallbackException
in interface I_AdminSession
public final void clearLastCallbackException()
I_AdminSession
clearLastCallbackException
in interface I_AdminSession
public final int getNumCallbackExceptions()
I_AdminSession
getNumCallbackExceptions
in interface I_AdminSession
public final void refreshSession() throws XmlBlasterException
I_AdminSession
refreshSession
in interface I_AdminSession
XmlBlasterException
public final long getUptime()
I_AdminSession
getUptime
in interface I_AdminSession
public final long getNumPublish()
I_AdminSession
getNumPublish
in interface I_AdminSession
public final long getNumSubscribe()
I_AdminSession
getNumSubscribe
in interface I_AdminSession
public final long getNumUnSubscribe()
I_AdminSession
getNumUnSubscribe
in interface I_AdminSession
public final long getNumGet()
I_AdminSession
getNumGet
in interface I_AdminSession
public final long getNumErase()
I_AdminSession
getNumErase
in interface I_AdminSession
public final long getNumUpdateOneway()
I_AdminSession
getNumUpdateOneway
in interface I_AdminSession
public final long getNumUpdate()
I_AdminSession
getNumUpdate
in interface I_AdminSession
public final long getCbQueueNumMsgs()
I_AdminSession
getCbQueueNumMsgs
in interface I_AdminSession
public final long getCbQueueBytes()
I_AdminSession
getCbQueueBytes
in interface I_AdminSession
public final long getCbQueueNumMsgsCache()
I_AdminSession
getCbQueueNumMsgsCache
in interface I_AdminSession
public final long getCbQueueBytesCache()
I_AdminSession
getCbQueueBytesCache
in interface I_AdminSession
public final long getCbQueueMaxMsgs()
I_AdminSession
getCbQueueMaxMsgs
in interface I_AdminSession
public final long getCbQueueMaxMsgsCache()
I_AdminSession
getCbQueueMaxMsgsCache
in interface I_AdminSession
public java.lang.String pingClientCallbackServer()
I_AdminSession
pingClientCallbackServer
in interface I_AdminSession
public long getPingRoundTripDelay()
I_AdminSession
getPingRoundTripDelay
in interface I_AdminSession
public long getRoundTripDelay()
I_AdminSession
update(), publish(), subscribe()
getRoundTripDelay
in interface I_AdminSession
public final java.lang.String[] getSubscribedTopics()
I_AdminSession
getSubscribedTopics
in interface I_AdminSession
public final long getCurrBytesRead()
public final long getNumBytesToRead()
public final long getOverallBytesRead()
public final long getCurrBytesWritten()
I_AdminSession
getCurrBytesWritten
in interface I_AdminSession
public final long getNumBytesToWrite()
I_AdminSession
getNumBytesToWrite
in interface I_AdminSession
public final long getOverallBytesWritten()
I_AdminSession
getOverallBytesWritten
in interface I_AdminSession
public final java.lang.String subscribe(java.lang.String url, java.lang.String qos) throws XmlBlasterException
I_AdminSession
subscribe
in interface I_AdminSession
url
- The topic oid/xpath to subscribe (e.g. "Hello" or "xpath://key")qos
- The qos XML string (e.g. "" or "XmlBlasterException
public final java.lang.String[] unSubscribeByIndex(int index, java.lang.String qos) throws XmlBlasterException
I_AdminSession
unSubscribeByIndex
in interface I_AdminSession
index
- 0 will kill the first listed subscription, 1 the second and so forthqos
- The qos XML string (e.g. "" or "XmlBlasterException
public final java.lang.String[] unSubscribe(java.lang.String url, java.lang.String qos) throws XmlBlasterException
I_AdminSession
unSubscribe
in interface I_AdminSession
url
- The topic oid/xpath to unSubscribe (e.g. "Hello" or "xpath://key")qos
- The qos XML string (e.g. "" or "XmlBlasterException
public java.util.Map<java.lang.String,java.lang.Object> getUserObjectMap()
getUserObjectMap
in interface I_AdminSession
public final java.lang.String[] getSubscriptions() throws java.lang.Exception
I_AdminSession
getSubscriptions
in interface I_AdminSession
java.lang.Exception
public final java.lang.String[] getRootSubscriptions() throws java.lang.Exception
I_AdminSession
getRootSubscriptions
in interface I_AdminSession
java.lang.Exception
public final java.lang.String getSubscriptionDump() throws XmlBlasterException
I_AdminSession
getSubscriptionDump
in interface I_AdminSession
XmlBlasterException
public final java.lang.String killSession() throws XmlBlasterException
I_AdminSession
killSession
in interface I_AdminSession
XmlBlasterException
public java.lang.String disconnectClientKeepSession()
disconnectClientKeepSession
in interface I_AdminSession
public boolean isBlockClientSessionLogin()
I_AdminSession
isBlockClientSessionLogin
in interface I_AdminSession
public java.lang.String setBlockClientSessionLogin(boolean blockClient)
I_AdminSession
setBlockClientSessionLogin
in interface I_AdminSession
blockClient
- true to prevent this clients session loginpublic void setDispatcherActive(boolean dispatcherActive)
I_AdminSession
setDispatcherActive
in interface I_AdminSession
dispatcherActive
- true: callback messages are send to the client if connected
false: messages are hold backpublic boolean getDispatcherActive()
I_AdminSession
getDispatcherActive
in interface I_AdminSession
public java.lang.String reactivateDispatcherThread(boolean force)
reactivateDispatcherThread
in interface I_AdminSession
public java.lang.String[] peekCallbackMessages(int numOfEntries) throws XmlBlasterException
I_AdminSession
peekCallbackMessages
in interface I_AdminSession
numOfEntries
- The number of messages to peek, taken from the front
XmlBlasterException
public MsgUnit[] getCallbackQueueEntries(java.lang.String querySpec) throws XmlBlasterException
I_AdminSession
getCallbackQueueEntries
in interface I_AdminSession
querySpec
- maxEntries=3&maxSize=-1&consumable=false&waitingDelay=0
XmlBlasterException
http://www.xmlblaster.org/xmlBlaster/doc/requirements/engine.qos.queryspec.QueueQuery.html
public java.lang.String[] peekCallbackMessagesToFile(int numOfEntries, java.lang.String path) throws java.lang.Exception
I_AdminSession
peekCallbackMessagesToFile
in interface I_AdminSession
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 long clearCallbackQueue()
I_AdminSession
clearCallbackQueue
in interface I_AdminSession
public long removeFromCallbackQueue(long numOfEntries) throws java.lang.Exception
I_AdminSession
removeFromCallbackQueue
in interface I_AdminSession
numOfEntries
- Erase num entries or less if less entries are available, -1 erases everything
java.lang.Exception
- if the underlying implementation gets an exception.public final long getMaxSessions()
getMaxSessions
in interface ConnectQosDataMBean
public final long getSessionTimeout()
getSessionTimeout
in interface ConnectQosDataMBean
public final void setSessionTimeout(long timeout)
setSessionTimeout
in interface ConnectQosDataMBean
public final boolean isPtpAllowed()
isPtpAllowed
in interface ConnectQosDataMBean
public final boolean isPersistent()
isPersistent
in interface ConnectQosDataMBean
public java.lang.String[] getRemoteProperties()
I_AdminSession
getRemoteProperties
in interface I_AdminSession
public java.lang.String clearRemotePropertiesStartingWith(java.lang.String prefix)
I_AdminSession
clearRemotePropertiesStartingWith
in interface I_AdminSession
prefix
- For examlpe "logging/"
public java.lang.String clearRemoteProperties()
I_AdminSession
clearRemoteProperties
in interface I_AdminSession
public java.lang.String addRemoteProperty(java.lang.String key, java.lang.String value)
I_AdminSession
addRemoteProperty
in interface I_AdminSession
key
- The unique key (no multimap)value
- The value, it is assumed to be of type "String"
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
public ConnectQosServer getConnectQos()
getConnectQos
in interface I_AdminSession
public boolean isStalled()
I_AdminSession
isStalled
in interface I_AdminSession
public boolean isAcceptWrongSenderAddress()
I_AdminSession
isAcceptWrongSenderAddress
in interface I_AdminSession
public void setAcceptWrongSenderAddress(boolean acceptWrongSenderAddress)
setAcceptWrongSenderAddress
in interface I_AdminSession
acceptWrongSenderAddress
- the acceptWrongSenderAddress to set
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |