Overview | Package | Class | Tree | Deprecated | Index | Help
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

## Package com.plumtree.remote.portlet

Provides classes and interfaces for building portlets for the Plumtree Corporate Portal.

See:
Description

Interface Summary
ICredentialProvider | `ICredentialProvider` is an interface for retrieving the username and password for a backend application that were sent to the portlet in the headers.
ICredentialSetter | `ICredentialSetter` is an interface for encrypting and setting the username and password for a backend application on a `PortletResponse`.
IPortletContext | `IPortletContext` is the root interface for retrieving information from the portal.
IPortletRequest | `IPortletRequest` represents the HTTP request sent from the portal to the Portlet.
IPortletResponse | `IPortletResponse` represents the HTTP response sent from the Portlet to the portal.
IPortletUser | `IPortletUser` represents the current user requesting the Portlet.

Class Summary
AggregationMode | `AggregationMode` is a flag that tells the portal how the Portlet is currently displayed in the portal, i.e., with other Portlets or alone on the page.
Alignment | A type-safe enumeration that identifies the alignment of a portlet.
CommunityAccessLevel | `CommunityAccessLevel` enumerates the access levels that a user can have for a particular Community.
CredentialSource | `CredentialSource` is an enumeration of the different locations in the `IPortletRequest` headers where credentials can be passed.
EncryptionType | `EncryptionType` is an enumeration of the different types of encryption that can be used.
HostedDisplayMode | `HostedDisplayMode` is an enumeration of the types of ways a gatewayed page can be displayed by the portal, i.e., with the portal banner or without.
PortletContextFactory | `PortletContextFactory` is a class that has one static factory method to generate `IPortletContext` objects.
PortletMode | `PortletMode` is an enumerated type that identifies the mode the portal is using to generate the Portlet content.
SettingType | A type-safe enumeration of the different types of settings that can be used by a portlet.
UserInterface | `UserInterface` is an enumeration that describes the different kinds of user interfaces (e.g., phone, PDA) that can be used in the portal.

Exception Summary
NotGatewayedException | Thrown when a user attempts to access API functionality that is only available when the request is gatewayed.
NotInCommunityException | Thrown when a user attempts to access Community-related API functionality that is only available when the Portlet is displayed in a Community page.
NotInRequestException | Thrown when a user attempts to access settings that the administrator has not configured to be sent to the Portlet.
ProtocolNotSupportedException | Thrown when a user attempts to access functionality in a version of the portal that does not support it.

## Package com.plumtree.remote.portlet Description

Provides classes and interfaces for building portlets for the Plumtree Corporate Portal. Replaces the Plumtree GDK 3.5.

Note: In earlier versions of Plumtree, Portlets were called Gadgets.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

For additional information on the IDK, including tutorials, blogs, code samples and more,see the AquaLogic User Interaction Developer Center on BEA dev2dev.

Copyright ©2007 BEA Systems, Inc. All Rights Reserved.