Overview | Package | Class | Tree | Serialized | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.ibm.wps.portletservice.credentialvault.credentials
Class UserPasswordCredential

    java.lang.Object
      com.ibm.wps.portletservice.credentialvault.credentials.Credential
          com.ibm.wps.portletservice.credentialvault.credentials.ActiveCredential
              com.ibm.wps.portletservice.credentialvault.credentials.UserPasswordCredential

All Implemented Interfaces:
  ActiveCredential, Credential, UserPasswordCredential, java.io.Serializable

Direct Known Subclasses:
  HttpBasicAuthCredential, HttpFormBasedAuthCredential, JavaMailCredential

Deprecated. since 6.0. Support of the IBM portlet API may be removed in a future release of WebSphere Portal. Use of the Java Portlet API (javax.portlet) is recommended instead.

    public abstract class UserPasswordCredential

extends ActiveCredential
implements UserPasswordCredential

Abstract subclass of ActiveCredential where the user's secret is a userid/password pair. Preconditions:

- The configuration data passed to the constructor must define following values: KEY_CREDENTIAL_SECRET (in addition to the ones required by `ActiveCredential`)

Since:
  WP 5.1.0.1
See Also:
  Serialized Form

Field Summary
`protected UserPasswordCredentialSecret` | `secret` Deprecated.

Fields inherited from class com.ibm.wps.portletservice.credentialvault.credentials.Credential
`LOGGER_NAME`

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

Constructor Summary
`UserPasswordCredential()` Deprecated.

Method Summary
`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. Creates a new UserPassword credential.

Methods inherited from class com.ibm.wps.portletservice.credentialvault.credentials.ActiveCredential
`isActive`

Methods inherited from class com.ibm.wps.portletservice.credentialvault.credentials.Credential
`checkInitialized`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.ibm.portal.portlet.service.credentialvault.credentials.ActiveCredential
`isActive`

Field Detail

### secret

    protected UserPasswordCredentialSecret secret

  Deprecated.

Constructor Detail

### UserPasswordCredential

    public UserPasswordCredential()

  Deprecated.

Method Detail

### init

    public void init(java.util.Map<java.lang.String,java.lang.Object> config)
              throws CredentialVaultException

  Deprecated.
  Creates a new UserPassword credential.

  Specified by:
    `init` in interface `Credential`
  Specified by:
    `init` in interface `UserPasswordCredential`
  Overrides:
    `init` in class `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

    public int getSecretType()

  Deprecated.
  Description copied from class: `Credential`
  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.

  Specified by:
    `getSecretType` in interface `Credential`
  Specified by:
    `getSecretType` in interface `UserPasswordCredential`
  Overrides:
    `getSecretType` in class `Credential`
  Returns:
    int Credential Secret Type identifier
  See Also:
    `CredentialVaultService`

Overview | Package | Class | Tree | Serialized | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD