org.keycloak.connections.jpa.updater.liquibase.custom.MigrateUserFedToComponent クラス

org.keycloak.connections.jpa.updater.liquibase.custom.MigrateUserFedToComponent の継承関係図

org.keycloak.connections.jpa.updater.liquibase.custom.MigrateUserFedToComponent 連携図

公開メンバ関数
ValidationErrors	validate (Database database)
void	setFileOpener (ResourceAccessor resourceAccessor)
String	getConfirmationMessage ()
void	setUp () throws SetupException
SqlStatement []	generateStatements (Database database) throws CustomChangeException

限定公開メンバ関数
void	generateStatementsImpl () throws CustomChangeException
String	getTaskId ()
void	convertFedProviderToComponent (String providerId, String newMapperType) throws CustomChangeException
InsertStatement	componentConfigStatement (String componentId, String name, String value)
void	convertFedMapperToComponent (String realmId, String parentId, String newMapperType) throws CustomChangeException
boolean	isApplicable () throws CustomChangeException
String	getTableName (String tableName)

限定公開変数類
KeycloakSession	kcSession
Database	database
JdbcConnection	jdbcConnection
Connection	connection
StringBuilder	confirmationMessage = new StringBuilder()
List< SqlStatement >	statements = new ArrayList<SqlStatement>()

詳解

著者

Bill Burke

関数詳解

componentConfigStatement()

InsertStatement org.keycloak.connections.jpa.updater.liquibase.custom.AbstractUserFedToComponent.componentConfigStatement ( String  componentId, String  name, String  value  )

inlineprotectedinherited

                                                                                                      {
        return new InsertStatement(null, null, database.correctObjectName("COMPONENT_CONFIG", Table.class))
                .addColumnValue("ID", KeycloakModelUtils.generateId())
                .addColumnValue("COMPONENT_ID", componentId)
                .addColumnValue("NAME", name)
                .addColumnValue("VALUE", value);
    }

convertFedMapperToComponent()

void org.keycloak.connections.jpa.updater.liquibase.custom.AbstractUserFedToComponent.convertFedMapperToComponent ( String  realmId, String  parentId, String  newMapperType  ) throws CustomChangeException

inlineprotectedinherited

                                                                                                                                   {
        try {
            PreparedStatement statement = jdbcConnection.prepareStatement("select ID, NAME, FEDERATION_MAPPER_TYPE from " + getTableName("USER_FEDERATION_MAPPER") + " WHERE FEDERATION_PROVIDER_ID=?");
            statement.setString(1, parentId);

            try {
                ResultSet resultSet = statement.executeQuery();
                try {
                    while (resultSet.next()) {
                        String id = resultSet.getString(1);
                        String mapperName = resultSet.getString(2);
                        String fedMapperType = resultSet.getString(3);

                        InsertStatement insertComponent = new InsertStatement(null, null, database.correctObjectName("COMPONENT", Table.class))
                                .addColumnValue("ID", id)
                                .addColumnValue("REALM_ID", realmId)
                                .addColumnValue("PARENT_ID", parentId)
                                .addColumnValue("NAME", mapperName)
                                .addColumnValue("PROVIDER_ID", fedMapperType)
                                .addColumnValue("PROVIDER_TYPE", newMapperType);

                        statements.add(insertComponent);



                        PreparedStatement configStatement = jdbcConnection.prepareStatement("select name, VALUE from " + getTableName("USER_FEDERATION_MAPPER_CONFIG") + " WHERE USER_FEDERATION_MAPPER_ID=?");
                        configStatement.setString(1, id);
                        try {
                            ResultSet configSet = configStatement.executeQuery();
                            try {
                                while (configSet.next()) {
                                    String name = configSet.getString(1);
                                    String value = configSet.getString(2);
                                    statements.add(componentConfigStatement(id, name, value));
                                }
                            } finally {
                                configSet.close();
                            }
                        } finally {
                            configStatement.close();
                        }
                        DeleteStatement configDelete = new DeleteStatement(null, null, database.correctObjectName("USER_FEDERATION_MAPPER_CONFIG", Table.class));
                        configDelete.setWhere("USER_FEDERATION_MAPPER_ID=?");
                        configDelete.addWhereParameters(id);
                        statements.add(configDelete);
                        DeleteStatement deleteStatement = new DeleteStatement(null, null, database.correctObjectName("USER_FEDERATION_MAPPER", Table.class));
                        deleteStatement.setWhere("ID=?");
                        deleteStatement.addWhereParameters(id);
                        statements.add(deleteStatement);


                    }
                } finally {
                    resultSet.close();
                }
            } finally {
                statement.close();
            }

            confirmationMessage.append("Updated " + statements.size() + " records in USER_FEDERATION_MAPPER table for " + parentId + " conversion to component model");
        } catch (Exception e) {
            throw new CustomChangeException(getTaskId() + ": Exception when updating data from previous version", e);
        }
    }

