|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.pentaho.platform.engine.core.system.PentahoBase
org.pentaho.platform.engine.core.system.BaseSession
public abstract class BaseSession
| 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 | |
|---|---|
BaseSession(String name,
String id,
Locale locale)
|
|
| Method Summary | |
|---|---|
void |
destroy()
Destroys any resources owned by the session object |
String |
getActionName()
Return the name of the action sequence. |
boolean |
getBackgroundExecutionAlert()
Checks the status of a background execution task. |
String |
getId()
Returns a unique id (across classes and instances) for this auditable object. |
Locale |
getLocale()
Gets the Locale of the session |
String |
getName()
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 |
String |
getObjectName()
Returns the Java class name for this object. |
String |
getProcessId()
Return the id for the execution of a given action sequence document. |
boolean |
isAuthenticated()
Gets whether the session is known to be authenticated or not |
void |
resetBackgroundExecutionAlert()
Toggles off the background execution alert status. |
void |
setActionName(String actionName)
Sets the name of the action sequence document that the session is currently performing |
void |
setAuthenticated(String name)
Sets the name of the session and indicates that the session is authenticated. |
void |
setBackgroundExecutionAlert()
Toggles on an alert condition indicating that the background execution of a task has completed during this session. |
void |
setNotAuthenticated()
Sets that the user is no longer authenticated |
void |
setProcessId(String processId)
Sets the name of the process for which an action sequence is being performed. |
| Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase |
|---|
debug, debug, error, error, fatal, fatal, genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLogger, 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.IPentahoSession |
|---|
getAttribute, getAttributeNames, removeAttribute, setAttribute |
| 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 |
|---|
public BaseSession(String name,
String id,
Locale locale)
| Method Detail |
|---|
public boolean isAuthenticated()
IPentahoSession
isAuthenticated in interface IPentahoSessionpublic void setAuthenticated(String name)
IPentahoSessionrequest.getRemoteUser() )
setAuthenticated in interface IPentahoSessionname - The name of the sessionpublic void setNotAuthenticated()
IPentahoSession
setNotAuthenticated in interface IPentahoSessionpublic Locale getLocale()
IPentahoSession
getLocale in interface IPentahoSessionpublic void destroy()
IPentahoSession
destroy in interface IPentahoSessionpublic void setActionName(String actionName)
IPentahoSession
setActionName in interface IPentahoSessionactionName - The name of the action sequence documentpublic void setProcessId(String processId)
IPentahoSession
setProcessId in interface IPentahoSessionprocessId - The name of the processpublic String getName()
IPentahoSession
getName in interface IPentahoSessionpublic String getId()
IAuditable
getId in interface IAuditablegetId in interface IPentahoSessionpublic String getObjectName()
IAuditable
getObjectName in interface IAuditablegetObjectName in class PentahoBasepublic String getProcessId()
IAuditable
getProcessId in interface IAuditablepublic String getActionName()
IAuditable
getActionName in interface IAuditablepublic void setBackgroundExecutionAlert()
IPentahoSession
setBackgroundExecutionAlert in interface IPentahoSessionpublic boolean getBackgroundExecutionAlert()
IPentahoSession
getBackgroundExecutionAlert in interface IPentahoSessionpublic void resetBackgroundExecutionAlert()
IPentahoSession
resetBackgroundExecutionAlert in interface IPentahoSession
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||