/* * Copyright 2016 Red Hat, Inc. and/or its affiliates * and other contributors as indicated by the @author tags. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.keycloak.connections.jpa.updater.liquibase.custom; import liquibase.change.custom.CustomSqlChange; import liquibase.database.Database; import liquibase.database.jvm.JdbcConnection; import liquibase.exception.CustomChangeException; import liquibase.exception.SetupException; import liquibase.exception.ValidationErrors; import liquibase.resource.ResourceAccessor; import liquibase.snapshot.SnapshotGeneratorFactory; import liquibase.statement.SqlStatement; import liquibase.structure.core.Table; import org.jboss.logging.Logger; import org.keycloak.connections.jpa.updater.liquibase.LiquibaseJpaUpdaterProvider; import org.keycloak.connections.jpa.updater.liquibase.ThreadLocalSessionContext; import org.keycloak.models.KeycloakSession; import org.keycloak.services.DefaultKeycloakSessionFactory; import java.sql.Connection; import java.sql.ResultSet; import java.util.ArrayList; import java.util.List; /** * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a> */ public abstract class CustomKeycloakTask implements CustomSqlChange { private final Logger logger = Logger.getLogger(getClass()); protected KeycloakSession kcSession; protected Database database; protected JdbcConnection jdbcConnection; protected Connection connection; protected StringBuilder confirmationMessage = new StringBuilder(); protected List<SqlStatement> statements = new ArrayList<SqlStatement>(); @Override public ValidationErrors validate(Database database) { return null; } @Override public void setFileOpener(ResourceAccessor resourceAccessor) { } @Override public String getConfirmationMessage() { return confirmationMessage.toString(); } @Override public void setUp() throws SetupException { 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); } } } @Override public SqlStatement[] generateStatements(Database database) throws CustomChangeException { 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()]); } protected boolean isApplicable() throws CustomChangeException { 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); } } /** * It's supposed to fill SQL statements to the "statements" variable and fill "confirmationMessage" */ protected abstract void generateStatementsImpl() throws CustomChangeException; protected abstract String getTaskId(); // get Table name for sql selects protected String getTableName(String tableName) { return LiquibaseJpaUpdaterProvider.getTable(tableName, database.getDefaultSchemaName()); } }