BEA Systems, Inc.

com.beasys.commerce.portal.admin
Class PortalJspBase

java.lang.Object
  |
  +--weblogic.servlet.jsp.JspBase
        |
        +--com.beasys.commerce.axiom.jsp.JspBase
              |
              +--com.beasys.commerce.axiom.p13n.jsp.P13NJspBase
                    |
                    +--com.beasys.commerce.portal.admin.PortalJspBase

public abstract class PortalJspBase
extends P13NJspBase
implements PortalAdminConstants, PortalProfileConstants, JspPages, JspToolPages

Acts as a base class for all Portal JSP pages. Prescribes methods which faciltate portal run-time operation. Allows access to the PortalServiceManager URI, the Portal's working directory, the Portal's home page, the Portal's current page, and the PortalProperties PortalManagerinstantiations. Also, facilitates management of the portal 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.


Fields inherited from class com.beasys.commerce.axiom.jsp.JspBase
DESTINATION_TAG
 
Fields inherited from interface com.beasys.commerce.portal.admin.PortalAdminConstants
PORTAL_MANAGER_A, PORTAL_NAME
 
Fields inherited from interface com.beasys.commerce.portal.PortalProfileConstants
PROFILE_ADDRESS, PROFILE_BANNER_COLOR, PROFILE_BODY_COLOR, PROFILE_CITY, PROFILE_COUNTRY, PROFILE_EMAIL, PROFILE_FIRST, PROFILE_LAST, PROFILE_PORTLET_BG_COLOR, PROFILE_PREFIX, PROFILE_REFRESH, PROFILE_REMINDER, PROFILE_SHOW_BORDERS, PROFILE_STATE, PROFILE_TIMEZONE, PROFILE_TITLE_FONT_COLOR, PROFILE_TITLEBAR_COLOR, PROFILE_ZIP
 
Fields inherited from interface com.beasys.commerce.portal.admin.JspPages
JSP_ALTERNATE_FOOTER, JSP_ALTERNATE_HEADER, JSP_BASE_HEADER, JSP_COLOR_PREFS, JSP_FOOTER, JSP_FULL_SCREEN_PORTLET, JSP_GEN_PREFS, JSP_HEADER, JSP_PORTAL, JSP_PORTAL_CONTENT, JSP_PORTAL_FRAMEWORK_DIRECTORY, JSP_PORTLET, JSP_TITLE_BAR, JSP_USER_ADD_PORTLETS, JSP_USER_HELP_FEATURES, JSP_USER_LAYOUT, JSP_USER_LOGIN, JSP_USER_REG, JSP_USER_REG_SUMMARY
 
Fields inherited from interface com.beasys.commerce.portal.admin.JspToolPages
JSP_TOOLS_ADD_PORTLETS, JSP_TOOLS_ADMIN_LOGIN, JSP_TOOLS_DIRECTORY, JSP_TOOLS_ERROR, JSP_TOOLS_ERROR_FOOTER, JSP_TOOLS_ERROR_HEADER, JSP_TOOLS_GROUP_ADD_PORTLETS, JSP_TOOLS_GROUP_COLORS, JSP_TOOLS_GROUP_HOME, JSP_TOOLS_GROUP_LAYOUT, JSP_TOOLS_GROUP_NEW, JSP_TOOLS_GROUP_PERSONALIZE, JSP_TOOLS_GROUP_USERS, JSP_TOOLS_GROUP_VIEW, JSP_TOOLS_PORTAL_COLORS, JSP_TOOLS_PORTAL_DEV_GUIDE, JSP_TOOLS_PORTAL_GROUPS, JSP_TOOLS_PORTAL_HELP, JSP_TOOLS_PORTAL_HELP_FEATURES, JSP_TOOLS_PORTAL_HOME, JSP_TOOLS_PORTAL_LAYOUT, JSP_TOOLS_PORTAL_NEW, JSP_TOOLS_PORTAL_PERSONALIZE, JSP_TOOLS_PORTAL_REMOVE, JSP_TOOLS_PORTAL_UPDATE, JSP_TOOLS_PORTAL_USERS, JSP_TOOLS_PORTAL_VIEW, JSP_TOOLS_PORTLET_NEW, JSP_TOOLS_PORTLET_REMOVE, JSP_TOOLS_PORTLET_UPDATE
 
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_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_SESSION_TIMEOUT, SERVICEMANAGER_SUCCESSOR, SERVICEMANAGER_USER, TRAFFIC_URI, TRANSACTION_SERVICE, TRANSACTION_TIMEOUT, WORKING_DIR, WORKING_DIR_FILES
 
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_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_SESSION_TIMEOUT, SERVICEMANAGER_SUCCESSOR, SERVICEMANAGER_USER, TRAFFIC_URI, TRANSACTION_SERVICE, TRANSACTION_TIMEOUT, WORKING_DIR, WORKING_DIR_FILES
 
