planetj.dataengine
Class SessionManager

java.lang.Object
  |
  +--planetj.dataengine.SessionManager

All Implemented Interfaces:

IApplicationJSPs, IDataEngine, IJSPPages, INavigation, IServletParameters, IWOWJSPs

public final class SessionManager

extends Object

implements IDataEngine

The SessionManager contains methods for storing and retrieving objects to and from the HttpSession. The session manager should be used for all DataEngine applications to allow for proper storing of objects. A hidden field is set on loaded pages which is used to uniquely identify which application is getting or setting an Object into the session. This hidden field's value will be used as a prefix for storing objects to and from the session.

This class also contains methods for getting and storing common DataEngine objects, such as RowCollections, Rows, Tables, Libraries, DBSystems, lists of Libraries and Tables, ecetera.

Author:

PlanetJ Corporation

Field Summary

static String	SESSION_VALID
static String	SESSION_VALID_CHECKED

Fields inherited from interface planetj.dataengine.IDataEngine

ACTION, ADMIN_MAGIC_REQUEST, ALL_SERVLET_PATHS, ALLOW_MULTIPLE_DELETES, ALLOW_MULTIPLE_SELECTION, APPLICATION, COMPANY, CONTEXT, CONTEXT_KEY, CONTROLLER_SERVLET_PATH, CONTROLLER_SERVLET_URI, CURRENT_SQL_CONTEXT, CURRENT_SQL_RECORD_COUNT, CURRENT_SQL_STRING, CURRENT_TOC, DATA_ENGINE_MESSAGE, DATAENGINE_ADMIN_SERVLET_PATH, DATAENGINE_APPLICATION_BUILDER_SERVLET_PATH, DATAENGINE_APPLICATION_SERVLET_PATH, DATAEXPLORER_SERVLET_PATH, DE_ACTION_CATEGORY, DE_ACTION_SIGN_ON, DEFAULT_LAYOUT_DISPLAY_PROPERTIES, DEFAULT_RESULTS_KEY, DEFAULT_USER_LIBRARY, DETAILS, EDITABLE_OPERATIONS, ENVIRONMENT_MODE_DEVELOPMENT, ENVIRONMENT_MODE_PRODUCTION, ERROR_APPLICATION_INVALID, ERROR_COMPANY_INVALID, ERROR_MESSAGE, EXCEPTION, EXCEPTION_JSP_KEY, FIELD, FIELD_DESCRIPTOR_SERVLET_PATH, FIELD_LIST, FIELD_NAMES, FIELDS, FORM_LIB_TBL_FLD, FUNCTION, HIDDEN_APPLICATION_ID, HIDDEN_APPLICATION_METADATA_ALIAS, IGNORE_MAGIC_REQUEST, KEEP_INSERT_VALUES, LAST_JSP_CALLED, LAUNCHED_FROM_BUILDER, LIBRARY, LIBRARY_LIST, MAGIC_ACTION_ROW, MODE, MODE_COPY, MODE_DELETE, MODE_EDIT, MODE_INSERT, MODE_SEARCH, MODE_UNKNOWN, MODE_VIEW, MULTIPLESELECTION, NEW_ROW, NEW_WINDOW_FOR_RESULTS, NEXT_PAGE, NOSELECTION, OPERATION, OPERATION_KEY, OWNER_ID, PAGE, PAGE_REQUEST_EXECUTED, PAGE_VALIDATION_REQUIRED, PARAMETER_VALUE_PREFIX, PREVIOUS_PAGE, RESERVED_PARAMETERS, RETRIEVE_ALL_COLUMNS_ON_COPY, RETRIEVE_ALL_COLUMNS_ON_EDIT, RETRIEVE_ALL_COLUMNS_ON_VIEW, RETRIEVE_FIELDS, RETRIEVE_TABLES, RETURN_URI, ROW, ROW_ALTERNATE_KEY, ROW_COLLECTION, ROW_COLLECTION_KEY, ROW_KEY, ROW_KEY_FOR_DETAILS, ROW_SELECTION_JS_INCLUDED, ROWS_ALTERED_COUNT, SELECTED_ROW, SELECTED_ROW_COLLECTION, SELECTEDOBJECTS, SERVLET_CONTEXT, SESSION_RANDOM_NUMBER, SESSION_SIGNED_OFF, SESSION_SIGNON_RECEIPT_KEY, SESSION_TIMED_OUT, SHOW_FD_QUICK_LINKS, SHOW_UPDATABLE_TABLES, SHOW_UPDATEABLE_ROW, SIGN_ON_CALLER, SIGNON, SIGNON_AND_REGISTRATION_SERVLET_PATH, SINGLESELECTION, STATEMENT, SYSTEM, SYSTEMS_LIST, TABLE, TABLE_LIST, TRANSIENT, UNSUPPORTED, USER_LIBRARY_HTTP_PARAMETER, USER_LIBRARY_HTTP_SESSION_KEY, USER_MESSAGE, USER_PREFERENCES, VALID_SIGNON, WINDOW_CLOSE, WINDOW_NORMAL, WINDOW_POPUP, WINDOW_TYPE_PARAM

