org.xmlBlaster.authentication
Class SessionInfoProtector

java.lang.Object
  org.xmlBlaster.authentication.SessionInfoProtector

All Implemented Interfaces:

ConnectQosDataMBean, I_AdminSession, I_AdminUsage, SessionInfoProtectorMBean

public class SessionInfoProtector

extends java.lang.Object

implements SessionInfoProtectorMBean

SessionInfoProtector protects SessionInfo.java from direct access by administrative tasks.

See javadoc of SessionInfo.java

Author:

Marcel Ruff

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	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.
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
boolean	isAcceptWrongSenderAddress() Configure server with '-xmlBlaster/acceptWrongSenderAddress true' or "-xmlBlaster/acceptWrongSenderAddress/joe true".
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.
void	refreshSession() Invoke operation to reactivate the session expiry to full value
long	removeFromCallbackQueue(long numOfEntries) Removes max num messages.
void	setAcceptWrongSenderAddress(boolean acceptWrongSenderAddress)
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

sessionInfo

private final SessionInfo sessionInfo

Constructor Detail

SessionInfoProtector

public SessionInfoProtector(SessionInfo sessionInfo)

Method Detail

getId

public final java.lang.String getId()

Description copied from interface: I_AdminSession

Access the cluster wide unique identifier: /node/heron/client//

Specified by:

getId in interface I_AdminSession

getLoginName

public final java.lang.String getLoginName()

Description copied from interface: I_AdminSession

Get the login name.

Specified by:

getLoginName in interface I_AdminSession

getQos

public final java.lang.String getQos()

Description copied from interface: I_AdminSession

Access the configuration

Specified by:

getQos in interface I_AdminSession

isCallbackConfigured

public final boolean isCallbackConfigured()

Description copied from interface: I_AdminSession

Check if a callback was configured, if client has passed a callback address on connect.

Specified by:

isCallbackConfigured in interface I_AdminSession

getConnectionState

public final java.lang.String getConnectionState()

Description copied from interface: I_AdminSession

Access the callback connection status.

Specified by:

getConnectionState in interface I_AdminSession

getPublicSessionId

public final long getPublicSessionId()

Description copied from interface: I_AdminSession

Get the sessions public session id.

Specified by:

getPublicSessionId in interface I_AdminSession

getLoginDate

public final java.lang.String getLoginDate()

Description copied from interface: I_AdminSession

Get date when client logged in.

Specified by:

getLoginDate in interface I_AdminSession

getSessionTimeoutExpireDate

public final java.lang.String getSessionTimeoutExpireDate()

Description copied from interface: I_AdminSession

Get the estimated date when the session expires if no refresh occures

Specified by:

getSessionTimeoutExpireDate in interface I_AdminSession

getAliveSinceDate

public final java.lang.String getAliveSinceDate()

Description copied from interface: I_AdminSession

Get the date when last time a ALIVE state was reached. An alive client is reachable with its callback connection.

Specified by:

getAliveSinceDate in interface I_AdminSession

Returns:

For example "2005-03-21 11:18:12.622"

getPollingSinceDate

public final java.lang.String getPollingSinceDate()

Description copied from interface: I_AdminSession

Get the date when last time a POLLING state was reached. A polling client is not reachable with its callback connection.

Specified by:

getPollingSinceDate in interface I_AdminSession

Returns:

For example "2005-03-21 11:18:12.622"

getLastCallbackException

public final java.lang.String getLastCallbackException()

Description copied from interface: I_AdminSession

Holds the last exception text for JMX. Typically a user exception thrown from the remote client or a communication exception.

Specified by:

getLastCallbackException in interface I_AdminSession

Returns:

The exception text or "" but never null

clearLastCallbackException

public final void clearLastCallbackException()

Description copied from interface: I_AdminSession

Clear the last exception text.

Specified by:

clearLastCallbackException in interface I_AdminSession

getNumCallbackExceptions

public final int getNumCallbackExceptions()

Description copied from interface: I_AdminSession

Holds the total amount of exceptions since startup.

Specified by:

getNumCallbackExceptions in interface I_AdminSession

Returns:

The number of exceptions occurred

refreshSession

public final void refreshSession()
                          throws XmlBlasterException

Description copied from interface: I_AdminSession

Invoke operation to reactivate the session expiry to full value

Specified by:

refreshSession in interface I_AdminSession

Throws:

XmlBlasterException

getUptime

public final long getUptime()

Description copied from interface: I_AdminSession

Uptime in seconds

Specified by:

getUptime in interface I_AdminSession

getNumPublish

public final long getNumPublish()

Description copied from interface: I_AdminSession

How many messages where received from this clients login session

Specified by:

getNumPublish in interface I_AdminSession

getNumSubscribe

public final long getNumSubscribe()

