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
PortalRequest Interface

public interface PortalRequest

The PortalRequest is synonymous with the HttpServletRequest it only lives the life of the http request. The PortalRequest has references to the PortalContext, Portal, PortalState, HttpServletRequest and PortalAppflowEvent.

## Field Summary

`public static final `String`` | `KEY` The HttpServletRequest parameter key to which the PortalRequest is stored.

## Method Summary

`public `Portal`` | `getPortal`() Retrieve an instance of the Portal definition.
`public `PortalAppflowEvent`` | `getPortalAppflowEvent`() Retrieve the last appflow event.
`public `PortalContext`` | `getPortalContext`() Retrieve an instance of the portalContext.
`public `PortalSession`` | `getPortalSession`() Creates a PortalSession.
`public `PortalState`` | `getPortalState`() Retrieve an instance of the PortalState.
`public `HttpServletRequest`` | `getServletRequest`() Return a reference the the HttpServletRequest.

## Field Detail

### KEY

    public static final String KEY

  The HttpServletRequest parameter key to which the PortalRequest is stored.

## Method Detail

### getPortal() Method

    public Portal getPortal()

Retrieve an instance of the Portal definition.

Related Topics

``Portal``

### getPortalAppflowEvent() Method

    public PortalAppflowEvent getPortalAppflowEvent()

Retrieve the last appflow event.

Related Topics

``PortalAppflowEvent``

### getPortalContext() Method

    public PortalContext getPortalContext()

Retrieve an instance of the portalContext.

### getPortalSession() Method

    public PortalSession getPortalSession()

Creates a PortalSession. If one already exist in the HttpSession then that will be returned, otherwise a new one will be created. This method just delegates to PortalAppflowFactory.createPortalSession(request).

Related Topics

``PortalAppflowFactory.createPortalSession(HttpServletRequest)``

### getPortalState() Method

    public PortalState getPortalState()

Retrieve an instance of the PortalState. The Portal state differs from the Portal object in that all the personalization and entitlements have been applied. The Portal object just represents the portal definition in the .portal xml file.

Related Topics

``Portal``

### getServletRequest() Method

    public HttpServletRequest getServletRequest()

Return a reference the the HttpServletRequest.