com.plumtree.remote.portlet
Interface IPortletContext

public interface IPortletContext

IPortletContext is the root interface for retrieving information from the portal. Generally, the Portlet obtains an IPortletContext by using the PortletContextFactory.createPortletContext() static factory method.

Method Summary

ICredentialProvider	getCredentialProvider() Returns an instance of an ICredentialProvider for the current portlet request.
ICredentialSetter	getCredentialSetter() Returns an instance of an ICredentialSetter for the current portlet response.
IRemoteSession	getRemotePortalSession() Returns an IRemoteSession, which is a way to call the portal’s remote API to query information and perform actions on the portal.
IPortletRequest	getRequest() Returns an IPortletRequest representing the HTTP request for this Portlet.
IPortletResponse	getResponse() Returns an IPortletResponse representing the HTTP response for this Portlet.
IPortletUser	getUser() Returns an IPortletUser representing the user currently calling the Portlet.

Method Detail

getRequest

public IPortletRequest getRequest()

Returns an IPortletRequest representing the HTTP request for this Portlet.

Returns:

IPortletRequest

getResponse

public IPortletResponse getResponse()

Returns an IPortletResponse representing the HTTP response for this Portlet.

Returns:

IPortletResponse

getUser

public IPortletUser getUser()

Returns an IPortletUser representing the user currently calling the Portlet.

Returns:

IPortletUser

getRemotePortalSession

public IRemoteSession getRemotePortalSession()
                                      throws NotInRequestException,
                                             java.net.MalformedURLException

Returns an IRemoteSession, which is a way to call the portal’s remote API to query information and perform actions on the portal. The IRemoteSession passed back will be initialized with a login token and endpoint URL sent by the portal. Because it is using a login token, the Remote Session will have the same security context in the portal as the user of the Portlet. Note: The login token and endpoint URL are only sent in version 5.0 and above. The administrator must configure the portal to send the login token to the Portlet.

Returns:

IRemoteSession

Throws:

NotGatewayedException - if the request is not gatewayed

ProtocolNotSupportedException - if used with a portal version earlier than 5.0

NotInRequestException - if the administrator has chosen not to send the login token to this Portlet

java.net.MalformedURLException - if the endpoint URL is not valid

getCredentialProvider

public ICredentialProvider getCredentialProvider()

Returns an instance of an ICredentialProvider for the current portlet request.

getCredentialSetter

public ICredentialSetter getCredentialSetter()

Returns an instance of an ICredentialSetter for the current portlet response.

Throws:

ProtocolNotSupportedException - if the portlet was sent credentials from the Credential Vault. A portlet cannot set the Credential Vault values.