org.exoplatform.commons.chromattic

Interface SessionContext

public interface SessionContext

The contract for integration between client of a chromattic session and the session management system. Attachments are useful to associated an arbitrary payload with the session context.

Version:

$Revision$

Author:

Julien Viet

Method Summary

Modifier and Type	Method and Description
void	addSynchronizationListener(SynchronizationListener listener) Registers a synchronization listener.
Object	getAttachment(String name) Returns an attachment of this context.
org.chromattic.api.ChromatticSession	getSession() Returns the managed chromattic session.
void	setAttachment(String name, Object payload) Sets an attachment on this context.

Method Detail

getSession

org.chromattic.api.ChromatticSession getSession()

Returns the managed chromattic session.

Returns:

the session

getAttachment

Object getAttachment(String name)

Returns an attachment of this context.

Parameters:

name - the attachment name

Returns:

the attached object

setAttachment

void setAttachment(String name,
                   Object payload)

Sets an attachment on this context.

Parameters:

name - the attachment name

payload - the attachment payload

addSynchronizationListener

void addSynchronizationListener(SynchronizationListener listener)

Registers a synchronization listener.

Parameters:

listener - the listener