Package com.ibm.portal.portlet.service.credentialvault

This package defines the Credential Vault Portlet Service.

See:
          Description

Interface Summary
CredentialSlotConfig Describes the configuration of a credential slot.
CredentialTypes Credential Type definitions.
CredentialVaultService Portlet Service for JSR compliant portlets to access the WebSphere Portal Credential Vault.
VaultSegmentConfig Describes the configuration of a Vault Segment.
 

Exception Summary
CredentialSecretNotSetException The CredentialSecretNotSetException class defines an exception that is thrown by the CredentialVaultService in case that the secret of a requested credential is not set.
CredentialVaultException Exception that indicates an error in the credential vault subsystem.
SecretTypeNotSupportedException Exception that is thrown when a particular Vault implementation cannot handle a specific Secret Type, as defined in the CredentialVaultService class.
 

Package com.ibm.portal.portlet.service.credentialvault Description

This package defines the Credential Vault Portlet Service. WebSphere Portal provides access to the Credential Vault via a portlet service. This service provides to portlets (and to the portal itself, for that matter) an API for mapping from a user identity (usually a user ID, more general a Principal) to another user identity and usually a credential such as a password for that user ID.

Portlets must no longer store user credentials as part of the user specific portlet preferences. Storing credentials in the portlet data is not a recommended way of achieving single sign-on. Such portlets should be migrated so that they make use of the Credential Vault.

Credentials are stored in Credential Slots. It is through a Credential Slot that user secrets are retrieved, created, modified, and deleted. Credential Slots are contained in Vault Segments. A segment can either be managed by the user and administrators, or by administrators only.