com.saperion.session

Interface SessionDataService

public interface SessionDataService

Holds functionality for storing and retrieving data server side on a session.

Author:

jschwarz

Method Summary

Methods

Modifier and Type	Method and Description
<Type> Type	get(SessionDataKey key, Class<Type> clazz) Gets the data identified by the given key.
SessionDataKey	put(Object value) Stores the given object at the session.
SessionDataKey	registerClosable(AutoCloseable value) Stores the given closeable object under the given key.
void	remove(SessionDataKey key) Removes the data stored with the given key from the session.

Method Detail

get

<Type> Type get(SessionDataKey key,
              Class<Type> clazz)

Gets the data identified by the given key.

Type Parameters:

Type - the class of the data. Inferred from clazz.

Parameters:

key - the key associated to the data. Must not be null.

clazz - the class of the data. Must not be null.

Returns:

the data identified by the given key

put

SessionDataKey put(Object value)

Stores the given object at the session. Returns the key to retrieve it.

Parameters:

value - the object to store. Must not be null.

Returns:

the key to retrieve the object later.

registerClosable

SessionDataKey registerClosable(AutoCloseable value)

Stores the given closeable object under the given key. Also registers the value for closing when the session is closed. Returns the key to retrieve the object.

Parameters:

value - the object to store. Must not be null.

Returns:

the key to retrieve the object later.

remove

void remove(SessionDataKey key)
            throws IOException,
                   Exception

Removes the data stored with the given key from the session. If it is registered as closable it will be closed.

Parameters:

key - the key associated to the data. Must not be null.

Throws:

IOException

Exception