Package org.keycloak.credential

Class OTPCredentialProvider

java.lang.Object

org.keycloak.credential.OTPCredentialProvider

All Implemented Interfaces:

CredentialInputValidator, CredentialProvider<OTPCredentialModel>, Provider

public class OTPCredentialProvider
extends Object
implements CredentialProvider<OTPCredentialModel>, CredentialInputValidator

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
protected KeycloakSession	session

Constructor Summary

Constructors

Constructor	Description
OTPCredentialProvider(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
CredentialModel	createCredential(RealmModel realm, UserModel user, OTPCredentialModel credentialModel)
boolean	deleteCredential(RealmModel realm, UserModel user, String credentialId)
OTPCredentialModel	getCredentialFromModel(CredentialModel model)
CredentialTypeMetadata	getCredentialTypeMetadata(CredentialTypeMetadataContext metadataContext)
String	getType()
boolean	isConfiguredFor(RealmModel realm, UserModel user)
boolean	isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	isValid(RealmModel realm, UserModel user, CredentialInput credentialInput)	Tests whether a credential is valid
boolean	supportsCredentialType(String credentialType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.credential.CredentialProvider

close, getCredentialMetadata, getDefaultCredential, supportsCredentialType

Field Details

session

protected KeycloakSession session

Constructor Details

OTPCredentialProvider

public OTPCredentialProvider(KeycloakSession session)

Method Details

createCredential

public CredentialModel createCredential(RealmModel realm,
 UserModel user,
 OTPCredentialModel credentialModel)

Specified by:

createCredential in interface CredentialProvider<OTPCredentialModel>

deleteCredential

public boolean deleteCredential(RealmModel realm,
 UserModel user,
 String credentialId)

Specified by:

deleteCredential in interface CredentialProvider<OTPCredentialModel>

getCredentialFromModel

public OTPCredentialModel getCredentialFromModel(CredentialModel model)

Specified by:

getCredentialFromModel in interface CredentialProvider<OTPCredentialModel>

supportsCredentialType

public boolean supportsCredentialType(String credentialType)

Specified by:

supportsCredentialType in interface CredentialInputValidator

Specified by:

supportsCredentialType in interface CredentialProvider<OTPCredentialModel>

isConfiguredFor

public boolean isConfiguredFor(RealmModel realm,
 UserModel user,
 String credentialType)

Specified by:

isConfiguredFor in interface CredentialInputValidator

isConfiguredFor

public boolean isConfiguredFor(RealmModel realm,
 UserModel user)

isValid

public boolean isValid(RealmModel realm,
 UserModel user,
 CredentialInput credentialInput)

Description copied from interface: CredentialInputValidator

Tests whether a credential is valid

Specified by:

isValid in interface CredentialInputValidator

Parameters:

realm - The realm in which to which the credential belongs to

user - The user for which to test the credential

credentialInput - the credential details to verify

Returns:

true if the passed secret is correct

getType

public String getType()

Specified by:

getType in interface CredentialProvider<OTPCredentialModel>

getCredentialTypeMetadata

public CredentialTypeMetadata getCredentialTypeMetadata(CredentialTypeMetadataContext metadataContext)

Specified by:

getCredentialTypeMetadata in interface CredentialProvider<OTPCredentialModel>