Package org.keycloak.credential

Class OTPCredentialProvider

java.lang.Object
org.keycloak.credential.OTPCredentialProvider
All Implemented Interfaces:
org.keycloak.credential.CredentialInputValidator, org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.OTPCredentialModel>, org.keycloak.provider.Provider
public class OTPCredentialProvider extends Object implements org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.OTPCredentialModel>, org.keycloak.credential.CredentialInputValidator
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.keycloak.models.KeycloakSession
    session
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    OTPCredentialProvider(org.keycloak.models.KeycloakSession session)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.keycloak.credential.CredentialModel
    createCredential(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.credential.OTPCredentialModel credentialModel)
     
    boolean
    deleteCredential(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String credentialId)
     
    org.keycloak.models.credential.OTPCredentialModel
    getCredentialFromModel(org.keycloak.credential.CredentialModel model)
     
    org.keycloak.credential.CredentialTypeMetadata
    getCredentialTypeMetadata(org.keycloak.credential.CredentialTypeMetadataContext metadataContext)
     
    String
    getType()
     
    boolean
    isConfiguredFor(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
     
    boolean
    isConfiguredFor(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String credentialType)
     
    boolean
    isValid(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.credential.CredentialInput credentialInput)
     
    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, getCredentialForPresentationFromModel, getCredentialMetadata, getDefaultCredential, supportsCredentialType

  • Field Details

    • session

      protected org.keycloak.models.KeycloakSession session

  • Constructor Details

    • OTPCredentialProvider

      public OTPCredentialProvider(org.keycloak.models.KeycloakSession session)

  • Method Details

    • createCredential

      public org.keycloak.credential.CredentialModel createCredential(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.credential.OTPCredentialModel credentialModel)
      Specified by:
      createCredential in interface org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.OTPCredentialModel>

    • deleteCredential

      public boolean deleteCredential(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String credentialId)
      Specified by:
      deleteCredential in interface org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.OTPCredentialModel>

    • getCredentialFromModel

      public org.keycloak.models.credential.OTPCredentialModel getCredentialFromModel(org.keycloak.credential.CredentialModel model)
      Specified by:
      getCredentialFromModel in interface org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.OTPCredentialModel>

    • supportsCredentialType

      public boolean supportsCredentialType(String credentialType)
      Specified by:
      supportsCredentialType in interface org.keycloak.credential.CredentialInputValidator
      Specified by:
      supportsCredentialType in interface org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.OTPCredentialModel>

    • isConfiguredFor

      public boolean isConfiguredFor(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String credentialType)
      Specified by:
      isConfiguredFor in interface org.keycloak.credential.CredentialInputValidator

    • isConfiguredFor

      public boolean isConfiguredFor(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)

    • isValid

      public boolean isValid(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.credential.CredentialInput credentialInput)
      Specified by:
      isValid in interface org.keycloak.credential.CredentialInputValidator

    • getType

      public String getType()
      Specified by:
      getType in interface org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.OTPCredentialModel>

    • getCredentialTypeMetadata

      public org.keycloak.credential.CredentialTypeMetadata getCredentialTypeMetadata(org.keycloak.credential.CredentialTypeMetadataContext metadataContext)
      Specified by:
      getCredentialTypeMetadata in interface org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.OTPCredentialModel>