Package org.keycloak.services.migration
Class DefaultMigrationProvider
- java.lang.Object
-
- org.keycloak.services.migration.DefaultMigrationProvider
-
- All Implemented Interfaces:
MigrationProvider
,Provider
public class DefaultMigrationProvider extends Object implements MigrationProvider
Various common utils needed for migration from older version to newer- Author:
- Marek Posolda
-
-
Constructor Summary
Constructors Constructor Description DefaultMigrationProvider(KeycloakSession session)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addOIDCAcrClientScope(RealmModel realm)
Add 'acr' client scope or return it if already existsClientScopeModel
addOIDCMicroprofileJWTClientScope(RealmModel realm)
Adds themicroprofile-jwt
optional client scope to the realm and returns the created scope.ClientScopeModel
addOIDCRolesClientScope(RealmModel realm)
Add 'roles' client scope or return it if already existsClientScopeModel
addOIDCWebOriginsClientScope(RealmModel realm)
Add 'web-origins' client scope or return it if already existsvoid
close()
Map<String,ProtocolMapperModel>
getBuiltinMappers(String protocol)
List<ProtocolMapperRepresentation>
getMappersForClaimMask(Long claimMask)
void
setupAdminCli(RealmModel realm)
-
-
-
Constructor Detail
-
DefaultMigrationProvider
public DefaultMigrationProvider(KeycloakSession session)
-
-
Method Detail
-
getMappersForClaimMask
public List<ProtocolMapperRepresentation> getMappersForClaimMask(Long claimMask)
- Specified by:
getMappersForClaimMask
in interfaceMigrationProvider
- Parameters:
claimMask
- mask used on ClientModel in 1.1.0- Returns:
- set of 1.2.0.Beta1 protocol mappers corresponding to given claimMask
-
getBuiltinMappers
public Map<String,ProtocolMapperModel> getBuiltinMappers(String protocol)
- Specified by:
getBuiltinMappers
in interfaceMigrationProvider
-
setupAdminCli
public void setupAdminCli(RealmModel realm)
- Specified by:
setupAdminCli
in interfaceMigrationProvider
-
addOIDCRolesClientScope
public ClientScopeModel addOIDCRolesClientScope(RealmModel realm)
Description copied from interface:MigrationProvider
Add 'roles' client scope or return it if already exists- Specified by:
addOIDCRolesClientScope
in interfaceMigrationProvider
- Returns:
- created or already existing client scope 'roles'
-
addOIDCWebOriginsClientScope
public ClientScopeModel addOIDCWebOriginsClientScope(RealmModel realm)
Description copied from interface:MigrationProvider
Add 'web-origins' client scope or return it if already exists- Specified by:
addOIDCWebOriginsClientScope
in interfaceMigrationProvider
- Returns:
- created or already existing client scope 'web-origins'
-
addOIDCMicroprofileJWTClientScope
public ClientScopeModel addOIDCMicroprofileJWTClientScope(RealmModel realm)
Description copied from interface:MigrationProvider
Adds themicroprofile-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.- Specified by:
addOIDCMicroprofileJWTClientScope
in interfaceMigrationProvider
- 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
public void addOIDCAcrClientScope(RealmModel realm)
Description copied from interface:MigrationProvider
Add 'acr' client scope or return it if already exists- Specified by:
addOIDCAcrClientScope
in interfaceMigrationProvider
-
-