com.opencms.core
Interface I_CmsSession

All Known Implementing Classes:

CmsSession

public interface I_CmsSession

This interface defines an OpenCms session, a generic session object that is used by OpenCms and provides methods to access the current users session data.

Version:

$Revision: 1.15 $ $Date: 2002/12/06 23:16:51 $

Author:

Michael Emmerich, Andreas Schouten

Method Summary

Object	getValue(String name) Gets a value from the session.
String[]	getValueNames()
void	invalidate() Invalidates the session.
void	putValue(String name, Object value) Puts a value into the session
void	removeValue(String name) Removes a value from the session.

Method Detail

getValue

public Object getValue(String name)

Gets a value from the session.

Parameters:

name - the key.

Returns:

the object for this key.

getValueNames

public String[] getValueNames()

putValue

public void putValue(String name,
                     Object value)

Puts a value into the session

Parameters:

name - the key.

value - a object to store the value.

removeValue

public void removeValue(String name)

Removes a value from the session.

Parameters:

name - the key for the value to remove.

invalidate

public void invalidate()

Invalidates the session.