Plumtree EDK (Enterprise Web Development Kit) 5.4.0

IPortletContext.GetRemotePortalSession Method 

Returns an IRemoteSession, which is a way to call the portal’s remote API to query information and perform actions on the portal.

IRemoteSession GetRemotePortalSession();

Return Value

IRemoteSession

Remarks

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.

Exceptions

Exception Type Condition
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
HttpException if the endpoint URL is not valid

See Also

IPortletContext Interface | Plumtree.Remote.Portlet Namespace