Description copied from interface: I_AdminSession

How many subscribe requests where received from this clients login session

Specified by:

getNumSubscribe in interface I_AdminSession

getNumUnSubscribe

public final long getNumUnSubscribe()

Description copied from interface: I_AdminSession

How many unsubscribe requests where received from this clients login session

Specified by:

getNumUnSubscribe in interface I_AdminSession

getNumGet

public final long getNumGet()

Description copied from interface: I_AdminSession

How many get requests where received from this clients login session

Specified by:

getNumGet in interface I_AdminSession

getNumErase

public final long getNumErase()

Description copied from interface: I_AdminSession

How many subscribe requests where received from this clients login session

Specified by:

getNumErase in interface I_AdminSession

getNumUpdateOneway

public final long getNumUpdateOneway()

Description copied from interface: I_AdminSession

How many oneway messages where sent to this clients login session

Specified by:

getNumUpdateOneway in interface I_AdminSession

getNumUpdate

public final long getNumUpdate()

Description copied from interface: I_AdminSession

How many messages where sent to this clients login session

Specified by:

getNumUpdate in interface I_AdminSession

getCbQueueNumMsgs

public final long getCbQueueNumMsgs()

Description copied from interface: I_AdminSession

How many messages are in this clients session callback queue

Specified by:

getCbQueueNumMsgs in interface I_AdminSession

getCbQueueBytes

public final long getCbQueueBytes()

Description copied from interface: I_AdminSession

Number of bytes used by the callback queue. Note that this is the bytes occupied by the references (which point to the real message in msgUnitStore)

Specified by:

getCbQueueBytes in interface I_AdminSession

Returns:

the approximately occupied bytes

getCbQueueNumMsgsCache

public final long getCbQueueNumMsgsCache()

Description copied from interface: I_AdminSession

How many messages are in this clients session callback queue and are cached

Specified by:

getCbQueueNumMsgsCache in interface I_AdminSession

Returns:

-1 if no cach queue is used

getCbQueueBytesCache

public final long getCbQueueBytesCache()

Description copied from interface: I_AdminSession

Number of bytes used on the RAM part of the callback queue. Note that this is the bytes occupied by the references (which point to the real message in msgUnitStore)

Specified by:

getCbQueueBytesCache in interface I_AdminSession

Returns:

the approximately occupied bytes; -1L if not applicable (e.g. only a persistent queue is configured)

getCbQueueMaxMsgs

public final long getCbQueueMaxMsgs()

Description copied from interface: I_AdminSession

How many messages are max. allowed in this clients session callback queue

Specified by:

getCbQueueMaxMsgs in interface I_AdminSession

getCbQueueMaxMsgsCache

public final long getCbQueueMaxMsgsCache()

Description copied from interface: I_AdminSession

How many messages are max. allowed in the cache of the callback queue,

Specified by:

getCbQueueMaxMsgsCache in interface I_AdminSession

Returns:

is -1 if no cache queue implementation is used

pingClientCallbackServer

public java.lang.String pingClientCallbackServer()

Description copied from interface: I_AdminSession

Send a ping to the clients callback server.

Specified by:

pingClientCallbackServer in interface I_AdminSession

Returns:

Returns the pingRoundTripDelay.

getPingRoundTripDelay

public long getPingRoundTripDelay()

Description copied from interface: I_AdminSession

Measures the round trip for the last ping() invocation in milli seconds.

Specified by:

getPingRoundTripDelay in interface I_AdminSession

Returns:

Returns the pingRoundTripDelay.

getRoundTripDelay

public long getRoundTripDelay()

Description copied from interface: I_AdminSession

Measures the round trip for the last remote method invocation in milli seconds. For example update(), publish(), subscribe()

Specified by:

getRoundTripDelay in interface I_AdminSession

Returns:

Returns the roundTripDelay.

getSubscribedTopics

public final java.lang.String[] getSubscribedTopics()

Description copied from interface: I_AdminSession

Comma separated list of all subscribed topic oids of this login session

Specified by:

getSubscribedTopics in interface I_AdminSession

getCurrBytesRead

public final long getCurrBytesRead()

getNumBytesToRead

public final long getNumBytesToRead()

getOverallBytesRead

public final long getOverallBytesRead()

getCurrBytesWritten

public final long getCurrBytesWritten()

Description copied from interface: I_AdminSession

The number of bytes read from the currently outgoing message or response. Note: Currently only implemented by the SOCKET protocol driver

Specified by:

getCurrBytesWritten in interface I_AdminSession

Returns:

Number of bytes written

getNumBytesToWrite

public final long getNumBytesToWrite()

Description copied from interface: I_AdminSession

The size of the currently outgoing message or response Note: Currently only implemented by the SOCKET protocol driver

Specified by:

getNumBytesToWrite in interface I_AdminSession

