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

public interface PortalSession

Information about the current user's portal session is stored in the `PortalSession`. The `PortalSession` is synonymous with the HttpSession. A reference to the user's PortalSession can be obtained via the `PortalRequest` or the `PortalAppflowFactory`

Related Topics

``PortalRequest``
``PortalAppflowFactory``

## Field Summary

`public static final `String`` | `KEY` The HttpSession parameter key used to store the PortalSession under.

## Method Summary

`public `WebflowResponse`` | `getContentForPortlet`(`PageIdentifier` pageId, `PortletIdentifier` portletId) Retrieve the stored WebflowResponse (content) for the given portlet.
`public boolean` | `getDoAutoLogin`() Return the instance of autoLogin.
`public `PortletIdentifier`` | `getEditPortlet`(`PageIdentifier` pageId) Retrieve the portlet that is in edit mode on this page.
`public `ProfileIdentity`` | `getIdentity`() Return the current usr's profile identity
`public `PortletIdentifier`` | `getMaximizedPortlet`(`PageIdentifier` pageId) Get the maximized portlet for this page.
`public `Map`` | `getMinimizedPortlets`(`PageIdentifier` pageId) Return a map of all the minimized portlets on a page.
`public void` | `invalidate`() Invalidate the PortalSession.
`public boolean` | `isPortletEdited`(`PageIdentifier` pageId) Is a portlet on the page in edit mode?
`public boolean` | `isPortletMaximized`(`PageIdentifier` pageId) Is a portlet in the maximized mode.
`public `Boolean`` | `isPortletMinimized`(`PageIdentifier` pageId, `PortletIdentifier` portletId) Is a portlet in the minimized mode.
`public void` | `setContentForPortlet`(`PageIdentifier` pageId, `PortletIdentifier` portletId, `WebflowResponse` response) Update the content map for the supplied portlets.
`public void` | `setDoAutoLogin`(boolean value) Setter for the instance variable doAutoLogin.
`public void` | `setEditPortlet`(`PageIdentifier` pageId, `PortletIdentifier` portletId) Set this portlet into edit mode.
`public void` | `setIdentity`(`ProfileIdentity` identity) Set the current user's profile identity.
`public void` | `setMaximizedPortlet`(`PageIdentifier` pageId, `PortletIdentifier` portletId) Put a portlet into maximize mode.
`public void` | `setMinimizedPortlet`(`PageIdentifier` pageId, `PortletIdentifier` portletId, boolean minimized) Set a portlet in.out minimized mode.

## Field Detail

### KEY

    public static final String KEY

  The HttpSession parameter key used to store the PortalSession under.

## Method Detail

### getContentForPortlet(PageIdentifier, PortletIdentifier) Method

    public WebflowResponse getContentForPortlet(PageIdentifier pageId,
                                                PortletIdentifier portletId)

Retrieve the stored WebflowResponse (content) for the given portlet.

### getDoAutoLogin() Method

    public boolean getDoAutoLogin()

Return the instance of autoLogin. Used by autoLogin to prevent continuous retries on a failed auto login attempt and set after logout.

### getEditPortlet(PageIdentifier) Method

    public PortletIdentifier getEditPortlet(PageIdentifier pageId)

Retrieve the portlet that is in edit mode on this page.

#### Returns

portlet that is in edit mode on the given page, if no portlet is in edit mode the null is returned.

### getIdentity() Method

    public ProfileIdentity getIdentity()

Return the current usr's profile identity

Related Topics

``ProfileIdentity``

### getMaximizedPortlet(PageIdentifier) Method

    public PortletIdentifier getMaximizedPortlet(PageIdentifier pageId)

Get the maximized portlet for this page. If no portlet is maximized on this page then return null.

Related Topics

``MaximizeProcessor``

### getMinimizedPortlets(PageIdentifier) Method

    public Map getMinimizedPortlets(PageIdentifier pageId)

Return a map of all the minimized portlets on a page.

### invalidate() Method

    public void invalidate()

Invalidate the PortalSession. Clear all instance variables. This is called when the user is logged out.

### isPortletEdited(PageIdentifier) Method

    public boolean isPortletEdited(PageIdentifier pageId)

Is a portlet on the page in edit mode? Only one portlet per page can be in edit mode.

#### Returns

true if a portlet is in edit mode on this page.

### isPortletMaximized(PageIdentifier) Method

    public boolean isPortletMaximized(PageIdentifier pageId)

Is a portlet in the maximized mode. Only one portlet per page can be maximized.

#### Returns

true is the portlet is maximized.

### isPortletMinimized(PageIdentifier, PortletIdentifier) Method

    public Boolean isPortletMinimized(PageIdentifier pageId,
                                      PortletIdentifier portletId)

Is a portlet in the minimized mode.

#### Returns

true is the portlet is minimized.

### setContentForPortlet(PageIdentifier, PortletIdentifier, WebflowResponse) Method

    public void setContentForPortlet(PageIdentifier pageId,
                                     PortletIdentifier portletId,
                                     WebflowResponse response)

Update the content map for the supplied portlets. This is usually called after invoking a portlet's webflow.

### setDoAutoLogin(boolean) Method

    public void setDoAutoLogin(boolean value)

Setter for the instance variable doAutoLogin.

### setEditPortlet(PageIdentifier, PortletIdentifier) Method

    public void setEditPortlet(PageIdentifier pageId,
                               PortletIdentifier portletId)

Set this portlet into edit mode.

Related Topics

``EditProcessor``

### setIdentity(ProfileIdentity) Method

    public void setIdentity(ProfileIdentity identity)

Set the current user's profile identity. This is done automatically by the security processors upon successful login.

### setMaximizedPortlet(PageIdentifier, PortletIdentifier) Method

    public void setMaximizedPortlet(PageIdentifier pageId,
                                    PortletIdentifier portletId)

Put a portlet into maximize mode. Only one portlet per page can be maximized. Note: maximize is different the unminimize.

### setMinimizedPortlet(PageIdentifier, PortletIdentifier, boolean) Method

    public void setMinimizedPortlet(PageIdentifier pageId,
                                    PortletIdentifier portletId,
                                    boolean minimized)

Set a portlet in.out minimized mode.