com.atlassian.jira.util.velocity
Interface VelocityRequestSession

All Known Implementing Classes:

HttpSessionBackedVelocityRequestSession

public interface VelocityRequestSession

An object that stores Session information for a user;

Since:

v4.0

Method Summary

Object	getAttribute(String name) Returns the object bound with the specified name in this session, or null if no object is bound under the name.
Enumeration<String>	getAttributeNames() Returns an Enumeration of String objects containing the names of all the objects bound to this session.
String	getId() Returns a string containing the unique identifier assigned to this session.
void	invalidate() Invalidates this session and unbinds any objects bound to it.
void	removeAttribute(String name) Removes the object bound with the specified name from this session.
void	setAttribute(String name, Object value) Binds an object to this session, using the name specified.

Method Detail

getId

String getId()

Returns a string containing the unique identifier assigned to this session.

Returns:

a string specifying the identifier assigned to this session

getAttribute

Object getAttribute(String name)

Returns the object bound with the specified name in this session, or null if no object is bound under the name.

Parameters:

name - a string specifying the name of the object

Returns:

the object with the specified name

getAttributeNames

Enumeration<String> getAttributeNames()

Returns an Enumeration of String objects containing the names of all the objects bound to this session.

Returns:

an Enumeration of String objects specifying the names of all the objects bound to this session

setAttribute

void setAttribute(String name,
                  Object value)

Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.

Parameters:

name - the name to which the object is bound; cannot be null

value - the object to be bound; cannot be null

removeAttribute

void removeAttribute(String name)

Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.

Parameters:

name - the name of the object to remove from this session

invalidate

void invalidate()

Invalidates this session and unbinds any objects bound to it.