com.ibm.portal.portlet.service.credentialvault.credentials
Interface UserPasswordPassiveCredential

All Superinterfaces:

Credential, PassiveCredential

All Known Implementing Classes:

UserPasswordPassiveCredential

public interface UserPasswordPassiveCredential
extends PassiveCredential

Simple standard interface inherited from the PassiveCredential. 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

Field Summary

Fields inherited from interface com.ibm.portal.portlet.service.credentialvault.credentials.Credential

KEY_CREDENTIAL_SECRET

Method Summary

char[]	getPassword() Returns the password of this credential's secret
int	getSecretType() 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.
java.lang.String	getUserId() Returns the user ID of this credential's secret
void	init(java.util.Map config) Initializes a new UserPasswordPassive credential.

Methods inherited from interface com.ibm.portal.portlet.service.credentialvault.credentials.PassiveCredential

isActive

Method Detail

init

void init(java.util.Map config)
          throws CredentialVaultException

Initializes a new UserPasswordPassive credential.

Specified by:

init in interface Credential

Parameters:

config - The configuration needed to initialize this credential:

• KEY_CREDENTIAL_SECRET UserPasswordCredentialSecret - the credential's secret (mandatory)

Throws:

CredentialVaultException - If any mandatory parameter is missing or has a wrong object type as value.

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

getUserId

java.lang.String getUserId()

Returns the user ID of this credential's secret

Returns:

the user ID

getPassword

char[] getPassword()

Returns the password of this credential's secret

Returns:

the password