Returns:

Number of bytes written

getOverallBytesWritten

public final long getOverallBytesWritten()

Description copied from interface: I_AdminSession

Overall bytes send since startup Note: Currently only implemented by the SOCKET protocol driver

Specified by:

getOverallBytesWritten in interface I_AdminSession

Returns:

Number of bytes written

subscribe

public final java.lang.String subscribe(java.lang.String url,
                                        java.lang.String qos)
                                 throws XmlBlasterException

Description copied from interface: I_AdminSession

Invoke operation to subscribe the topic, given by its oid

Specified by:

subscribe in interface I_AdminSession

Parameters:

url - The topic oid/xpath to subscribe (e.g. "Hello" or "xpath://key")

qos - The qos XML string (e.g. "" or "")

Returns:

The status string

Throws:

XmlBlasterException

unSubscribeByIndex

public final java.lang.String[] unSubscribeByIndex(int index,
                                                   java.lang.String qos)
                                            throws XmlBlasterException

Description copied from interface: I_AdminSession

Invoke operation to unSubscribe one topic by index listed.

Specified by:

unSubscribeByIndex in interface I_AdminSession

Parameters:

index - 0 will kill the first listed subscription, 1 the second and so forth

qos - The qos XML string (e.g. "" or "")

Returns:

The status string

Throws:

XmlBlasterException

unSubscribe

public final java.lang.String[] unSubscribe(java.lang.String url,
                                            java.lang.String qos)
                                     throws XmlBlasterException

Description copied from interface: I_AdminSession

Invoke operation to unSubscribe one/many topics.

Specified by:

unSubscribe in interface I_AdminSession

Parameters:

url - The topic oid/xpath to unSubscribe (e.g. "Hello" or "xpath://key")

qos - The qos XML string (e.g. "" or "")

Returns:

The status string

Throws:

XmlBlasterException

getSubscriptions

public final java.lang.String[] getSubscriptions()
                                          throws java.lang.Exception

Description copied from interface: I_AdminSession

Access a list of all subscriptionId of this login session

Specified by:

getSubscriptions in interface I_AdminSession

Returns:

An array with subscriptionId

Throws:

java.lang.Exception

getSubscriptionDump

public final java.lang.String getSubscriptionDump()
                                           throws XmlBlasterException

Description copied from interface: I_AdminSession

An XML dump of all subscriptions of this login session

Specified by:

getSubscriptionDump in interface I_AdminSession

Throws:

XmlBlasterException

killSession

public final java.lang.String killSession()
                                   throws XmlBlasterException

Description copied from interface: I_AdminSession

Invoke operation to destroy the session (force logout)

Specified by:

killSession in interface I_AdminSession

Throws:

XmlBlasterException

setDispatcherActive

public void setDispatcherActive(boolean dispatcherActive)

Description copied from interface: I_AdminSession

Activates/inhibits the dispatch of messages to this session. This is a very helpful operation as you can temporary stop sending messages to a client, they are nicely queued and after activating again the messages are send.

Specified by:

setDispatcherActive in interface I_AdminSession

Parameters:

dispatcherActive - true: callback messages are send to the client if connected false: messages are hold back

getDispatcherActive

public boolean getDispatcherActive()

Description copied from interface: I_AdminSession

true if the dispatcher is currently able to dispatch asyncronously

Specified by:

getDispatcherActive in interface I_AdminSession

peekCallbackMessages

public java.lang.String[] peekCallbackMessages(int numOfEntries)
                                        throws XmlBlasterException

Description copied from interface: I_AdminSession

Peek messages from callback queue, they are not removed

Specified by:

peekCallbackMessages in interface I_AdminSession

Parameters:

numOfEntries - The number of messages to peek, taken from the front

Returns:

The dump of the messages

Throws:

XmlBlasterException

getCallbackQueueEntries

public MsgUnit[] getCallbackQueueEntries(java.lang.String querySpec)
                                  throws XmlBlasterException

Description copied from interface: I_AdminSession

Gets the entries in the callback queue according to what is specified in the querySpec

Specified by:

getCallbackQueueEntries in interface I_AdminSession

Parameters:

querySpec - maxEntries=3&maxSize=-1&consumable=false&waitingDelay=0

Throws:

XmlBlasterException

See Also:

http://www.xmlblaster.org/xmlBlaster/doc/requirements/engine.qos.queryspec.QueueQuery.html

peekCallbackMessagesToFile

public java.lang.String[] peekCallbackMessagesToFile(int numOfEntries,
                                                     java.lang.String path)
                                              throws java.lang.Exception

Description copied from interface: I_AdminSession

Peek messages from callback queue and dump them to a file, they are not removed.

Specified by:

peekCallbackMessagesToFile in interface I_AdminSession

Parameters:

