com.beasys.commerce.axiom.jsp
Class ToolsJspBase

com.beasys.commerce.axiom.jsp.JspBase
  |
  +--com.beasys.commerce.axiom.jsp.ToolsJspBase

All Implemented Interfaces:

JspConstants

Direct Known Subclasses:

JspHierarchyBase

public abstract class ToolsJspBase

extends JspBase

Acts as a base class for all tools JSP pages. Prescribes methods which faciltate run-time operation. Allows access to the Flow Manager URI, the working directory, and the home page, the current page.Also, facilitates management of the run-time session, by providing convenience methods for setting and getting session values, and setting and getting JSP destinations. Implements several constants interface to reduce the burden of constant referencing by JSP pages.

Field Summary

protected static boolean

debug Whether debug mode is on.

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

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, WORKING_DIR,

Constructor Summary

ToolsJspBase()

Method Summary

static java.lang.String	fixupRelativeURL(java.lang.String aURL, javax.servlet.http.HttpServletRequest aRequest) With the system using jsp:forward the relative directories may not be set employed correctly.
static java.lang.String	reconcileFile(javax.servlet.http.HttpServletRequest aRequest, java.lang.String aURL) Check to see if the file exists in the working directory of the FlowManager application.
static java.lang.String	reconcileFile(javax.servlet.http.HttpServletRequest aRequest, java.lang.String aURL, boolean addWebappContext) Call the reconcileFile method specifying whether any webapp context should be included.

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

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

Field Detail

debug

protected static final boolean debug

Whether debug mode is on. Facilitates debug output for JSP pages.

Constructor Detail

ToolsJspBase

public ToolsJspBase()

Method Detail

fixupRelativeURL

public static java.lang.String fixupRelativeURL(java.lang.String aURL,
                                                javax.servlet.http.HttpServletRequest aRequest)

With the system using jsp:forward the relative directories may not be set employed correctly. Use this method to fixup relative URLs so that they become fully qualified. For example if you are referring to an image in your JSP page as img src="images/dummy.gif", the system may not be able to find it. Change your code to img="<%=fixupRelativeURL("images/dummy.gif")%>. This will ensure that your URL is correct, and not stop you from moving your directory structures around as you wish.

Parameters:

aURL - the url to fixup.

aRequest - the associated request.

Returns:

String the fixed-up URL.

reconcileFile

public static java.lang.String reconcileFile(javax.servlet.http.HttpServletRequest aRequest,
                                             java.lang.String aURL,
                                             boolean addWebappContext)

Call the reconcileFile method specifying whether any webapp context should be included. If requested, any webapp context available will be prepended to the result. Otherwise, it will be suppressed. Server-side operations do not need the context. Client-side path information does. This method may be used for non-webapps and war/non-war webapps.

Parameters:

aURL - the file to check for. This can be a fully qualified url, in which case nothing happens.

aRequest - the request, because we need the repository directory as well as the hashmap associated to the current servlet.

addWebappContext - a flag indicating whether to add or suppress any available webapp context

Returns:

String the reconciled file name. Will return aURL if it is fully qualified or can be found in the working directory.

reconcileFile

public static java.lang.String reconcileFile(javax.servlet.http.HttpServletRequest aRequest,
                                             java.lang.String aURL)

Check to see if the file exists in the working directory of the FlowManager application. It will only check if it is not a fully qualified url (from the document root). If it is in the working directory it will return the file prepended with the working directory. Otherwise it will force it to point to the repository directory structure. Note: calls to reconcileFile for any browser client-side path information must have the context, but calls for server-side processing (i.e. jsp:include) cannot have the context. For this reason, an assumption is made that the only server-side, reconcileFile() calls will be for ".jsp" files. If this is not true, use the other variant of reconcileFile.

Parameters:

aURL - the file to check for. This can be a fully qualified url, in which case nothing happens.

aRequest - the request, because we need the repository directory as well as the hashmap associated to the current servlet.

Returns:

String the reconciled file name. Will return aURL if it is fully qualified or can be found in the working directory.