|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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()
Deprecated. This method will not be supported from IDK6.5. For Remote Session refer to RemoteSessionFactory |
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 this portlet. |
Method Detail |
public IPortletRequest getRequest()
IPortletRequest
representing the HTTP request for this
Portlet.
IPortletRequest
objectpublic IPortletResponse getResponse()
IPortletResponse
representing the HTTP response for this
portlet.
IPortletResponse
objectpublic IPortletUser getUser()
IPortletUser
representing the user currently calling this portlet.
IPortletUser
objectpublic IRemoteSession getRemotePortalSession() throws NotInRequestException, java.net.MalformedURLException
RemoteSessionFactory
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 a portlet.
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 validpublic ICredentialProvider getCredentialProvider()
ICredentialProvider
for the
current portlet request.
public ICredentialSetter getCredentialSetter()
ICredentialSetter
for the
current portlet response.
ProtocolNotSupportedException
- if the portlet was sent credentials from the Credential Vault. A portlet cannot set Credential Vault values
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.