Fields inherited from interface com.beasys.commerce.portal.admin.JspPages
JSP_ALTERNATE_FOOTER, JSP_ALTERNATE_HEADER, JSP_BASE_HEADER, JSP_COLOR_PREFS, JSP_FOOTER, JSP_FULL_SCREEN_PORTLET, JSP_GEN_PREFS, JSP_HEADER, JSP_PORTAL, JSP_PORTAL_CONTENT, JSP_PORTAL_FRAMEWORK_DIRECTORY, JSP_PORTLET, JSP_TITLE_BAR, JSP_USER_ADD_PORTLETS, JSP_USER_HELP_FEATURES, JSP_USER_LAYOUT, JSP_USER_LOGIN, JSP_USER_REG, JSP_USER_REG_SUMMARY
 
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_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_SESSION_TIMEOUT, SERVICEMANAGER_SUCCESSOR, SERVICEMANAGER_USER, TRAFFIC_URI, TRANSACTION_SERVICE, TRANSACTION_TIMEOUT, WORKING_DIR, WORKING_DIR_FILES
 
Constructor Summary
PortalJspBase()
           
 
Method Summary
static PortalManager getPortalManager(javax.servlet.http.HttpServletRequest aRequest)
          Retrieves the com.beasys.commerce.portal.PortalManager out of the request.
static Portlet getPortletFor(java.lang.String aName, Portlet[][] anArray)
          Get portlet for a given name from the 2 dimensional array.
static void setLoggedIn(javax.servlet.http.HttpServletRequest aRequest, javax.servlet.http.HttpServletResponse aResponse, boolean aBool)
          Override and call super class method.
 
Methods inherited from class com.beasys.commerce.axiom.p13n.jsp.P13NJspBase
createP13NProfile, createP13NRequest, createP13NSession
 
Methods inherited from class com.beasys.commerce.axiom.jsp.JspBase
cnvrtSC, createURL, escapeQuotes, fixupRelativeURL, getCurrentPage, getDefaultDestination, getDefaultSuccessor, getHomePage, getLoggedIn, getRepositoryDirectory, getRequestURI, getSessionValue, getTrafficURI, getWorkingDirectory, pathFromRequest, putSessionValue, reconcileFile, removeSessionValue, setAlternateDestination, setOverrideDestination, setSessionValue, setSuccessor, setUser, setUserAndSuccessor
 
Methods inherited from class weblogic.servlet.jsp.JspBase
_jspService, destroy, getServletConfig, getServletInfo, init, jspDestroy, jspInit, service
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortalJspBase

public PortalJspBase()
Method Detail

getPortalManager

public static PortalManager getPortalManager(javax.servlet.http.HttpServletRequest aRequest)
                                      throws java.rmi.RemoteException,
                                             PortalCreateException,
                                             PortalException
Retrieves the com.beasys.commerce.portal.PortalManager out of the request. If it does not exist in the request, a PortalManager will be created.
Parameters:
the - javax.servlet.http.HttpServletRequest from which the PortalManager is sought
Returns:
the current PortalManager

setLoggedIn

public static void setLoggedIn(javax.servlet.http.HttpServletRequest aRequest,
                               javax.servlet.http.HttpServletResponse aResponse,
                               boolean aBool)
Override and call super class method. Then remove the allPortlets value from the session so that it will be refreshed.
Parameters:
aRequest - the javax.servlet.http.HttpServletRequest used to retrieve the session for update
the - corresponding javax.servlet.http.HttpServletResponse
aBool - designates the true or false logged-in value

getPortletFor

public static Portlet getPortletFor(java.lang.String aName,
                                    Portlet[][] anArray)
Get portlet for a given name from the 2 dimensional array. The array has been cached, so get it out and pass it to this convenience method for getting the correct portlet.
Parameters:
aName - the name of the portlet.
anArray - the array to search.
Returns:
Portlet

BEA Systems, Inc.

Copyright © 2000 BEA Systems, Inc. All Rights Reserved