Class AbstractClearableCredential

  • All Implemented Interfaces:
    Credential
    Direct Known Subclasses:
    UsernamePasswordCredential


    public abstract class AbstractClearableCredential
    extends java.lang.Object
    implements Credential
    AbstractClearableCredential contains behavior common to Credential implementations that can be meaningfully cleared.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void clear​()
      Clears the credential.
      protected abstract void clearCredential​()
      Invokes the specific subclass to securely clear the credential value.
      boolean isCleared​()
      Determines whether the credential value has been securely cleared.
      protected void setCleared​()
      Specifies that the credential value has been securely cleared.
      • Methods inherited from interface javax.security.enterprise.credential.Credential

        isValid
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AbstractClearableCredential

        public AbstractClearableCredential​()
    • Method Detail

      • isCleared

        public final boolean isCleared​()
        Description copied from interface: Credential
        Determines whether the credential value has been securely cleared.
        Specified by:
        isCleared in interface Credential
        Returns:
        true if the credential has been cleared, otherwise false.
      • setCleared

        protected final void setCleared​()
        Specifies that the credential value has been securely cleared.
      • clear

        public final void clear​()
        Description copied from interface: Credential
        Clears the credential. For example, if the credential includes a password, this method would overwrite the password value.
        Specified by:
        clear in interface Credential
      • clearCredential

        protected abstract void clearCredential​()
        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.