|
| |
|
| org.pentaho.core.session.IPentahoSession
All known Subclasses: org.pentaho.core.session.BaseSession,
| IPentahoSession | | public interface IPentahoSession extends ILogger,IAuditable(Code) | | Provides an overall representation of the concept of a session. Sessions are not
necessarily user-based, but typically wrap the HttpSession object and
PortletSession object in a standard framework with methods that session objects
typically provide.
author:
jdixon |
| destroy | | public void destroy()(Code) | | Destroys any resources owned by the session object
|
| getAttribute | | public Object getAttribute(String attributeName)(Code) | | Get the value of a named session attribute
Parameters:
attributeName - The name of the attribute The value of the attribute |
| getAttributeNames | | public Iterator getAttributeNames()(Code) | | Returns an enumeration of the names of the attributes stored in the
session
The enumeration of the attribute names |
| getBackgroundExecutionAlert | | public boolean getBackgroundExecutionAlert()(Code) | | Checks the status of a background execution task.
True if a background execution has triggeredan alert. |
| getId | | public String getId()(Code) | | Gets ths id for this session. This is typically a GUID or semi-unique
string.
Id for this session |
| getLocale | | public Locale getLocale()(Code) | | Gets the Locale of the session
The Locale of the session |
| getName | | public String getName()(Code) | | Gets the name for this session, for example if this is an authenticated
HTTP or Portlet session the name will be the name of the user
Name for this session |
| isAuthenticated | | public boolean isAuthenticated()(Code) | | Gets whether the session is known to be authenticated or not
Is the session authenticated |
| removeAttribute | | public Object removeAttribute(String attributeName)(Code) | | Removes an attribute from the session and returns is
Parameters:
attributeName - The name of the attribute to remove The value of the removed attribute |
| resetBackgroundExecutionAlert | | public void resetBackgroundExecutionAlert()(Code) | | Toggles off the background execution alert status.
|
| setActionName | | public void setActionName(String actionName)(Code) | | Sets the name of the action sequence document that the session is
currently performing
Parameters:
actionName - The name of the action sequence document |
| setAttribute | | public void setAttribute(String attributeName, Object value)(Code) | | Sets the value of a session attribute
Parameters:
attributeName - The name of the attribute
Parameters:
value - The value of the attribute |
| setAuthenticated | | public void setAuthenticated(String name)(Code) | | Sets the name of the session and indicates that the session is
authenticated. If this is a HTTP or Portlet session the name should be
the name of the user that is logged in (e.g. using
request.getRemoteUser() )
Parameters:
name - The name of the session |
| setBackgroundExecutionAlert | | public void setBackgroundExecutionAlert()(Code) | | Toggles on an alert condition indicating that the background
execution of a task has completed during this session.
|
| setNotAuthenticated | | public void setNotAuthenticated()(Code) | | Sets that the user is no longer authenticated
|
| setProcessId | | public void setProcessId(String processId)(Code) | | Sets the name of the process for which an action sequence is being
performed.
Parameters:
processId - The name of the process |
|
|
|