numOfEntries - The number of messages to peek, taken from the front

path - The path to dump the messages to, it is automatically created if missing.

Returns:

The absolute file names dumped

Throws:

java.lang.Exception

clearCallbackQueue

public long clearCallbackQueue()

Description copied from interface: I_AdminSession

Removes all callback entries.

Specified by:

clearCallbackQueue in interface I_AdminSession

Returns:

The number of entries erased

removeFromCallbackQueue

public long removeFromCallbackQueue(long numOfEntries)
                             throws java.lang.Exception

Description copied from interface: I_AdminSession

Removes max num messages. This method does not block.

Specified by:

removeFromCallbackQueue in interface I_AdminSession

Parameters:

numOfEntries - Erase num entries or less if less entries are available, -1 erases everything

Returns:

Number of entries erased

Throws:

java.lang.Exception - if the underlying implementation gets an exception.

getMaxSessions

public final long getMaxSessions()

Enforced by ConnectQosDataMBean interface.

Specified by:

getMaxSessions in interface ConnectQosDataMBean

getSessionTimeout

public final long getSessionTimeout()

Enforced by ConnectQosDataMBean interface.

Specified by:

getSessionTimeout in interface ConnectQosDataMBean

setSessionTimeout

public final void setSessionTimeout(long timeout)

Enforced by ConnectQosDataMBean interface.

Specified by:

setSessionTimeout in interface ConnectQosDataMBean

isPtpAllowed

public final boolean isPtpAllowed()

Enforced by ConnectQosDataMBean interface.

Specified by:

isPtpAllowed in interface ConnectQosDataMBean

isPersistent

public final boolean isPersistent()

Enforced by ConnectQosDataMBean interface.

Specified by:

isPersistent in interface ConnectQosDataMBean

getRemoteProperties

public java.lang.String[] getRemoteProperties()

Description copied from interface: I_AdminSession

Access all known remote properties kept in this session. The remote properties are client side settings send to the server, they contain informations which, for example, can be used by the EventPlugin to alert administrators.

Specified by:

getRemoteProperties in interface I_AdminSession

Returns:

The properties in notation key=value

See Also:

The admin.events requirement

clearRemotePropertiesStartingWith

public java.lang.String clearRemotePropertiesStartingWith(java.lang.String prefix)

Description copied from interface: I_AdminSession

Remove remote properties which key starts with the given prefix

Specified by:

clearRemotePropertiesStartingWith in interface I_AdminSession

Parameters:

prefix - For examlpe "logging/"

Returns:

A string describing success

clearRemoteProperties

public java.lang.String clearRemoteProperties()

Description copied from interface: I_AdminSession

Remove all remote properties from this session.

Specified by:

clearRemoteProperties in interface I_AdminSession

Returns:

Some receipt text

addRemoteProperty

public java.lang.String addRemoteProperty(java.lang.String key,
                                          java.lang.String value)

Description copied from interface: I_AdminSession

Add a remote property. Usually this is done by a publish of a client, but for testing reasons we can to it here manually. If the key exists, its value is overwritten

Specified by:

addRemoteProperty in interface I_AdminSession

Parameters:

key - The unique key (no multimap)

value - The value, it is assumed to be of type "String"

Returns:

Some receipt text

See Also:

The admin.events requirement

usage

public java.lang.String usage()

JMX

Specified by:

usage in interface I_AdminUsage

Returns:

a human readable usage help string

getUsageUrl

public java.lang.String getUsageUrl()

JMX

Specified by:

getUsageUrl in interface I_AdminUsage

Returns:

A link on javadoc for JMX usage

setUsageUrl

public void setUsageUrl(java.lang.String url)

Specified by:

setUsageUrl in interface I_AdminUsage

getConnectQos

public ConnectQosServer getConnectQos()

Specified by:

getConnectQos in interface I_AdminSession

isStalled

public boolean isStalled()

Description copied from interface: I_AdminSession

Returns true if the connection is currently stalled (detected in the dispatch statistics when pinging).

Specified by:

isStalled in interface I_AdminSession

Returns:

isAcceptWrongSenderAddress

public boolean isAcceptWrongSenderAddress()

Description copied from interface: I_AdminSession

Configure server with '-xmlBlaster/acceptWrongSenderAddress true' or "-xmlBlaster/acceptWrongSenderAddress/joe true".

Specified by:

isAcceptWrongSenderAddress in interface I_AdminSession

Returns:

true: We accept wrong sender address in PublishQos.getSender() (not myself)

setAcceptWrongSenderAddress

public void setAcceptWrongSenderAddress(boolean acceptWrongSenderAddress)

Specified by:

setAcceptWrongSenderAddress in interface I_AdminSession

Parameters:

acceptWrongSenderAddress - the acceptWrongSenderAddress to set