Package jakarta.security.enterprise.credential

Class UsernamePasswordCredential

java.lang.Object
jakarta.security.enterprise.credential.AbstractClearableCredential
jakarta.security.enterprise.credential.UsernamePasswordCredential
All Implemented Interfaces:
Credential
Direct Known Subclasses:
BasicAuthenticationCredential
public class UsernamePasswordCredential
extends AbstractClearableCredential
Represents the credentials typically used by standard caller name/password authentication.

  • Constructor Summary

    Constructors 
    Constructor Description
    UsernamePasswordCredential​(java.lang.String callerName, Password password)
    Constructor.
    UsernamePasswordCredential​(java.lang.String callerName, java.lang.String password)
    Constructor.

  • Method Summary

    Modifier and Type Method Description
    void clearCredential()
    Invokes the specific subclass to securely clear the credential value.
    boolean compareTo​(java.lang.String callerName, java.lang.String password)  
    java.lang.String getCaller()  
    Password getPassword()
    Determines the password.
    java.lang.String getPasswordAsString()
    Determines the password.

    Methods inherited from class jakarta.security.enterprise.credential.AbstractClearableCredential

    clear, isCleared, setCleared

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface jakarta.security.enterprise.credential.Credential

    isValid

  • Constructor Details

    • UsernamePasswordCredential

      public UsernamePasswordCredential​(java.lang.String callerName, java.lang.String password)
      Constructor.
      Parameters:
      callerName - The caller name
      password - The password, as a String

    • UsernamePasswordCredential

      public UsernamePasswordCredential​(java.lang.String callerName, Password password)
      Constructor.
      Parameters:
      callerName - The caller name
      password - The password

  • Method Details

    • getPassword

      public Password getPassword()
      Determines the password.
      Returns:
      The password.

    • getPasswordAsString

      public java.lang.String getPasswordAsString()
      Determines the password.
      Returns:
      The password, as a String.

    • clearCredential

      public void clearCredential()
      Description copied from class: AbstractClearableCredential
      Invokes the specific subclass to securely clear the credential value. Some Credential subclasses contain credential values which are inherently secure, such as tokens, for which clearing the credential may not be necessary.

      For example, if the credential includes a password, this method would overwrite the password value.

      Specified by:
      clearCredential in class AbstractClearableCredential

    • getCaller

      public java.lang.String getCaller()

    • compareTo

      public boolean compareTo​(java.lang.String callerName, java.lang.String password)