com.ibm.portal.portlet.service.credentialvault.credentials
Interface BinaryPassiveCredential
- All Superinterfaces:
- Credential, PassiveCredential
- All Known Implementing Classes:
- BinaryPassiveCredential
-
public interface BinaryPassiveCredential
- extends PassiveCredential
Simple standard interface of a passive credential for binary credential secrets.
This credential is only a container of the user's secret.
Portlets may call the getSecret() method in order to obtain and work with this secret.
- Since:
- 5.1.0.1
Method Summary
|
byte[] |
getSecret()
Return the user's secret as an byte array. |
int |
getSecretType()
Return the credential's Secret Type in terms of the constants declared in
the Credential Vault Portlet Service.
Should be overwritten by any child class that "overwrites" the secret attribute. |
void |
init(java.util.Map<java.lang.String,java.lang.Object> config)
Initializes a new binary passive credential. |
init
void init(java.util.Map<java.lang.String,java.lang.Object> config)
throws CredentialVaultException
- Initializes a new binary passive credential.
- Specified by:
- init in interface Credential
- Parameters:
- config - The configuration needed to initialize this credential:
- KEY_CREDENTIAL_SECRET BinaryCredentialSecret - the credential's secret (mandatory)
- Throws:
- CredentialVaultException - If any mandatory parameter is missing or has a wrong object type as value.
getSecret
byte[] getSecret()
- Returns the user's secret as an byte array.
- Returns:
- byte[]
the user secret
getSecretType
int getSecretType()
- Description copied from interface: Credential
- Returns the credential's Secret Type in terms of the constants declared in
the Credential Vault Portlet Service.
Should be overwritten by any child class that "overwrites" the secret attribute.
- Specified by:
- getSecretType in interface Credential
- Returns:
- int
Credential Secret Type Identifier
- See Also:
- CredentialVaultService