org.yawlfoundation.yawl.authentication

Class YSession

java.lang.Object

org.yawlfoundation.yawl.authentication.YAbstractSession

org.yawlfoundation.yawl.authentication.YSession

Direct Known Subclasses:

YExternalSession, YServiceSession

public class YSession
extends YAbstractSession

Base class which represents an active session between the engine and an external service or application.

Since:

2.1

Author:

Michael Adams

Constructor Summary

Constructors

Constructor and Description
YSession(long timeOutSeconds)
YSession(YClient client, long timeOutSeconds) Creates a session with the engine for the client.

Method Summary

Modifier and Type	Method and Description
YClient	getClient()
java.lang.String	getPassword() Overridden in all child classes.
java.lang.String	getURI() Overridden in all child classes.
void	setPassword(java.lang.String password) Overridden in all child classes.

Methods inherited from class org.yawlfoundation.yawl.authentication.YAbstractSession

getHandle, getInterval

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YSession

public YSession(long timeOutSeconds)

YSession

public YSession(YClient client,
                long timeOutSeconds)

Creates a session with the engine for the client.

Parameters:

client - the external service or application requesting a session

timeOutSeconds - the maximum idle time for this session (in seconds)

See Also:

YSession(long)

Method Detail

getURI

public java.lang.String getURI()

Overridden in all child classes.

Returns:

This base version returns a null String (always)

getPassword

public java.lang.String getPassword()

Overridden in all child classes.

Returns:

This base version returns a null String (always)

setPassword

public void setPassword(java.lang.String password)
                 throws YPersistenceException

Overridden in all child classes. This base version sets the password for the generic 'admin' user only.

Parameters:

password - the (hashed) password to set (change to) for the 'admin' user.

Throws:

YPersistenceException

getClient

public YClient getClient()