Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2003 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.portal.appflow
Class PortalAppflowHelper

    java.lang.Object
      |
      +--com.bea.portal.appflow.PortalAppflowHelper

public abstract class PortalAppflowHelper
extends Object

An static helper class for assisting in common programming tasks.

Field Summary
`protected static PortalManagerHome` | `portalManagerHome` A cached reference to the PortalManager Home.

Constructor Summary
`PortalAppflowHelper()`

Method Summary
`static PortalManager` | `createPortalManager()` Create a new instance of the PortalManager EJB from the cached PortalManagerHome.
`static com.bea.p13n.appflow.webflow.WebflowExecutor` | `getWebflowExecutor(PortalContext portalContext)` Obtain an instance of the WebflowExecutor.
`static com.bea.p13n.appflow.webflow.WebflowResponse` | `invokePortletWebflow(HttpServletRequest request, HttpServletResponse response, String namespace, String origin, String event, PortalRequest portalRequest, PageState pageState, PortletState portletState)` Invoke a portlet's webflow, and store the final presentation node in the portal's content map.
`static com.bea.p13n.appflow.webflow.WebflowResponse` | `invokeWebflow(HttpServletRequest request, HttpServletResponse response, String namespace, String origin, String event, PortalRequest portalRequest)` Invoke a webflow.
`static com.bea.p13n.appflow.webflow.WebflowResponse` | `invokeWebflow(HttpServletRequest request, HttpServletResponse response, String namespace, String origin, String event, com.bea.p13n.appflow.webflow.WebflowExecutor executor)` Invoke a webflow.
`static void` | `updatePortalSession(HttpServletRequest request, PortalSession portalSession)` Safely updates the PortalSession in the HttpSession and the PortalState.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### portalManagerHome

    protected static PortalManagerHome portalManagerHome

  A cached reference to the PortalManager Home.

Constructor Detail

### PortalAppflowHelper

    public PortalAppflowHelper()

Method Detail

### createPortalManager

    public static PortalManager createPortalManager()
                                             throws RemoteException,
                                                    CreateException

  Create a new instance of the PortalManager EJB from the cached PortalManagerHome.

    `RemoteException`
    `CreateException`

### updatePortalSession

    public static void updatePortalSession(HttpServletRequest request,
                                           PortalSession portalSession)

  Safely updates the PortalSession in the HttpSession and the PortalState.

### getWebflowExecutor

    public static com.bea.p13n.appflow.webflow.WebflowExecutor getWebflowExecutor(PortalContext portalContext)

  Obtain an instance of the WebflowExecutor. Used to invoke portlet webflows.

### invokeWebflow

    public static com.bea.p13n.appflow.webflow.WebflowResponse invokeWebflow(HttpServletRequest request,
                                                                             HttpServletResponse response,
                                                                             String namespace,
                                                                             String origin,
                                                                             String event,
                                                                             PortalRequest portalRequest)
                                                                      throws com.bea.p13n.appflow.exception.ConfigurationException,
                                                                             com.bea.p13n.appflow.exception.WebflowSecurityException

  Invoke a webflow. Used to invoke portlets webflows. A webflow will continue to run until a presentation node is found and that is return in the WebflowResponse.

    `com.bea.p13n.appflow.exception.ConfigurationException`
    `com.bea.p13n.appflow.exception.WebflowSecurityException`

### invokeWebflow

    public static com.bea.p13n.appflow.webflow.WebflowResponse invokeWebflow(HttpServletRequest request,
                                                                             HttpServletResponse response,
                                                                             String namespace,
                                                                             String origin,
                                                                             String event,
                                                                             com.bea.p13n.appflow.webflow.WebflowExecutor executor)
                                                                      throws com.bea.p13n.appflow.exception.ConfigurationException,
                                                                             com.bea.p13n.appflow.exception.WebflowSecurityException

  Invoke a webflow. Used to invoke portlets webflows. A webflow will continue to run until a presentation node is found and that is return in the WebflowResponse.

  Throws:
    `com.bea.p13n.appflow.exception.WebflowSecurityException` - Throws a security exception if a successful login has been invoked or a proctedted node has been reached which requires login.
    `com.bea.p13n.appflow.exception.ConfigurationException`

### invokePortletWebflow

    public static com.bea.p13n.appflow.webflow.WebflowResponse invokePortletWebflow(HttpServletRequest request,
                                                                                    HttpServletResponse response,
                                                                                    String namespace,
                                                                                    String origin,
                                                                                    String event,
                                                                                    PortalRequest portalRequest,
                                                                                    PageState pageState,
                                                                                    PortletState portletState)
                                                                             throws com.bea.p13n.appflow.exception.ConfigurationException,
                                                                                    com.bea.p13n.appflow.exception.WebflowSecurityException

  Invoke a portlet's webflow, and store the final presentation node in the portal's content map.

    `com.bea.p13n.appflow.exception.ConfigurationException`
    `com.bea.p13n.appflow.exception.WebflowSecurityException`

Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2003 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2003 BEA Systems, Inc. All Rights Reserved