Fields inherited from interface planetj.dataengine.INavigation

CHILD_PREFIX, GROUP_ATTRIBUTES, GROUP_ID, INITIAL_GROUP_ID, INITIAL_PAGE_ID, INITIAL_REQUEST_ID, NAVIGATION_CHECKED, NAVIGATION_OBJECT_LIST_PREFIX, NEW_GROUP_ID, NEW_REQUEST_ID, NEW_SESSION_ID, PAGE_ATTRIBUTES, PAGE_ID, PARENT_PREFIX, PERSISTENT_ATTRIBUTES, PREVIOUS_ATTRIBUTES, PREVIOUS_GROUP_ID, PREVIOUS_PAGE_ID, PREVIOUS_REQUEST_ID, REQUEST_ID, RESET_GROUP_ID, RESET_NAVIGATION_IDS, RESET_NAVIGATION_IDS_COMPLETED, RESET_PAGE_ID, RESET_REQUEST_ID, RESET_SESSION_ID, SESSION_ID

Fields inherited from interface planetj.dataengine.IServletParameters

ALL, AUTO_RUN, BASE_URL, CACHE_TRACK_ON, CACHE_TRACK_WRITE_TO_FILE, CLEAN_UP_TIME, DATABASE, DRIVER, ENVIRONMENT_MODE, JDBC_OPTIMIZATIONS, MAX_CONNECTIONS, METADATA_LIBRARY, MIN_CONNECTIONS, ORPHAN_TIMEOUT, PASSWORD, PORT, SYSTEM_ALIAS, SYSTEM_ALIAS_PARAM, SYSTEM_URL, USER_ID, USER_PASSWORD

Fields inherited from interface planetj.dataengine.IJSPPages

CUSTOM_LOG_ON_JSP, DEFAULT_ADD_BODY_JSP, DEFAULT_EDIT_BODY_JSP, DEFAULT_PARAMS_JSP, DEFAULT_PRINT_PAGE_JSP, DEFAULT_RESULTS_JSP, DEFAULT_ROW_DETAILS, DEFAULT_SQL_OPERATION_RESULTS_JSP, DEFAULT_VIEW_BODY_JSP, DETAILS_JSP, DISPLAY_EXCEPTION_JSP, INITIAL_JSP, SIGN_ON_BODY_JSP, SIGN_ON_JSP, SIGNON_PARAMS_JSP

Fields inherited from interface planetj.dataengine.application.IApplicationJSPs

APPLICATION_ADD_JSP, APPLICATION_DETAILS_JSP, APPLICATION_EDIT_JSP, APPLICATION_ERROR_JSP, APPLICATION_HEADER_JSP, APPLICATION_INVALID_LICENSE_JSP, APPLICATION_JSP, APPLICATION_MESSAGE_JSP, APPLICATION_OPERATIONS_TOC, APPLICATION_RESULTS_JSP, APPLICATION_SIGN_ON_JSP, APPLICATION_TEMPLATE_JSP, APPLICATION_TOC_JSP, APPLICATION_VIEW_JSP

Fields inherited from interface planetj.dataengine.application.IWOWJSPs

WOW_MAIN_EXCEPTION_JSP, WOW_MANAGE_OPERATIONS_JSP, WOW_STEPS_JSP, WOW_TOC, WOW_VIEW_APPLICATIONS_JSP, WOW_VIEW_CONNECTIONS_JSP

Constructor Summary

SessionManager()

Method Summary