convertFedProviderToComponent()

void org.keycloak.connections.jpa.updater.liquibase.custom.AbstractUserFedToComponent.convertFedProviderToComponent ( String  providerId, String  newMapperType  ) throws CustomChangeException

inlineprotectedinherited

                                                                                                                       {
        try {
            PreparedStatement statement = jdbcConnection.prepareStatement("select ID, REALM_ID, PRIORITY, DISPLAY_NAME, FULL_SYNC_PERIOD, CHANGED_SYNC_PERIOD, LAST_SYNC from " + getTableName("USER_FEDERATION_PROVIDER") + " WHERE PROVIDER_NAME=?");
            statement.setString(1, providerId);

            try {
                ResultSet resultSet = statement.executeQuery();
                try {
                    while (resultSet.next()) {
                        int index = 1;
                        String id = resultSet.getString(index++);
                        String realmId = resultSet.getString(index++);
                        int priority = resultSet.getInt(index++);
                        String displayName = resultSet.getString(index++);
                        int fullSyncPeriod = resultSet.getInt(index++);
                        int changedSyncPeriod = resultSet.getInt(index++);
                        int lastSync = resultSet.getInt(index++);


                        InsertStatement insertComponent = new InsertStatement(null, null, database.correctObjectName("COMPONENT", Table.class))
                                .addColumnValue("ID", id)
                                .addColumnValue("REALM_ID", realmId)
                                .addColumnValue("PARENT_ID", realmId)
                                .addColumnValue("NAME", displayName)
                                .addColumnValue("PROVIDER_ID", providerId)
                                .addColumnValue("PROVIDER_TYPE", UserStorageProvider.class.getName());

                        statements.add(insertComponent);

                        statements.add(componentConfigStatement(id, "priority", Integer.toString(priority)));
                        statements.add(componentConfigStatement(id, "fullSyncPeriod", Integer.toString(fullSyncPeriod)));
                        statements.add(componentConfigStatement(id, "changedSyncPeriod", Integer.toString(changedSyncPeriod)));
                        statements.add(componentConfigStatement(id, "lastSync", Integer.toString(lastSync)));
                        PreparedStatement configStatement = jdbcConnection.prepareStatement("select name, VALUE from " + getTableName("USER_FEDERATION_CONFIG") + " WHERE USER_FEDERATION_PROVIDER_ID=?");
                        configStatement.setString(1, id);
                        try {
                            ResultSet configSet = configStatement.executeQuery();
                            try {
                                while (configSet.next()) {
                                    String name = configSet.getString(1);
                                    String value = configSet.getString(2);
                                    //logger.info("adding component config: " + name + ": " + value);
                                    statements.add(componentConfigStatement(id, name, value));
                                }
                            } finally {
                                configSet.close();
                            }
                        } finally {
                            configStatement.close();
                        }

                        if (newMapperType != null) {
                            convertFedMapperToComponent(realmId, id, newMapperType);
                        }

                        DeleteStatement configDelete = new DeleteStatement(null, null, database.correctObjectName("USER_FEDERATION_CONFIG", Table.class));
                        configDelete.setWhere("USER_FEDERATION_PROVIDER_ID=?");
                        configDelete.addWhereParameters(id);

                        statements.add(configDelete);
                        DeleteStatement deleteStatement = new DeleteStatement(null, null, database.correctObjectName("USER_FEDERATION_PROVIDER", Table.class));
                        deleteStatement.setWhere("ID=?");
                        deleteStatement.addWhereParameters(id);
                        statements.add(deleteStatement);

                    }
                } finally {
                    resultSet.close();
                }
            } finally {
                statement.close();
            }

            confirmationMessage.append("Updated " + statements.size() + " records in USER_FEDERATION_PROVIDER table for " + providerId + " conversion to component model");
        } catch (Exception e) {
            throw new CustomChangeException(getTaskId() + ": Exception when updating data from previous version", e);
        }
    }

