org.wildfly.security.credential

Class SecretKeyCredential

java.lang.Object

org.wildfly.security.credential.SecretKeyCredential

All Implemented Interfaces:

Cloneable, AlgorithmCredential, Credential

public final class SecretKeyCredential
extends Object
implements AlgorithmCredential

A secret key credential.

Field Summary

Fields inherited from interface org.wildfly.security.credential.Credential

NO_CREDENTIALS

Constructor Summary

Constructors

Constructor and Description
SecretKeyCredential(SecretKey secretKey) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
SecretKeyCredential	clone() Creates and returns a copy of this Credential.
boolean	equals(Object obj)
String	getAlgorithm() Get the algorithm name associated with this credential (will never be null).
<P extends AlgorithmParameterSpec> P	getParameters(Class<P> paramSpecClass) Get the algorithm parameters of the given type from this credential.
SecretKey	getSecretKey() Get the secret key.
int	hashCode()
boolean	impliesSameParameters(AlgorithmCredential other) Determine whether the other credential's parameters are implied by this one.
boolean	supportsParameters(Class<? extends AlgorithmParameterSpec> paramSpecClass) Determine whether this credential instance supports the given algorithm parameter type.

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, impliesParameters, matches, matches, matches, supportsParameters

Methods inherited from interface org.wildfly.security.credential.Credential

canVerify, canVerify, castAndApply, castAndApply, castAndApply, castAs, castAs, castAs, fromKeyStoreEntry, verify, verify

Constructor Detail

SecretKeyCredential

public SecretKeyCredential(SecretKey secretKey)

Construct a new instance.

Parameters:

secretKey - the secret key (may not be null)

Method Detail

getSecretKey

public SecretKey getSecretKey()

Get the secret key.

Returns:

the secret key (not null)

supportsParameters

public boolean supportsParameters(Class<? extends AlgorithmParameterSpec> paramSpecClass)

Description copied from interface: AlgorithmCredential

Determine whether this credential instance supports the given algorithm parameter type.

Specified by:

supportsParameters in interface AlgorithmCredential

Parameters:

paramSpecClass - the parameter specification class (must not be null)

Returns:

true if the parameter type is supported, false otherwise

getParameters

public <P extends AlgorithmParameterSpec> P getParameters(Class<P> paramSpecClass)

Description copied from interface: AlgorithmCredential

Get the algorithm parameters of the given type from this credential.

Specified by:

getParameters in interface AlgorithmCredential

Parameters:

paramSpecClass - the parameter specification class (must not be null)

Returns:

the parameter specification, or null if no parameters are present or available or the given type was not supported by this credential

impliesSameParameters

public boolean impliesSameParameters(AlgorithmCredential other)

Description copied from interface: AlgorithmCredential

Determine whether the other credential's parameters are implied by this one.

Specified by:

impliesSameParameters in interface AlgorithmCredential

Parameters:

other - the other credential (must not be null)

Returns:

true if the credentials have matching parameters, false otherwise

getAlgorithm

public String getAlgorithm()

Description copied from interface: AlgorithmCredential

Get the algorithm name associated with this credential (will never be null).

Specified by:

getAlgorithm in interface AlgorithmCredential

Returns:

the algorithm name

clone

public SecretKeyCredential clone()

Description copied from interface: AlgorithmCredential

Creates and returns a copy of this Credential.

Specified by:

clone in interface AlgorithmCredential

Specified by:

clone in interface Credential

Overrides:

clone in class Object

Returns:

a copy of this Credential.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object