|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.wps.portletservice.credentialvault.credentials.Credential
public abstract class Credential
Abstract base 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:
CredentialVaultService
.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).init
method.
Field Summary | |
---|---|
protected static java.lang.String |
LOGGER_NAME
Deprecated. Name of the logger that all WP credentials should use for logging. |
protected com.ibm.wps.sso.credentialvault.secrets.CredentialSecret |
secret
Deprecated. |
Fields inherited from interface com.ibm.portal.portlet.service.credentialvault.credentials.Credential |
---|
KEY_CREDENTIAL_SECRET |
Constructor Summary | |
---|---|
Credential()
Deprecated. |
|
Credential(java.util.Map<java.lang.String,java.lang.Object> config)
Deprecated. Creates and initializes a new Credential Object. |
Method Summary | |
---|---|
protected void |
checkInitialized()
Deprecated. |
int |
getSecretType()
Deprecated. Returns the credential's Secret Type in terms of the constants declared in CredentialVaultService
Should be overwritten by any child class that "overwrites" the secret attribute. |
void |
init(java.util.Map<java.lang.String,java.lang.Object> config)
Deprecated. Initializes the credential with the specified configuration. |
boolean |
isActive()
Deprecated. Returns whether a credential is active or passive. Should be overwritten by any child classes. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.String LOGGER_NAME
protected com.ibm.wps.sso.credentialvault.secrets.CredentialSecret secret
Constructor Detail |
---|
public Credential()
public Credential(java.util.Map<java.lang.String,java.lang.Object> config) throws java.lang.InstantiationException
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:
java.lang.InstantiationException
Method Detail |
---|
public void init(java.util.Map<java.lang.String,java.lang.Object> config) throws CredentialVaultException
init
in interface Credential
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:
CredentialVaultException
- If any mandatory parameter is missing or has a wrong object type as value.public int getSecretType()
CredentialVaultService
Should be overwritten by any child class that "overwrites" the secret attribute.
getSecretType
in interface Credential
CredentialVaultService
public boolean isActive()
isActive
in interface Credential
PassiveCredential
,
ActiveCredential
protected void checkInitialized()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |