PortalAppflowFactory Class

DEPRECATED com.bea.portal is only useful in the compatibility domain. For the new portal framework please use the classes under the com.bea.netuix package

com.bea.portal.appflow
PortalAppflowFactory Class

public abstract class PortalAppflowFactory

    extends Object
    implements com.bea.portal.appflow.PortalAppflowConstants

A common factory for creating portal objects.

Hierarchy
Object
  PortalAppflowFactory
All Implemented Interfaces

com.bea.portal.appflow.PortalAppflowConstants

Constructor Summary
PortalAppflowFactory()
 

Method Summary
public static PortalAppflowEvent
createPortalAppflowEvent(HttpServletRequest request, Portal portal)
Create a new PortalAppflowEvent from the HttpServletRequest parameters.
public static PortalAppflowEvent
createPortalAppflowEvent(String namespace, String origin, String event, PageIdentifier pageId, PortletIdentifier portletId)
Create a new Instance of the PortalAppflowEvent from the supplied parameters.
public static PortalContext
createPortalContext(ServletContext context)
Return a new instance of the portalContext
public static PortalRequest
createPortalRequest(PortalContext context, Portal portal, HttpServletRequest request)
Creates a PortalRequest.
public static PortalRequest
createPortalRequest(PortalContext context, Portal portal, HttpServletRequest request, boolean createNew)
Creates a PortalRequest.
public static PortalSession
createPortalSession(HttpServletRequest request)
Creates a PortalSession.
public static PortalSession
createPortalSession(HttpServletRequest request, boolean createNew)
Creates a PortalSession.
public static PortalRequest
getPortalRequest(HttpServletRequest request)
Retrieve the portal request from the HttpServletRequest.
public static PortalSession
getPortalSession(HttpServletRequest request)
Retrieve an instance of the PortalSession from the HttpSession.
public static void
setPortalSession(HttpServletRequest request, PortalSession portalSession)
Put an instance of the PortalSession in the HttpSerssion.
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Constructor Detail

PortalAppflowFactory

public PortalAppflowFactory()
 

Method Detail

createPortalAppflowEvent(HttpServletRequest, Portal) Method

public static PortalAppflowEvent createPortalAppflowEvent(HttpServletRequest request, 
                                                          Portal portal)
Create a new PortalAppflowEvent from the HttpServletRequest parameters. If the request does not a namespace, use the Portal's webflow namespace. If the Portlet identifier is passed in the request, create a PortletIdentifier and set the namespace to the associated Portlet's namespace. If a Page Identifier is passed in create a PageIdentifier.

Related Topics

PortalAppflowConstants

createPortalAppflowEvent(String, String, String, PageIdentifier, PortletIdentifier) Method

public static PortalAppflowEvent createPortalAppflowEvent(String namespace, 
                                                          String origin, 
                                                          String event, 
                                                          PageIdentifier pageId, 
                                                          PortletIdentifier portletId)
Create a new Instance of the PortalAppflowEvent from the supplied parameters.

createPortalContext(ServletContext) Method

public static PortalContext createPortalContext(ServletContext context)
Return a new instance of the portalContext

createPortalRequest(PortalContext, Portal, HttpServletRequest) Method

public static PortalRequest createPortalRequest(PortalContext context, 
                                                Portal portal, 
                                                HttpServletRequest request)
Creates a PortalRequest. If one already exist in the HttpServletRequest then that will be returned, otherwise a new one will be created.

createPortalRequest(PortalContext, Portal, HttpServletRequest, boolean) Method

public static PortalRequest createPortalRequest(PortalContext context, 
                                                Portal portal, 
                                                HttpServletRequest request, 
                                                boolean createNew)
Creates a PortalRequest. If createNew is true the a new one will always be created. If createNew is false then it will first look in the HttpServletRequest for an existing PortalRequest and if that exist return that one, otherwise create a new one.

createPortalSession(HttpServletRequest) Method

public static PortalSession createPortalSession(HttpServletRequest request)
Creates a PortalSession. If one already exist in the HttpSession then that will be returned, otherwise a new one will be created.

createPortalSession(HttpServletRequest, boolean) Method

public static PortalSession createPortalSession(HttpServletRequest request, 
                                                boolean createNew)
Creates a PortalSession. If createNew is true the a new one will always be created. If createNew is false then it will first look in the HttpSession for an existing PortalRequest and if that exist return that one, otherwise create a new one.

getPortalRequest(HttpServletRequest) Method

public static PortalRequest getPortalRequest(HttpServletRequest request)
Retrieve the portal request from the HttpServletRequest. If one does not exist return null.

getPortalSession(HttpServletRequest) Method

public static PortalSession getPortalSession(HttpServletRequest request)
Retrieve an instance of the PortalSession from the HttpSession.

setPortalSession(HttpServletRequest, PortalSession) Method

public static void setPortalSession(HttpServletRequest request, 
                                    PortalSession portalSession)
Put an instance of the PortalSession in the HttpSerssion.