Package org.keycloak.migration

Interface MigrationProvider

All Superinterfaces:
Provider
All Known Implementing Classes:
DefaultMigrationProvider
public interface MigrationProvider extends Provider
Various common utils needed for migration from older version to newer
Author:
Marek Posolda

  • Method Details

    • getMappersForClaimMask

      List<ProtocolMapperRepresentation> getMappersForClaimMask(Long claimMask)
      Parameters:
      claimMask - mask used on ClientModel in 1.1.0
      Returns:
      set of 1.2.0.Beta1 protocol mappers corresponding to given claimMask

    • getBuiltinMappers

      Map<String,ProtocolMapperModel> getBuiltinMappers(String protocol)

    • setupAdminCli

      void setupAdminCli(RealmModel realm)

    • addOIDCRolesClientScope

      ClientScopeModel addOIDCRolesClientScope(RealmModel realm)
      Add 'roles' client scope or return it if already exists
      Parameters:
      realm -
      Returns:
      created or already existing client scope 'roles'

    • addOIDCWebOriginsClientScope

      ClientScopeModel addOIDCWebOriginsClientScope(RealmModel realm)
      Add 'web-origins' client scope or return it if already exists
      Parameters:
      realm -
      Returns:
      created or already existing client scope 'web-origins'

    • addOIDCMicroprofileJWTClientScope

      ClientScopeModel addOIDCMicroprofileJWTClientScope(RealmModel realm)
      Adds the microprofile-jwt optional client scope to the realm and returns the created scope. If the scope already exists in the realm then the existing scope is returned.
      Parameters:
      realm - the realm to which the scope is to be added.
      Returns:
      a reference to the microprofile-jwt client scope that was either created or already exists in the realm.

    • addOIDCAcrClientScope

      ClientScopeModel addOIDCAcrClientScope(RealmModel realm)
      Add 'acr' client scope or return it if already exists
      Parameters:
      realm -
      Returns:
      created or already existing client scope 'acr'

    • addOIDCBasicClientScope

      ClientScopeModel addOIDCBasicClientScope(RealmModel realm)
      Add 'basic' client scope or return it if already exists
      Parameters:
      realm -
      Returns:
      created or already existing client scope 'basic'

    • addOIDCServiceAccountClientScope

      ClientScopeModel addOIDCServiceAccountClientScope(RealmModel realm)
      Add 'service_account' client scope or return it if already exists
      Parameters:
      realm -
      Returns:
      created or already existing client scope 'service_account'

    • addSamlAuthnContextClassRefClientScope

      ClientScopeModel addSamlAuthnContextClassRefClientScope(RealmModel realm)
      Add the SAML mapper for the step-up AuthnContextClassRef authentication to the realm.
      Parameters:
      realm -
      Returns:
      created, already existing client scope or null if not step-up not enabled