com.beasys.commerce.axiom.p13n.jsp
Class P13NJspBase

com.beasys.commerce.axiom.jsp.JspBase
  |
  +--com.beasys.commerce.axiom.p13n.jsp.P13NJspBase

All Implemented Interfaces:

JspConstants

Direct Known Subclasses:

PortalJspBase

public abstract class P13NJspBase

extends JspBase

An extension of JspBase which provides Personalization Server specific JSP convenience methods.

Fields inherited from class com.beasys.commerce.axiom.jsp.JspBase

debug, DESTINATION_TAG

Fields inherited from interface com.beasys.commerce.axiom.jsp.JspConstants

DATE_FORMAT, DEFAULT_DESTINATION, DEFAULT_SUCCESSOR, DESTINATION_URI, IMMUTABLE_SERVICEMANAGER_HOME_PAGE, JSP_CALENDAR_FEATURES, JSP_COMMERCE_CALENDAR_FEATURES, JSP_PORTALS_BASE_DIRECTORY, JSP_TOOLS_ADMIN_HOME, JSP_TOOLS_BASE_DIRECTORY, JSP_TOOLS_DOC_RTR, JSP_TOOLS_GUIDE_FEATURES, JSP_TOOLS_PROPERTYMGMT_ADMIN_HOME, JSP_TOOLS_USERMGMT_ADMIN_HOME, JSP_TOOLS_UTIL_DIRECTORY, P13N_CACHED_REQUEST, P13N_CACHED_SESSION, REPOSITORY_DIR, SERVICEMANAGER_COOKIE_TIMEOUT, SERVICEMANAGER_CURRENT_PAGE, SERVICEMANAGER_HOME_PAGE, SERVICEMANAGER_LOGGED_IN, SERVICEMANAGER_OVERRIDE_BOOK, SERVICEMANAGER_SESSION_TIMEOUT, SERVICEMANAGER_SUCCESSOR, SERVICEMANAGER_USER, SERVLET_CONFIG, TRAFFIC_URI, TRANSACTION_SERVICE, TRANSACTION_TIMEOUT, USER_TRANS_TIMEOUT,

Constructor Summary

P13NJspBase()

Method Summary

ConfigurableEntity	createP13NProfile(javax.servlet.http.HttpServletRequest request) Returns the current user profile in use for the session.
Request	createP13NRequest(javax.servlet.http.HttpServletRequest request) Returns a P13N Request that acts as a surrogate for an HTTP request.
Session	createP13NSession(javax.servlet.http.HttpServletRequest request) Returns a P13N Session that acts as a surrogate for an HTTP session.

Methods inherited from class com.beasys.commerce.axiom.jsp.JspBase

cnvrtSC, createURL, escapeQuotes, fixupRelativeURL, getClickThruPage, getCurrentPage, getDefaultDestination, getDefaultSuccessor, getHomePage, getJspURI, getJspURINoContext, getLoggedIn, getRepositoryDirectory, getRequestURI, getServletConfig, getSessionValue, getTrafficURI, getTrafficURINoContext, getWorkingDirectory, pathFromRequest, putSessionValue, reconcileFile, reconcileFile, removeSessionValue, setAlternateDestination, setLoggedIn,

Constructor Detail

P13NJspBase

public P13NJspBase()

Method Detail

createP13NSession

public Session createP13NSession(javax.servlet.http.HttpServletRequest request)
                          throws java.lang.IllegalArgumentException

Returns a P13N Session that acts as a surrogate for an HTTP session. This method will return the cached P13N Session if it exists. If it does not exist, it will create a new one, cache it, and return it. It is cached in the HttpServletRequest with the key JspConstants.P13N_CACHED_SESSION. If you update attributes in the HttpSession they are not changed in a previously cached P13N Session.

Parameters:

request - the request used to create the Session object.

Returns:

a new ConfigurableEntity that allows access to an HttpServletSession

Throws:

java.lang.IllegalArgumentException - If the paramater is null.

createP13NRequest

public Request createP13NRequest(javax.servlet.http.HttpServletRequest request)
                          throws java.lang.IllegalArgumentException

Returns a P13N Request that acts as a surrogate for an HTTP request.

Parameters:

request - the request used to create the Session object.

Returns:

a new ConfigurableEntity that allows access to an HttpServletRequest

Throws:

java.lang.IllegalArgumentException - If the paramater is null.

createP13NProfile

public ConfigurableEntity createP13NProfile(javax.servlet.http.HttpServletRequest request)
                                     throws java.lang.IllegalArgumentException

Returns the current user profile in use for the session.

Parameters:

request - the request used to obtain the profile

Returns:

the session user profile

Throws:

java.lang.IllegalArgumentException - If the paramater is null.