static Object	getAttribute(String key, javax.servlet.http.HttpServletRequest request) Gets an object from the HttpSession using the given key.
static Object	getAttribute(String sessionId, String key, javax.servlet.http.HttpServletRequest request) Deprecated.
static Map	getAttributes(javax.servlet.http.HttpServletRequest request) Gets the HttpSession from the given request for the requests session id.
static Integer	getLastRequestId(javax.servlet.http.HttpServletRequest request) Deprecated. no longer used
static Library	getLibrary(javax.servlet.http.HttpServletRequest pRequest) Gets the default Library from the session.
static Library	getLibrary(javax.servlet.http.HttpServletRequest pRequest, String pLibraryKey) Gets the Library from the session identified by the given key.
static List	getLibraryList(javax.servlet.http.HttpServletRequest pRequest) Gets the default list of libraries from the session.
static List	getLibraryList(javax.servlet.http.HttpServletRequest pRequest, String pLibraryListKey) Gets a list of libraries from the session identified by the given key.
static Row	getRow(javax.servlet.http.HttpServletRequest pRequest, String pRowKey) Deprecated. Row's should no be set on the request as a persistent or page attribute. call HttpRequestManager.getAttribute(String, HttpSerlvetRequest)
static RowCollection	getRowCollection(javax.servlet.http.HttpServletRequest request) Deprecated. RowCollection's should no be set on the request as a persistent or page attribute. call HttpRequestManager.getAttribute(String, HttpSerlvetRequest)
static RowCollection	getRowCollection(javax.servlet.http.HttpServletRequest pRequest, String pRowCollectionKey) Deprecated. RowCollection's should no be set on the request as a persistent or page attribute. call HttpRequestManager.getAttribute(String, HttpSerlvetRequest)
static Object	getSessionAttribute(javax.servlet.http.HttpServletRequest request, String key) Deprecated. Replaced with getAttribute(String, HttpServletRequest) to keep up parameter ordering standards with internal code.
static Object	getSessionAttribute(javax.servlet.http.HttpServletRequest pRequest, String pKey, String uniqueSessionId) Deprecated. Replaced with getAttribute(String, String, HttpServletRequest) as of (10/8/2002 10:00:12 PM) to keep parameter ordering standards of internal code consistent
static int	getSessionRandomNumber(javax.servlet.http.HttpServletRequest req) Gets a random number unique to this session.
static Object	getSharedAttribute(String key, javax.servlet.http.HttpServletRequest request) Gets an object from the HttpSession using the given key.
static Object	getSharedSessionAttribute(javax.servlet.http.HttpServletRequest pRequest, String pKey) Deprecated. Replaced by getSharedAttribute(String, HttpServletRequest) to keep parameter ordering standards for internal code.
static DBSystem	getSystem(javax.servlet.http.HttpServletRequest pRequest) Gets the default DBSystem from the session.
static DBSystem	getSystem(javax.servlet.http.HttpServletRequest pRequest, String pSystemKey) Gets the DBSystem from the session identified by the given key.
static Table	getTable(javax.servlet.http.HttpServletRequest pRequest) Gets the default Table from the session.
static Table	getTable(javax.servlet.http.HttpServletRequest pRequest, String pTableKey) Gets the Table from the session identified by the given key.
static List	getTableList(javax.servlet.http.HttpServletRequest pRequest) Gets the default list of tables from the session.
static List	getTableList(javax.servlet.http.HttpServletRequest pRequest, String pTableListKey) Gets a list of tables from the session identified by the given key.
static UserProperties	getUserProperties(javax.servlet.http.HttpServletRequest request) Deprecated. replaced with method in DataEngineManager
static UserProperties	getUserProperties(javax.servlet.http.HttpServletRequest request, boolean create) Deprecated. replaced with method in DataEngineManager
static UserProperties	getUserProperties(javax.servlet.http.HttpServletRequest pRequest, String pUserPropertiesKey) Deprecated. no longer used
static void	invalidateSession(javax.servlet.http.HttpServletRequest request) Invalidates the session for the given request.
static boolean	isValid(javax.servlet.http.HttpServletRequest request) Test to see if the session is valid.
static Object	removeAttribute(String key, javax.servlet.http.HttpServletRequest request) Removes the specified object from the HttpSession.
static Object	removeSessionAttribute(javax.servlet.http.HttpServletRequest pRequest, String pKey) Deprecated. Replaced by removeAttribute(String, HttpServletRequest) to keep consistant parameter ordering standards for internal code.
static Object	removeSharedAttribute(String key, javax.servlet.http.HttpServletRequest request) Removes an object in the HttpSession using the given key.
static Object	removeSharedSessionAttribute(javax.servlet.http.HttpServletRequest pRequest, String pKey) Deprecated. Replaced with removeSharedAttribute(String, HttpServletRequest) to keep parameter ordering standards for internal code consistent
static void	setAttribute(String key, Object value, javax.servlet.http.HttpServletRequest request) Sets the given Object in the HttpSession using the given key.
static void	setLastRequestId(Integer id, javax.servlet.http.HttpServletRequest request) Deprecated. no longer used
static void	setLastRequestId(int id, javax.servlet.http.HttpServletRequest request) Deprecated. no longer used
static void	setRowCollection(RowCollection rc, javax.servlet.http.HttpServletRequest request) Deprecated. RowCollection's should now be set as request page attributes HttpRequestManager.setPageAttribute(String, Object, HttpServletRequest)
static void	setSessionAttribute(javax.servlet.http.HttpServletRequest pRequest, String pKey, Object pValue) Deprecated. Replaced with setAttribute(String, Object, HttpServletRequest) to keep up parameter ordering standards with internal code.
static void	setSharedAttribute(String key, Object value, javax.servlet.http.HttpServletRequest request) Puts the given Object in the request's session for the given key.
static void	setSharedSessionAttribute(javax.servlet.http.HttpServletRequest pRequest, String pKey, Object pValue) Deprecated. Replaced with setSharedAttribute(String, Object, HttpServletRequest)
static void	setUserProperties(javax.servlet.http.HttpServletRequest pRequest, UserProperties props) Deprecated. replaced with method in DataEngineManager

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_VALID_CHECKED

