org.yawlfoundation.yawl.authentication

Class YSessionCache

java.lang.Object

java.util.AbstractMap<K,V>

java.util.concurrent.ConcurrentHashMap<java.lang.String,YSession>

org.yawlfoundation.yawl.authentication.YSessionCache

All Implemented Interfaces:

java.io.Serializable, java.util.concurrent.ConcurrentMap<java.lang.String,YSession>, java.util.Map<java.lang.String,YSession>, ISessionCache

public class YSessionCache
extends java.util.concurrent.ConcurrentHashMap<java.lang.String,YSession>
implements ISessionCache

An extended HashMap that manages connections to the engine from custom services and external applications.

The map is of the form [sessionHandle, session].

Since:

2.1

Author:

Michael Adams

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ConcurrentHashMap

java.util.concurrent.ConcurrentHashMap.KeySetView<K,V>

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
YSessionCache()

Method Summary

Modifier and Type	Method and Description
boolean	checkConnection(java.lang.String handle) Checks that a session handle represents an active session.
java.lang.String	connect(java.lang.String name, java.lang.String password, long timeOutSeconds) Creates and stores a new session between the the Engine and a custom service or external application.
void	disconnect(java.lang.String handle) Ends an active session of a custom service or external application.
void	disconnect(YClient client) Ends an active session of a custom service or external application.
void	expire(java.lang.String handle) Removes a session from the set of active sessions after an idle timeout.
YSession	getSession(java.lang.String handle) Gets the session associated with a session handle.
boolean	isClientConnected(YExternalClient client) Checks that a particular external client has an active session with the Engine.
boolean	isServiceConnected(java.lang.String uri) Checks that a particular custom service has an active session with the Engine.
void	shutdown() Called when the hosting server shuts down to write a shutdown record for each active session to the audit log.

Methods inherited from class java.util.concurrent.ConcurrentHashMap

clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, forEach, forEach, forEachEntry, forEachEntry, forEachKey, forEachKey, forEachValue, forEachValue, get, getOrDefault, hashCode, isEmpty, keys, keySet, keySet, mappingCount, merge, newKeySet, newKeySet, put, putAll, putIfAbsent, reduce, reduceEntries, reduceEntries, reduceEntriesToDouble, reduceEntriesToInt, reduceEntriesToLong, reduceKeys, reduceKeys, reduceKeysToDouble, reduceKeysToInt, reduceKeysToLong, reduceToDouble, reduceToInt, reduceToLong, reduceValues, reduceValues, reduceValuesToDouble, reduceValuesToInt, reduceValuesToLong, remove, remove, replace, replace, replaceAll, search, searchEntries, searchKeys, searchValues, size, toString, values

Methods inherited from class java.util.AbstractMap

clone

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

YSessionCache

public YSessionCache()

Method Detail

connect

public java.lang.String connect(java.lang.String name,
                                java.lang.String password,
                                long timeOutSeconds)

Creates and stores a new session between the the Engine and a custom service or external application.

Specified by:

connect in interface ISessionCache

Parameters:

name - the username of the external client

password - the corresponding (hashed) password

timeOutSeconds - the maximum idle time for this session (in seconds). A value of 0 will default to 60 minutes; a value less than zero means this session will never timeout.

Returns:

a valid session handle, or an appropriate error message

checkConnection

public boolean checkConnection(java.lang.String handle)

Checks that a session handle represents an active session. If it does, the session idle timer is restarted also.

Specified by:

checkConnection in interface ISessionCache

Parameters:

handle - the session handle held by a client or service.

Returns:

true if the handle's session is active.

isServiceConnected

public boolean isServiceConnected(java.lang.String uri)

Checks that a particular custom service has an active session with the Engine.

Parameters:

uri - the uri of the custom service.

Returns:

true if the service has an active session.

isClientConnected

public boolean isClientConnected(YExternalClient client)

Checks that a particular external client has an active session with the Engine.

Parameters:

client - the client.

Returns:

true if the client has an active session.

getSession

public YSession getSession(java.lang.String handle)

Gets the session associated with a session handle.

Specified by:

getSession in interface ISessionCache

Parameters:

handle - a session handle.

Returns:

the session object associated with the handle, or null if the handle is invalid or inactive.

expire

public void expire(java.lang.String handle)

Removes a session from the set of active sessions after an idle timeout. Also writes the expiration to the session audit log.

Specified by:

expire in interface ISessionCache

Parameters:

handle - the session handle of the session to remove.

disconnect

public void disconnect(YClient client)

Ends an active session of a custom service or external application.

Parameters:

client - the service or application to disconnect from the Engine. Also writes the disconnection to the session audit log.

disconnect

public void disconnect(java.lang.String handle)

Ends an active session of a custom service or external application.

Specified by:

disconnect in interface ISessionCache

Parameters:

handle - the session handle of a service or application to disconnect from the Engine. Also writes the disconnection to the session audit log.

shutdown

public void shutdown()

Called when the hosting server shuts down to write a shutdown record for each active session to the audit log.

Specified by:

shutdown in interface ISessionCache