com.beasys.commerce.portal.admin
Class PortalAdminHelper

java.lang.Object
  |
  +--com.beasys.commerce.axiom.jsp.JspHelper
        |
        +--com.beasys.commerce.portal.admin.PortalAdminHelper

public class PortalAdminHelper

extends JspHelper

implements PortalAdminConstants

Provides several utility services which facilitate portal run-time operation. These services assist in cookie and session management, Portal traffic routing, encoding/decoding, PortalManager access, and license management.

Fields inherited from interface com.beasys.commerce.portal.admin.PortalAdminConstants

PORTAL_MANAGER_A, PORTAL_NAME

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

PortalAdminHelper()

Method Summary

static void	checkAccess() Verifies that the correct licensing arrangement is in place for Portal Framework operation.
static PortalManager	getPortalManager() Retrieves a com.beasys.commerce.portal.PortalManager instance.
static PortalManager	getPortalManager(javax.servlet.http.HttpServletRequest aRequest)
static boolean	validSession(javax.servlet.http.HttpServletRequest aRequest) Checks to see if the session has all of the valid values for portal run-time.

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

decode, encode, findCookie, getCookieTimeout, getCookieValue, getDefaultDestination, getDefaultSuccessor, getDequalifiedSessionValues, getLoggedIn, getRepositoryDirectory, getSessionValue, getSessionValue, getTrafficURI, getWorkingDirectory, putSessionValue, putSessionValue, qualifiedName, removeSessionValue, setCookie, setSessionValue, setSessionValue

Methods inherited from class java.lang.Object

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

Constructor Detail

PortalAdminHelper

public PortalAdminHelper()

Method Detail

validSession

public static boolean validSession(javax.servlet.http.HttpServletRequest aRequest)

Checks to see if the session has all of the valid values for portal run-time. Also checks to see the session has timed out.

Parameters:

the - javax.servlet.http.HttpServletRequest from which the session is retreived

Returns:

boolean whether the session is valid

getPortalManager

public static PortalManager getPortalManager(javax.servlet.http.HttpServletRequest aRequest)
                                      throws java.rmi.RemoteException,
                                             PortalCreateException,
                                             PortalException

getPortalManager

public static PortalManager getPortalManager()
                                      throws java.rmi.RemoteException,
                                             PortalCreateException,
                                             PortalException

Retrieves a com.beasys.commerce.portal.PortalManager instance.

Returns:

PortalManager a new PortalManager

Throws:

java.rmi.RemoteException - a remote connection failure

PortalCreateException - failure to create the PortalManager

PortalException - general Portal Framework problem

checkAccess

public static final void checkAccess()

Verifies that the correct licensing arrangement is in place for Portal Framework operation. Causes a System.exit() if the license is not found, or is not properly provisioned. Logs failure reason.