generateStatements()

SqlStatement [] org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.generateStatements ( Database  database ) throws CustomChangeException

inlineinherited

                                                                                             {
        this.database = database;
        jdbcConnection = (JdbcConnection) database.getConnection();
        connection = jdbcConnection.getWrappedConnection();

        if (isApplicable()) {
            confirmationMessage.append(getTaskId() + ": ");
            generateStatementsImpl();
        } else {
            confirmationMessage.append(getTaskId() + ": no update applicable for this task");
        }

        return statements.toArray(new SqlStatement[statements.size()]);
    }

generateStatementsImpl()

void org.keycloak.connections.jpa.updater.liquibase.custom.MigrateUserFedToComponent.generateStatementsImpl ( ) throws CustomChangeException

inlineprotected

                                                                         {
        List<ProviderFactory> factories = kcSession.getKeycloakSessionFactory().getProviderFactories(UserStorageProvider.class);
        for (ProviderFactory factory : factories) {
            if (!factory.getId().equals(LDAPConstants.LDAP_PROVIDER)) {
                convertFedProviderToComponent(factory.getId(), null);
            }
        }
    }

getConfirmationMessage()

String org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.getConfirmationMessage ( )

inlineinherited

                                           {
        return confirmationMessage.toString();
    }

getTableName()

String org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.getTableName ( String  tableName )

inlineprotectedinherited

                                                    {
        String correctedSchemaName = database.escapeObjectName(database.getDefaultSchemaName(), Schema.class);
        return LiquibaseJpaUpdaterProvider.getTable(tableName, correctedSchemaName);
    }

getTaskId()

String org.keycloak.connections.jpa.updater.liquibase.custom.MigrateUserFedToComponent.getTaskId ( )

inlineprotected

                                 {
        return "Update 2.5.0.Final";
    }

isApplicable()

boolean org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.isApplicable ( ) throws CustomChangeException

inlineprotectedinherited

                                                                  {
        try {
            String correctedTableName = database.correctObjectName("REALM", Table.class);
            if (SnapshotGeneratorFactory.getInstance().has(new Table().setName(correctedTableName), database)) {
                ResultSet resultSet = connection.createStatement().executeQuery("SELECT ID FROM " + getTableName(correctedTableName));
                try {
                    return (resultSet.next());
                } finally {
                    resultSet.close();
                }
            } else {
                return false;
            }
        } catch (Exception e) {
            throw new CustomChangeException("Failed to check database availability", e);
        }
    }

setFileOpener()

void org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.setFileOpener ( ResourceAccessor  resourceAccessor )

inlineinherited

                                                                 {

    }

setUp()

void org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.setUp ( ) throws SetupException

inlineinherited

                                              {
        this.kcSession = ThreadLocalSessionContext.getCurrentSession();

        if (this.kcSession == null) {
            // Probably running Liquibase from maven plugin. Try to create kcSession programmatically
            logger.info("No KeycloakSession provided in ThreadLocal. Initializing KeycloakSessionFactory");

            try {
                DefaultKeycloakSessionFactory factory = new DefaultKeycloakSessionFactory();
                factory.init();
                this.kcSession = factory.create();
            } catch (Exception e) {
                throw new SetupException("Exception when initializing factory", e);
            }
        }
    }

validate()

ValidationErrors org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.validate ( Database  database )

inlineinherited

                                                        {
        return null;
    }

メンバ詳解

confirmationMessage

StringBuilder org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.confirmationMessage = new StringBuilder()

protectedinherited

connection

Connection org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.connection

protectedinherited

database

Database org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.database

protectedinherited

jdbcConnection

JdbcConnection org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.jdbcConnection

protectedinherited

kcSession

KeycloakSession org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.kcSession

protectedinherited

statements

List<SqlStatement> org.keycloak.connections.jpa.updater.liquibase.custom.CustomKeycloakTask.statements = new ArrayList<SqlStatement>()

protectedinherited

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/connections/jpa/updater/liquibase/custom/MigrateUserFedToComponent.java