Package org.keycloak.credential

Class PasswordCredentialProvider

  • All Implemented Interfaces:
    org.keycloak.credential.CredentialInputUpdater, org.keycloak.credential.CredentialInputUpdater.Streams, org.keycloak.credential.CredentialInputValidator, org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.PasswordCredentialModel>, org.keycloak.models.cache.OnUserCache, org.keycloak.provider.Provider
    public class PasswordCredentialProvider
extends Object
implements org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.PasswordCredentialModel>, org.keycloak.credential.CredentialInputUpdater.Streams, org.keycloak.credential.CredentialInputValidator, org.keycloak.models.cache.OnUserCache
    Version:
    $Revision: 1 $
    Author:
    Bill Burke

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.keycloak.credential.CredentialInputUpdater

        org.keycloak.credential.CredentialInputUpdater.Streams

    • Constructor Summary

      Constructors 
      Constructor Description
      PasswordCredentialProvider​(org.keycloak.models.KeycloakSession session)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean createCredential​(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String password)  
      org.keycloak.credential.CredentialModel createCredential​(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.credential.PasswordCredentialModel credentialModel)  
      boolean deleteCredential​(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String credentialId)  
      void disableCredentialType​(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String credentialType)  
      org.keycloak.models.credential.PasswordCredentialModel getCredentialFromModel​(org.keycloak.credential.CredentialModel model)  
      protected org.keycloak.credential.UserCredentialStore getCredentialStore()  
      org.keycloak.credential.CredentialTypeMetadata getCredentialTypeMetadata​(org.keycloak.credential.CredentialTypeMetadataContext metadataContext)  
      Stream<String> getDisableableCredentialTypesStream​(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)  
      protected org.keycloak.credential.hash.PasswordHashProvider getHashProvider​(org.keycloak.models.PasswordPolicy policy)  
      org.keycloak.models.credential.PasswordCredentialModel getPassword​(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)  
      String getType()  
      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 input)  
      void onCache​(org.keycloak.models.RealmModel realm, org.keycloak.models.cache.CachedUserModel user, org.keycloak.models.UserModel delegate)  
      boolean supportsCredentialType​(String credentialType)  
      boolean updateCredential​(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.credential.CredentialInput input)  

      • Methods inherited from interface org.keycloak.credential.CredentialInputUpdater.Streams

        getDisableableCredentialTypes

      • Methods inherited from interface org.keycloak.credential.CredentialProvider

        close, getDefaultCredential

    • Field Detail

      • PASSWORD_CACHE_KEY

        public static final String PASSWORD_CACHE_KEY

      • session

        protected final org.keycloak.models.KeycloakSession session

    • Constructor Detail

      • PasswordCredentialProvider

        public PasswordCredentialProvider​(org.keycloak.models.KeycloakSession session)

    • Method Detail

      • getCredentialStore

        protected org.keycloak.credential.UserCredentialStore getCredentialStore()

      • getPassword

        public org.keycloak.models.credential.PasswordCredentialModel getPassword​(org.keycloak.models.RealmModel realm,
                                                                          org.keycloak.models.UserModel user)

      • createCredential

        public boolean createCredential​(org.keycloak.models.RealmModel realm,
                                org.keycloak.models.UserModel user,
                                String password)

      • createCredential

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

      • 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.PasswordCredentialModel>

      • getCredentialFromModel

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

      • getHashProvider

        protected org.keycloak.credential.hash.PasswordHashProvider getHashProvider​(org.keycloak.models.PasswordPolicy policy)

      • supportsCredentialType

        public boolean supportsCredentialType​(String credentialType)
        Specified by:
        supportsCredentialType in interface org.keycloak.credential.CredentialInputUpdater
        Specified by:
        supportsCredentialType in interface org.keycloak.credential.CredentialInputValidator

      • updateCredential

        public boolean updateCredential​(org.keycloak.models.RealmModel realm,
                                org.keycloak.models.UserModel user,
                                org.keycloak.credential.CredentialInput input)
        Specified by:
        updateCredential in interface org.keycloak.credential.CredentialInputUpdater

      • disableCredentialType

        public void disableCredentialType​(org.keycloak.models.RealmModel realm,
                                  org.keycloak.models.UserModel user,
                                  String credentialType)
        Specified by:
        disableCredentialType in interface org.keycloak.credential.CredentialInputUpdater

      • getDisableableCredentialTypesStream

        public Stream<String> getDisableableCredentialTypesStream​(org.keycloak.models.RealmModel realm,
                                                          org.keycloak.models.UserModel user)
        Specified by:
        getDisableableCredentialTypesStream in interface org.keycloak.credential.CredentialInputUpdater
        Specified by:
        getDisableableCredentialTypesStream in interface org.keycloak.credential.CredentialInputUpdater.Streams

      • 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

      • isValid

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

      • onCache

        public void onCache​(org.keycloak.models.RealmModel realm,
                    org.keycloak.models.cache.CachedUserModel user,
                    org.keycloak.models.UserModel delegate)
        Specified by:
        onCache in interface org.keycloak.models.cache.OnUserCache

      • getType

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

      • 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.PasswordCredentialModel>