Package jakarta.security.enterprise.credential

Interface Credential

All Known Implementing Classes:
AbstractClearableCredential, BasicAuthenticationCredential, CallerOnlyCredential, RememberMeCredential, UsernamePasswordCredential
public interface Credential
Credential represents the credential the caller will use to authenticate.

  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    default void
    clear()
    Clears the credential.
    default boolean
    isCleared()
    Determines whether the credential value has been securely cleared.
    default boolean
    isValid()
    Determines whether the credential is valid.

  • Method Details Link icon

    • isCleared Link icon

      default boolean isCleared()
      Determines whether the credential value has been securely cleared.
      Returns:
      true if the credential has been cleared, otherwise false.

    • clear Link icon

      default void clear()
      Clears the credential. For example, if the credential includes a password, this method would overwrite the password value.

    • isValid Link icon

      default boolean isValid()
      Determines whether the credential is valid. This would be called as part of the credential validation process to check the integrity of the credential, such as a signature check. This check would be self-contained, not requiring identity store access.
      Returns:
      true if credential has integrity.