com.ibm.workflow.portlet.client
Interface PortalContext
- All Known Implementing Classes:
- PortalContextImpl
- public interface PortalContext
Through objects of this class you can access various portal specific services.
These services comprise of retrieving credential, saving credentials
and accessing objects necessary for dealing with the RegistrationMap used for interportlet communication.
Method Summary |
com.ibm.wps.portletservice.credentialvault.credentials.UserPasswordPassiveCredential |
getCredential(org.apache.jetspeed.portlet.PortletContext context,
org.apache.jetspeed.portlet.PortletRequest request,
java.lang.String slotName)
Retrieve a UserPasswordPassiveCredential from this application's slot of the credential vault. |
GlobalRegistrationMap |
getGlobalRegistrationMap()
Returns the GlobalRegistrationMap necessary during the logon and logout phase of the user portlet instances
in order to share common RegistrationMap objects. |
void |
saveCredential(org.apache.jetspeed.portlet.PortletContext context,
org.apache.jetspeed.portlet.PortletRequest request,
java.lang.String user,
java.lang.String password,
java.lang.String slotName)
Save a credential in this application's slot of the credential vault. |
getGlobalRegistrationMap
public GlobalRegistrationMap getGlobalRegistrationMap()
- Returns the GlobalRegistrationMap necessary during the logon and logout phase of the user portlet instances
in order to share common RegistrationMap objects.
- Returns:
- the unique global GlobalRegistrationMap
getCredential
public com.ibm.wps.portletservice.credentialvault.credentials.UserPasswordPassiveCredential getCredential(org.apache.jetspeed.portlet.PortletContext context,
org.apache.jetspeed.portlet.PortletRequest request,
java.lang.String slotName)
throws CredentialVaultException,
org.apache.jetspeed.portlet.service.PortletServiceException,
com.ibm.wps.portletservice.credentialvault.CredentialSecretNotSetException
- Retrieve a UserPasswordPassiveCredential from this application's slot of the credential vault.
It is assumed that the slot is administrative slot which means that there is one credential per user in a
slot which is accessible under a unique slot id.
As all exception are derived from PortletException you can catch all exception at once by catching PortletException.
- Parameters:
context
- The PortletContext object necessary in order to log and access the credential service.request
- The PortletRequest object necessary in order to correlate the retrieval request to the right user.slotName
- The name of slot which should be used- Returns:
- The UserPasswordPassiveCredential
saveCredential
public void saveCredential(org.apache.jetspeed.portlet.PortletContext context,
org.apache.jetspeed.portlet.PortletRequest request,
java.lang.String user,
java.lang.String password,
java.lang.String slotName)
throws CredentialVaultException,
org.apache.jetspeed.portlet.service.PortletServiceException
- Save a credential in this application's slot of the credential vault.
It is assumed that the slot is administrative slot which means that there is one credential per user in a
slot which is accessible under a unique slot id.
- Parameters:
context
- The PortletContext object necessary in order to log and access the credential service.request
- The PortletRequest object necessary in order to correlate the save request to the right user.user
- The workflow user name.password
- The workflow password of the user.slotName
- The name of the slot which should be used.
© Copyright IBM Corporation 2002, 2008. All Rights Reserved.