Top Description Methods
jakarta.security.enterprise.credential

public Interface Credential

Known Direct Implementers
jakarta.security.enterprise.credential.RememberMeCredential, jakarta.security.enterprise.credential.AbstractClearableCredential, jakarta.security.enterprise.credential.CallerOnlyCredential

Credential represents the credential the caller will use to authenticate.

Method Summary

Modifier and TypeMethod and Description
public default void
clear()

Clears the credential.

public default boolean

Returns:

true if the credential has been cleared, otherwise false.
isCleared
()

Determines whether the credential value has been securely cleared.

public default boolean

Returns:

true if credential has integrity.
isValid
()

Determines whether the credential is valid.

Method Detail

clearback to summary
public default void clear()

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

isClearedback to summary
public default boolean isCleared()

Determines whether the credential value has been securely cleared.

Returns:boolean

true if the credential has been cleared, otherwise false.

isValidback to summary
public 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:boolean

true if credential has integrity.