org.pentaho.platform.web.portal
Class PentahoPortletSession

java.lang.Object
  org.pentaho.platform.engine.core.system.PentahoBase
      org.pentaho.platform.engine.core.system.BaseSession
          org.pentaho.platform.web.portal.PentahoPortletSession

All Implemented Interfaces:

Serializable, IAuditable, ILogger, IPentahoSession

public class PentahoPortletSession
extends BaseSession

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase

EMPTYLOGID, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR

Fields inherited from interface org.pentaho.platform.api.engine.IPentahoSession

PENTAHO_SESSION_KEY

Fields inherited from interface org.pentaho.platform.api.engine.ILogger

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Constructor Summary

PentahoPortletSession(String userName, javax.portlet.PortletSession portletSession, Locale locale)

Method Summary

void	destroy() Destroys any resources owned by the session object
Object	getAttribute(String attributeName) Get the value of a named session attribute
Object	getAttribute(String attributeName, int scope)
Iterator	getAttributeNames() Returns an enumeration of the names of the attributes stored in the session
org.apache.commons.logging.Log	getLogger()
Object	removeAttribute(String attributeName) Removes an attribute from the session and returns is
Object	removeAttribute(String attributeName, int scope)
void	setAttribute(String attributeName, Object value) Sets the value of a session attribute
void	setAttribute(String attributeName, Object value, int scope)

Methods inherited from class org.pentaho.platform.engine.core.system.BaseSession

getActionName, getBackgroundExecutionAlert, getId, getLocale, getName, getObjectName, getProcessId, isAuthenticated, resetBackgroundExecutionAlert, setActionName, setAuthenticated, setBackgroundExecutionAlert, setNotAuthenticated, setProcessId

Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase

debug, debug, error, error, fatal, fatal, genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, getLogId, info, info, setLoggingLevel, setLogId, trace, trace, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.platform.api.engine.ILogger

debug, debug, error, error, fatal, fatal, getLoggingLevel, info, info, setLoggingLevel, trace, trace, warn, warn

Constructor Detail

PentahoPortletSession

public PentahoPortletSession(String userName,
                             javax.portlet.PortletSession portletSession,
                             Locale locale)

Method Detail

getLogger

public org.apache.commons.logging.Log getLogger()

Specified by:

getLogger in class PentahoBase

getAttribute

public Object getAttribute(String attributeName)

Description copied from interface: IPentahoSession

Get the value of a named session attribute

Parameters:

attributeName - The name of the attribute

Returns:

The value of the attribute

getAttribute

public Object getAttribute(String attributeName,
                           int scope)

getAttributeNames

public Iterator getAttributeNames()

Description copied from interface: IPentahoSession

Returns an enumeration of the names of the attributes stored in the session

Returns:

The enumeration of the attribute names

setAttribute

public void setAttribute(String attributeName,
                         Object value)

Description copied from interface: IPentahoSession

Sets the value of a session attribute

Parameters:

attributeName - The name of the attribute

value - The value of the attribute

setAttribute

public void setAttribute(String attributeName,
                         Object value,
                         int scope)

removeAttribute

public Object removeAttribute(String attributeName)

Description copied from interface: IPentahoSession

Removes an attribute from the session and returns is

Parameters:

attributeName - The name of the attribute to remove

Returns:

The value of the removed attribute

removeAttribute

public Object removeAttribute(String attributeName,
                              int scope)

destroy

public void destroy()

Description copied from interface: IPentahoSession

Destroys any resources owned by the session object

Specified by:

destroy in interface IPentahoSession

Overrides:

destroy in class BaseSession