Package org.keycloak.credential

Class CredentialModel

java.lang.Object

org.keycloak.credential.CredentialModel

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OTPCredentialModel, PasswordCredentialModel, RecoveryAuthnCodesCredentialModel, WebAuthnCredentialModel

public class CredentialModel
extends Object
implements Serializable

Used just in cases when we want to "directly" update or retrieve the hash or salt of user credential (For example during export/import)

Author:

Marek Posolda

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_CERT
static final String	HOTP	Deprecated.
static final String	KERBEROS
static final String	OTP	Deprecated.
static final String	PASSWORD	Deprecated.
static final String	PASSWORD_HISTORY	Deprecated.
static final String	PASSWORD_TOKEN	Deprecated.
static final String	SECRET
static final String	TOTP	Deprecated.

Constructor Summary

Constructors

Constructor	Description
CredentialModel()

Method Summary

Modifier and Type	Method	Description
static Comparator<CredentialModel>	comparingByStartDateDesc()
String	getAlgorithm()	Deprecated. Recommended to use PasswordCredentialModel.getPasswordCredentialData().getAlgorithm() or OTPCredentialModel.getOTPCredentialData().getAlgorithm()
MultivaluedHashMap<String,String>	getConfig()	Deprecated. Recommended to use getCredentialData() instead and use the subtype of CredentialData specific to your credential
int	getCounter()	Deprecated. Recommended to use OTPCredentialModel.getOTPCredentialData().getCounter()
Long	getCreatedDate()
String	getCredentialData()
String	getDevice()	Deprecated. Recommended to use OTPCredentialModel.getOTPCredentialData().getDevice()
int	getDigits()	Deprecated. Recommended to use OTPCredentialModel.getOTPCredentialData().getDigits()
int	getHashIterations()	Deprecated. Recommended to use PasswordCredentialModel.getPasswordCredentialData().getHashIterations()
String	getId()
int	getPeriod()	Deprecated. Recommended to use OTPCredentialModel.getOTPCredentialData().getPeriod()
byte[]	getSalt()	Deprecated. Recommended to use PasswordCredentialModel.getPasswordSecretData().getSalt()
String	getSecretData()
String	getType()
String	getUserLabel()
String	getValue()	Deprecated. Recommended to use PasswordCredentialModel.getPasswordSecretData().getValue() or OTPCredentialModel.getOTPSecretData().getValue()
void	setAlgorithm(String algorithm)	Deprecated. See getAlgorithm()
void	setConfig(MultivaluedHashMap<String,String> config)	Deprecated. Recommended to use setCredentialData(String) instead and use the subtype of CredentialData specific to your credential
void	setCounter(int counter)	Deprecated. See getCounter()
void	setCreatedDate(Long createdDate)
void	setCredentialData(String credentialData)
void	setDevice(String device)	Deprecated. See getDevice()
void	setDigits(int digits)	Deprecated. See setDigits(int)
void	setHashIterations(int iterations)	Deprecated. See getHashIterations()
void	setId(String id)
void	setPeriod(int period)	Deprecated. See setPeriod(int)
void	setSalt(byte[] salt)	Deprecated. See getSalt()
void	setSecretData(String secretData)
void	setType(String type)
void	setUserLabel(String userLabel)
void	setValue(String value)	Deprecated. See getValue()
CredentialModel	shallowClone()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PASSWORD

@Deprecated
public static final String PASSWORD

Deprecated.

See Also:

• Constant Field Values

PASSWORD_HISTORY

@Deprecated
public static final String PASSWORD_HISTORY

Deprecated.

See Also:

• Constant Field Values

PASSWORD_TOKEN

@Deprecated
public static final String PASSWORD_TOKEN

Deprecated.

See Also:

• Constant Field Values

OTP

@Deprecated
public static final String OTP

Deprecated.

See Also:

• Constant Field Values

TOTP

@Deprecated
public static final String TOTP

Deprecated.

See Also:

• Constant Field Values

HOTP

@Deprecated
public static final String HOTP

Deprecated.

See Also:

• Constant Field Values

SECRET

public static final String SECRET

See Also:

• Constant Field Values

CLIENT_CERT

public static final String CLIENT_CERT

See Also:

• Constant Field Values

KERBEROS

public static final String KERBEROS

See Also:

• Constant Field Values

Constructor Details

CredentialModel

public CredentialModel()

Method Details

shallowClone

public CredentialModel shallowClone()

getId

public String getId()

setId

public void setId(String id)

getType

public String getType()

setType

public void setType(String type)

getUserLabel

public String getUserLabel()

setUserLabel

public void setUserLabel(String userLabel)

getCreatedDate

public Long getCreatedDate()

setCreatedDate

public void setCreatedDate(Long createdDate)

getSecretData

public String getSecretData()

setSecretData

public void setSecretData(String secretData)

getCredentialData

public String getCredentialData()

setCredentialData

public void setCredentialData(String credentialData)

comparingByStartDateDesc

public static Comparator<CredentialModel> comparingByStartDateDesc()

getValue

@Deprecated
public String getValue()

Deprecated.

Recommended to use PasswordCredentialModel.getPasswordSecretData().getValue() or OTPCredentialModel.getOTPSecretData().getValue()

setValue

@Deprecated
public void setValue(String value)

Deprecated.

See getValue()

getDevice

@Deprecated
public String getDevice()

Deprecated.

Recommended to use OTPCredentialModel.getOTPCredentialData().getDevice()

setDevice

@Deprecated
public void setDevice(String device)

Deprecated.

See getDevice()

getSalt

@Deprecated
public byte[] getSalt()

Deprecated.

Recommended to use PasswordCredentialModel.getPasswordSecretData().getSalt()

setSalt

@Deprecated
public void setSalt(byte[] salt)

Deprecated.

See getSalt()

getHashIterations

@Deprecated
public int getHashIterations()

Deprecated.

Recommended to use PasswordCredentialModel.getPasswordCredentialData().getHashIterations()

setHashIterations

@Deprecated
public void setHashIterations(int iterations)

Deprecated.

See getHashIterations()

getCounter

@Deprecated
public int getCounter()

Deprecated.

Recommended to use OTPCredentialModel.getOTPCredentialData().getCounter()

setCounter

@Deprecated
public void setCounter(int counter)

Deprecated.

See getCounter()

getAlgorithm

@Deprecated
public String getAlgorithm()

Deprecated.

Recommended to use PasswordCredentialModel.getPasswordCredentialData().getAlgorithm() or OTPCredentialModel.getOTPCredentialData().getAlgorithm()

setAlgorithm

@Deprecated
public void setAlgorithm(String algorithm)

Deprecated.

See getAlgorithm()

getDigits

@Deprecated
public int getDigits()

Deprecated.

Recommended to use OTPCredentialModel.getOTPCredentialData().getDigits()

setDigits

@Deprecated
public void setDigits(int digits)

Deprecated.

See setDigits(int)

getPeriod

@Deprecated
public int getPeriod()

Deprecated.

Recommended to use OTPCredentialModel.getOTPCredentialData().getPeriod()

setPeriod

@Deprecated
public void setPeriod(int period)

Deprecated.

See setPeriod(int)

getConfig

@Deprecated
public MultivaluedHashMap<String,String> getConfig()

Deprecated.

Recommended to use getCredentialData() instead and use the subtype of CredentialData specific to your credential

setConfig

@Deprecated
public void setConfig(MultivaluedHashMap<String,String> config)

Deprecated.

Recommended to use setCredentialData(String) instead and use the subtype of CredentialData specific to your credential