public static final String SESSION_VALID_CHECKED

See Also:

Constant Field Values

SESSION_VALID

public static final String SESSION_VALID

See Also:

Constant Field Values

Constructor Detail

SessionManager

public SessionManager()

Method Detail

getAttribute

public static Object getAttribute(String sessionId,
                                  String key,
                                  javax.servlet.http.HttpServletRequest request)

Deprecated.

Gets an object from the HttpSession using the given key. This provides a single place with potential error logging and programatic debug instead of all users getting objects from the session. Note: this method is used only by the SessionManager for getting objects out of the session. The key passed in as a parameter should already contain an application's unique session identifier as its prefix.

Parameters:

request - request to which to get the session from

Returns:

Object

getAttribute

public static Object getAttribute(String key,
                                  javax.servlet.http.HttpServletRequest request)

Gets an object from the HttpSession using the given key. This provides a single place with potential error logging and programatic debug instead of all users getting objects from the session. Note: this method is used only by the SessionManager for getting objects out of the session. The key passed in as a parameter should already contain an application's unique session identifier as its prefix.

Parameters:

request - request to which to get the session from

Returns:

Object

getAttributes

public static Map getAttributes(javax.servlet.http.HttpServletRequest request)

Gets the HttpSession from the given request for the requests session id. (Creates if doesn't already exist)

Parameters:

request - request to get session from.

Returns:

Map of session attributes

getLastRequestId

public static Integer getLastRequestId(javax.servlet.http.HttpServletRequest request)

Deprecated. no longer used

Gets the last request id out of the session. The request id is incremented for each request the user sends. It is used to detect if the user has used an invalid navigation method.

getLibrary

public static Library getLibrary(javax.servlet.http.HttpServletRequest pRequest)
                          throws DataEngineException

Gets the default Library from the session.

Parameters:

pRequest - request containing session to get Library

Returns:

default Library

DataEngineException

getLibrary

public static Library getLibrary(javax.servlet.http.HttpServletRequest pRequest,
                                 String pLibraryKey)
                          throws DataEngineException

Gets the Library from the session identified by the given key. This method should only be used an application had a need to have mulitple Libraries in the session. Otherwise, getLibrary(HttpServletRequest) should be used.

Parameters:

pRequest - request containing session to get Library from

pLibraryKey - key of the Library in the session

Returns:

Library

DataEngineException

getLibraryList

public static List getLibraryList(javax.servlet.http.HttpServletRequest pRequest)
                           throws DataEngineException

Gets the default list of libraries from the session.

Parameters:

pRequest - request containing session to get library list from

Returns:

default library list

DataEngineException

getLibraryList

public static List getLibraryList(javax.servlet.http.HttpServletRequest pRequest,
                                  String pLibraryListKey)
                           throws DataEngineException

Gets a list of libraries from the session identified by the given key. This method should only be used an application had a need to have mulitple library lists in the session. Otherwise, getLibraryList(HttpServletRequest) should be used.

Parameters:

pRequest - request containing session to get the library list from

pLibraryListKey - key of the library list in the session

Returns:

list of libraries

DataEngineException

getRow

public static Row getRow(javax.servlet.http.HttpServletRequest pRequest,
                         String pRowKey)

Deprecated. Row's should no be set on the request as a persistent or page attribute. call HttpRequestManager.getAttribute(String, HttpSerlvetRequest)

Gets the Row from the session identified by the given key. This method should only be used an application had a need to have mulitple Rows in the session. Otherwise, getRow(HttpServletRequest) should be used.

Parameters:

pRequest - request containing session to get Row from

pRowKey - key of the Row in the session

Returns:

Row

getRowCollection

public static RowCollection getRowCollection(javax.servlet.http.HttpServletRequest request)

Deprecated. RowCollection's should no be set on the request as a persistent or page attribute. call HttpRequestManager.getAttribute(String, HttpSerlvetRequest)

Gets the default RowCollection from the session.

Parameters:

request - request containing session to get RowCollection from

Returns:

default RowCollection

getRowCollection

public static RowCollection getRowCollection(javax.servlet.http.HttpServletRequest pRequest,
                                             String pRowCollectionKey)

Deprecated. RowCollection's should no be set on the request as a persistent or page attribute. call HttpRequestManager.getAttribute(String, HttpSerlvetRequest)

Gets the RowCollection from the session identified by the given key. This method should only be used an application had a need to have mulitple RowCollections in the session. Otherwise, getRowCollection(HttpServletRequest) should be used.

Parameters:

pRequest - request containing session to get RowCollection from

pRowCollectionKey - key of the RowCollection in the session

Returns:

RowCollection

getSessionAttribute

public static Object getSessionAttribute(javax.servlet.http.HttpServletRequest request,
                                         String key)
                                  throws DataEngineException

Deprecated. Replaced with getAttribute(String, HttpServletRequest) to keep up parameter ordering standards with internal code.

Gets an object from the HttpSession using the given key prefixed by the application's (requesting the object) unique session identifier, This provides a single place with potential error logging and programatic debug instead of all users getting objects from the session. It also allows for multiple applications to use the same session without overriding each others objects keyed in the session with the same key.

Returns:

Object

DataEngineException

getSessionAttribute

public static Object getSessionAttribute(javax.servlet.http.HttpServletRequest pRequest,
                                         String pKey,
                                         String uniqueSessionId)
                                  throws DataEngineException

Deprecated. Replaced with getAttribute(String, String, HttpServletRequest) as of (10/8/2002 10:00:12 PM) to keep parameter ordering standards of internal code consistent

Gets an object from the HttpSession using the given key prefixed by the application's (requesting the object) unique session identifier, This provides a single place with potential error logging and programatic debug instead of all users getting objects from the session. It also allows for multiple applications to use the same session without overriding each others objects keyed in the session with the same key.

Parameters:

pRequest - request to which to get the session from

pKey - key of the object to retrieve out of the session

Returns:

Object

DataEngineException

getSessionRandomNumber

public static final int getSessionRandomNumber(javax.servlet.http.HttpServletRequest req)

Gets a random number unique to this session. This method always returns the same random number as long as the session is the same

getSharedAttribute

public static Object getSharedAttribute(String key,
                                        javax.servlet.http.HttpServletRequest request)

Gets an object from the HttpSession using the given key. This provides a single place with potential error logging and programatic debug instead of all users getting objects from the session. Note: this method is used only by the SessionManager for getting objects out of the session. The key passed in as a parameter should already contain an application's unique session identifier as its prefix.

Parameters:

request - request to which to get the session from

Returns:

Object

getSharedSessionAttribute

public static Object getSharedSessionAttribute(javax.servlet.http.HttpServletRequest pRequest,
                                               String pKey)

Deprecated. Replaced by getSharedAttribute(String, HttpServletRequest) to keep parameter ordering standards for internal code.

Gets an object in the HttpSession using the given key. The key will not be prefixed with the application's unique session identifier, thus being retrieving a shared session attribute.

Parameters:

pRequest - request to which to get the session from

pKey - key of the object to retrieve out of the session

Returns:

Object

getSystem

public static DBSystem getSystem(javax.servlet.http.HttpServletRequest pRequest)
                          throws DataEngineException

Gets the default DBSystem from the session.

Parameters:

pRequest - request containing session to get DBSystem

Returns:

default DBSystem

DataEngineException

getSystem

public static DBSystem getSystem(javax.servlet.http.HttpServletRequest pRequest,
                                 String pSystemKey)
                          throws DataEngineException

Gets the DBSystem from the session identified by the given key. This method should only be used an application had a need to have mulitple DBSystems in the session. Otherwise, getSystem(HttpServletRequest) should be used.

Parameters:

pRequest - request containing session to get DBSystem from

pSystemKey - key of the DBSystem in the session

Returns:

DBSystem

DataEngineException

getTable

public static Table getTable(javax.servlet.http.HttpServletRequest pRequest)
                      throws DataEngineException

Gets the default Table from the session.

Parameters:

pRequest - request containing session to get Table from

Returns:

default Table

DataEngineException

getTable

public static Table getTable(javax.servlet.http.HttpServletRequest pRequest,
                             String pTableKey)
                      throws DataEngineException

Gets the Table from the session identified by the given key. This method should only be used an application had a need to have mulitple Tables in the session. Otherwise, getTable(HttpServletRequest) should be used.

Parameters:

pRequest - request containing session to get Table from

pTableKey - key of the Table in the session

Returns:

Table

DataEngineException

getTableList

public static List getTableList(javax.servlet.http.HttpServletRequest pRequest)
                         throws DataEngineException

Gets the default list of tables from the session.

Parameters:

pRequest - request containing session to get table list from

Returns:

default table list

DataEngineException

getTableList

public static List getTableList(javax.servlet.http.HttpServletRequest pRequest,
                                String pTableListKey)
                         throws DataEngineException

Gets a list of tables from the session identified by the given key. This method should only be used an application had a need to have mulitple table lists in the session. Otherwise, getTableList(HttpServletRequest) should be used.

Parameters:

pRequest - request containing session to get the table list from

pTableListKey - key of the table list in the session

Returns:

list of tables

DataEngineException

getUserProperties

public static UserProperties getUserProperties(javax.servlet.http.HttpServletRequest request)
                                        throws DataEngineException

Deprecated. replaced with method in DataEngineManager

Gets the default UserProperties from the session.

Returns:

default UserProperties

DataEngineException

getUserProperties

public static UserProperties getUserProperties(javax.servlet.http.HttpServletRequest pRequest,
                                               String pUserPropertiesKey)
                                        throws DataEngineException

Deprecated. no longer used

Gets the UserProperties from the session identified by the given key. This method should only be used an application had a need to have mulitple UserProperties in the session. Otherwise, getUserProperties(HttpServletRequest) should be used.

Parameters:

pRequest - request containing session to get UserProperties from

pUserPropertiesKey - key of the UserProperties in the session

Returns:

UserProperties

DataEngineException

getUserProperties

public static UserProperties getUserProperties(javax.servlet.http.HttpServletRequest request,
                                               boolean create)
                                        throws DataEngineException

Deprecated. replaced with method in DataEngineManager

Gets the default UserProperties from the session.

Returns:

default UserProperties

DataEngineException

invalidateSession

public static void invalidateSession(javax.servlet.http.HttpServletRequest request)

Invalidates the session for the given request. Removes all objects from session for given request's session id.

isValid

public static boolean isValid(javax.servlet.http.HttpServletRequest request)

Test to see if the session is valid.

removeAttribute

public static Object removeAttribute(String key,
                                     javax.servlet.http.HttpServletRequest request)

Removes the specified object from the HttpSession. This provides a single place with potential error logging and programatic debug instead of all users setting objects into the Session. Note: this method is used only by the SessionManager for removing Objects from the session. The key passed in as a parameter should already contain an application's unique session identifier as its prefix.

removeSessionAttribute

public static Object removeSessionAttribute(javax.servlet.http.HttpServletRequest pRequest,
                                            String pKey)
                                     throws DataEngineException

Deprecated. Replaced by removeAttribute(String, HttpServletRequest) to keep consistant parameter ordering standards for internal code.

Removes the specified object from the HttpSession using the given key prefixed by the application's (requesting the object) unique session identifier, This provides a single place with potential error logging and programatic debug instead of all users getting objects from the session. It also allows for multiple applications to use the same session without overriding each others objects keyed in the session with the same key.

Parameters:

pRequest - request containing session to remove object from

pKey - key used to identify which object to remove from session

DataEngineException

removeSharedAttribute

public static Object removeSharedAttribute(String key,
                                           javax.servlet.http.HttpServletRequest request)

Removes an object in the HttpSession using the given key. This will not use the request session id to remove an object.

removeSharedSessionAttribute

public static Object removeSharedSessionAttribute(javax.servlet.http.HttpServletRequest pRequest,
                                                  String pKey)
                                           throws DataEngineException

Deprecated. Replaced with removeSharedAttribute(String, HttpServletRequest) to keep parameter ordering standards for internal code consistent

Removes an object in the HttpSession using the given key. The key will not be prefixed with the application's unique session identifier, thus removing a shared session attribute.

Parameters:

pRequest - request containing session to remove object from

pKey - key used to identify which object to remove from session

DataEngineException

setAttribute

public static void setAttribute(String key,
                                Object value,
                                javax.servlet.http.HttpServletRequest request)

Sets the given Object in the HttpSession using the given key. This provides a single place with potential error logging and programatic debug instead of all users getting Objects from the session. Note: this method is used only by the SessionManager for setting Objects in the session. The key passed in as a parameter should already contain an application's unique session identifier as its prefix.

setLastRequestId

public static void setLastRequestId(int id,
                                    javax.servlet.http.HttpServletRequest request)

Deprecated. no longer used

Sets the last request id into the session. The request id is incremented for each request the user sends. It is used to detect if the user has used an invalid navigation method.

setLastRequestId

public static void setLastRequestId(Integer id,
                                    javax.servlet.http.HttpServletRequest request)

Deprecated. no longer used

Sets the last request id into the session. The request id is incremented for each request the user sends. It is used to detect if the user has used an invalid navigation method.

setRowCollection

public static void setRowCollection(RowCollection rc,
                                    javax.servlet.http.HttpServletRequest request)

Deprecated. RowCollection's should now be set as request page attributes HttpRequestManager.setPageAttribute(String, Object, HttpServletRequest)

sets the default RowCollection in the session.

setSessionAttribute

public static void setSessionAttribute(javax.servlet.http.HttpServletRequest pRequest,
                                       String pKey,
                                       Object pValue)
                                throws DataEngineException

Deprecated. Replaced with setAttribute(String, Object, HttpServletRequest) to keep up parameter ordering standards with internal code.

Sets an object in the HttpSession using the given key prefixed by the application's (requesting the object) unique session identifier, This provides a single place with potential error logging and programatic debug instead of all users getting objects from the session. It also allows for multiple applications to use the same session without overriding each others objects keyed in the session with the same key.

Parameters:

pRequest - request used to get the session to put the given object into

pKey - key used for setting the object in the session

pValue - object being set in the session

DataEngineException

setSharedAttribute

public static void setSharedAttribute(String key,
                                      Object value,
                                      javax.servlet.http.HttpServletRequest request)

Puts the given Object in the request's session for the given key.

Parameters:

key - key to store/retrieve the given Object to/from the session

value - Object to put in the session

request - HttpSerlvetRequest containing session to put Object in

setSharedSessionAttribute

public static void setSharedSessionAttribute(javax.servlet.http.HttpServletRequest pRequest,
                                             String pKey,
                                             Object pValue)
                                      throws DataEngineException

Deprecated. Replaced with setSharedAttribute(String, Object, HttpServletRequest)

Sets an object in the HttpSession using the given key. The key will not be prefixed with the application's unique session identifier, thus being a shared session attribute.

Parameters:

pRequest - request used to get the session to put the given object into

pKey - key used for setting the object in the session

pValue - object being set in the session

DataEngineException

setUserProperties

public static void setUserProperties(javax.servlet.http.HttpServletRequest pRequest,
                                     UserProperties props)
                              throws DataEngineException

Deprecated. replaced with method in DataEngineManager

DataEngineException