Package org.wildfly.security.credential
Class PasswordCredential
- java.lang.Object
-
- org.wildfly.security.credential.PasswordCredential
-
- All Implemented Interfaces:
Cloneable,AlgorithmCredential,Credential
public final class PasswordCredential extends Object implements AlgorithmCredential
A credential for password authentication.
-
-
Field Summary
Fields Modifier and Type Field Description private Passwordpassword-
Fields inherited from interface org.wildfly.security.credential.Credential
NO_CREDENTIALS
-
-
Constructor Summary
Constructors Constructor Description PasswordCredential(Password password)Construct a new instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancanVerify(Class<? extends Evidence> evidenceClass, String algorithmName)Determine whether this credential can, generally speaking, verify the given evidence type.static booleancanVerifyEvidence(Class<? extends Evidence> evidenceClass, String algorithmName)Determine whether this credential type can, generally speaking, verify the given evidence type.PasswordCredentialclone()Creates and returns a copy of thisCredential.booleanequals(Object obj)StringgetAlgorithm()Get the algorithm name associated with this credential (will never benull).<P extends AlgorithmParameterSpec>
PgetParameters(Class<P> paramSpecClass)Get the algorithm parameters of the given type from this credential.PasswordgetPassword()Get the password.<P extends Password>
PgetPassword(Class<P> type)Get the password if it is of the given type; otherwise returnnull.inthashCode()booleanimpliesParameters(AlgorithmParameterSpec parameterSpec)Determine whether this credential implies the given parameters.booleanimpliesSameParameters(AlgorithmCredential other)Determine whether the other credential's parameters are implied by this one.booleansupportsParameters(Class<? extends AlgorithmParameterSpec> paramSpecClass)Determine whether this credential instance supports the given algorithm parameter type.booleanverify(Supplier<Provider[]> providerSupplier, Evidence evidence)Verify the given evidence.booleanverify(Supplier<Provider[]> providerSupplier, Evidence evidence, Charset hashCharset)Verify the given evidence.booleanverify(Evidence evidence, Charset hashCharset)Verify the given evidence.-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.wildfly.security.credential.AlgorithmCredential
getParameters, matches, matches, matches, supportsParameters
-
Methods inherited from interface org.wildfly.security.credential.Credential
canVerify, castAndApply, castAndApply, castAndApply, castAs, castAs, castAs, verify
-
-
-
-
Field Detail
-
password
private final Password password
-
-
Constructor Detail
-
PasswordCredential
public PasswordCredential(Password password)
Construct a new instance.- Parameters:
password- the password (must not benull)
-
-
Method Detail
-
getPassword
public Password getPassword()
Get the password.- Returns:
- the password (not
null)
-
getPassword
public <P extends Password> P getPassword(Class<P> type)
Get the password if it is of the given type; otherwise returnnull.- Type Parameters:
P- the password type- Parameters:
type- the password type class- Returns:
- the password, or
nullif the password is not of the given type
-
getAlgorithm
public String getAlgorithm()
Description copied from interface:AlgorithmCredentialGet the algorithm name associated with this credential (will never benull).- Specified by:
getAlgorithmin interfaceAlgorithmCredential- Returns:
- the algorithm name
-
supportsParameters
public boolean supportsParameters(Class<? extends AlgorithmParameterSpec> paramSpecClass)
Description copied from interface:AlgorithmCredentialDetermine whether this credential instance supports the given algorithm parameter type.- Specified by:
supportsParametersin interfaceAlgorithmCredential- Parameters:
paramSpecClass- the parameter specification class (must not benull)- Returns:
trueif the parameter type is supported,falseotherwise
-
getParameters
public <P extends AlgorithmParameterSpec> P getParameters(Class<P> paramSpecClass)
Description copied from interface:AlgorithmCredentialGet the algorithm parameters of the given type from this credential.- Specified by:
getParametersin interfaceAlgorithmCredential- Parameters:
paramSpecClass- the parameter specification class (must not benull)- Returns:
- the parameter specification, or
nullif no parameters are present or available or the given type was not supported by this credential
-
impliesParameters
public boolean impliesParameters(AlgorithmParameterSpec parameterSpec)
Description copied from interface:AlgorithmCredentialDetermine whether this credential implies the given parameters. The default implementation returnsfalsealways.- Specified by:
impliesParametersin interfaceAlgorithmCredential- Parameters:
parameterSpec- the parameters to test for (must not benull)- Returns:
trueif the given parameters match this credential,falseotherwise
-
impliesSameParameters
public boolean impliesSameParameters(AlgorithmCredential other)
Description copied from interface:AlgorithmCredentialDetermine whether the other credential's parameters are implied by this one.- Specified by:
impliesSameParametersin interfaceAlgorithmCredential- Parameters:
other- the other credential (must not benull)- Returns:
trueif the credentials have matching parameters,falseotherwise
-
canVerify
public boolean canVerify(Class<? extends Evidence> evidenceClass, String algorithmName)
Description copied from interface:CredentialDetermine whether this credential can, generally speaking, verify the given evidence type.- Specified by:
canVerifyin interfaceCredential- Parameters:
evidenceClass- the evidence type (must not benull)algorithmName- the evidence algorithm name (may benullif the type of evidence does not support algorithm names)- Returns:
trueif the evidence can be verified by this credential,falseotherwise
-
canVerifyEvidence
public static boolean canVerifyEvidence(Class<? extends Evidence> evidenceClass, String algorithmName)
Determine whether this credential type can, generally speaking, verify the given evidence type.- Parameters:
evidenceClass- the evidence type (must not benull)algorithmName- the evidence algorithm name (may benullif the type of evidence does not support algorithm names)- Returns:
trueif the evidence can be verified by this credential,falseotherwise
-
verify
public boolean verify(Supplier<Provider[]> providerSupplier, Evidence evidence)
Description copied from interface:CredentialVerify the given evidence.- Specified by:
verifyin interfaceCredential- Parameters:
providerSupplier- the provider supplier to use for verification purposesevidence- the evidence to verify (must not benull)- Returns:
trueif the evidence is verified,falseotherwise
-
verify
public boolean verify(Supplier<Provider[]> providerSupplier, Evidence evidence, Charset hashCharset)
Verify the given evidence.- Parameters:
providerSupplier- the provider supplier to use for verification purposes (must not benull)evidence- the evidence to verify (must not benull)hashCharset- the character set to use when converting the password string to a byte array (must not benull)- Returns:
trueif the evidence is verified,falseotherwise
-
verify
public boolean verify(Evidence evidence, Charset hashCharset)
Verify the given evidence.- Parameters:
evidence- the evidence to verify (must not benull)hashCharset- the character set to use when converting the password string to a byte array (must not benull)- Returns:
trueif the evidence is verified,falseotherwise
-
clone
public PasswordCredential clone()
Description copied from interface:AlgorithmCredentialCreates and returns a copy of thisCredential.- Specified by:
clonein interfaceAlgorithmCredential- Specified by:
clonein interfaceCredential- Overrides:
clonein classObject- Returns:
- a copy of this
Credential.
-
-