Overview Package Class Tree Serialized Deprecated Index Help PREV class NEXT class SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.ibm.portal.portlet.service.credentialvault.credentials
Interface Credential
- All Known Subinterfaces:
- ActiveCredential, BinaryCredential, BinaryPassiveCredential, HttpBasicAuthCredential, HttpFormBasedAuthCredential, JaasSubjectCredential, JaasSubjectPassiveCredential, JavaMailCredential, LtpaTokenCredential, PassiveCredential, SimplePassiveCredential, SiteMinderTokenCredential, SSMTokenCredential, UserPasswordCredential, UserPasswordPassiveCredential, WASAdminUserCredential, WebSealTokenCredential
- All Known Implementing Classes:
- ActiveCredential, BinaryCredential, BinaryPassiveCredential, Credential, HttpBasicAuthCredential, HttpFormBasedAuthCredential, JaasSubjectCredential, JaasSubjectPassiveCredential, JavaMailCredential, LtpaTokenCredential, PassiveCredential, SimplePassiveCredential, SiteMinderTokenCredential, SSMTokenCredential, UserPasswordCredential, UserPasswordPassiveCredential, WASAdminUserCredential, WebSealTokenCredential
- public interface Credential
Base interface class for all credential classes. As such it is the WP Credential "interface". The different terms need to be distinguished when talking of (active) credentials:
Note: All concrete subclasses must provide a no-argument constructor. The credentials are initialized by the
- A Credential Type is an implementation of an abstract credential class that has authentication methods specialized to perform a certain kind of authentication (e.g. form-based web authentication). Credential Types will be defined and delivered by the portal framework. They are registered in a credential registry.
- A Credential Instance is an Credential Type that has been configured to work with one specific backend (application), or simply spoken:
Credential Instance = Credential Type + configuration data (e.g. the mycompany-webmail-credential is a form-based web authentication credential plus information about the postURL, userid attribute name and password attribute name).
- A Concrete Credential Object is a Java object of a Credential Instance of the kind that is passed between vault (service) and portlet. This credential object is user specific as it carries the user secret with it.
init method.
- Since:
- 5.1.0.1
Field Summary static java.lang.String KEY_CREDENTIAL_SECRET
The credential's secret - e.g.
Method Summary int getSecretType()
Returns the credential's Secret Type in terms of the constants declared in com.ibm.portal.portlet.service.credentialvault.CredentialVaultService Should be overwritten by any child class that "overwrites" the secret attribute.void java.util.Map)">init(java.util.Map config)
Initializes the credential with the specified configuration.boolean isActive()
Returns whether a credential is active or passive. Should be overwritten by any child classes.
Field Detail KEY_CREDENTIAL_SECRET
public static final java.lang.String KEY_CREDENTIAL_SECRET
- The credential's secret - e.g. BinaryCredentialSecret
- See Also:
- Constant Field Values
java.util.Map)">
Method Detail init
public void init(java.util.Map config) throws CredentialVaultException
- Initializes the credential with the specified configuration. Subclasses need to override this method to retrieve the necessary configuration information (e.g. the secret)
- Parameters:
- config - Configuration data that is needed to initialize the credential. What parameters are needed is specific to the actual credential type. Generally, this data is collected from three different sources:
- The credential's client (usually the portlet) specifies backend application specific parameters (like e.g. 'login url')
- The portal's credential configuration store delivers credential slot specific parameters
- The actual credential store contributes the credential secret
- Throws:
- CredentialVaultException - If any mandatory parameter is missing or has a wrong object type as value.
getSecretType
public int getSecretType()
- Returns the credential's Secret Type in terms of the constants declared in com.ibm.portal.portlet.service.credentialvault.CredentialVaultService Should be overwritten by any child class that "overwrites" the secret attribute.
- Returns:
- int Credential Secret Type Identifier
isActive
public boolean isActive()
- Returns whether a credential is active or passive. Should be overwritten by any child classes.
- Returns:
- boolean True if credential is active, false otherwise
Overview Package Class Tree Serialized Deprecated Index Help PREV class NEXT class SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.
IBM is a trademark of the IBM Corporation in the United States, other countries, or both.