001/*-
002 * #%L
003 * HAPI FHIR Server - SQL Migration
004 * %%
005 * Copyright (C) 2014 - 2023 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.jpa.migrate.taskdef;
021
022import ca.uhn.fhir.jpa.migrate.DriverTypeEnum;
023import ca.uhn.fhir.jpa.migrate.JdbcUtils;
024import ca.uhn.fhir.jpa.migrate.tasks.api.ISchemaInitializationProvider;
025import org.apache.commons.lang3.builder.EqualsBuilder;
026import org.apache.commons.lang3.builder.HashCodeBuilder;
027import org.slf4j.Logger;
028import org.slf4j.LoggerFactory;
029
030import java.sql.SQLException;
031import java.util.List;
032import java.util.Set;
033
034public class InitializeSchemaTask extends BaseTask {
035        private static final String DESCRIPTION_PREFIX = "Initialize schema for ";
036        private static final Logger ourLog = LoggerFactory.getLogger(InitializeSchemaTask.class);
037        private final ISchemaInitializationProvider mySchemaInitializationProvider;
038        private boolean myInitializedSchema;
039
040        public InitializeSchemaTask(String theProductVersion, String theSchemaVersion, ISchemaInitializationProvider theSchemaInitializationProvider) {
041                super(theProductVersion, theSchemaVersion);
042                mySchemaInitializationProvider = theSchemaInitializationProvider;
043                setDescription(DESCRIPTION_PREFIX + mySchemaInitializationProvider.getSchemaDescription());
044        }
045
046        @Override
047        public boolean isRunDuringSchemaInitialization() {
048                return true;
049        }
050
051        @Override
052        public void validate() {
053                // nothing
054        }
055
056        @Override
057        public void doExecute() throws SQLException {
058                DriverTypeEnum driverType = getDriverType();
059
060                Set<String> tableNames = JdbcUtils.getTableNames(getConnectionProperties());
061                String schemaExistsIndicatorTable = mySchemaInitializationProvider.getSchemaExistsIndicatorTable();
062                if (tableNames.contains(schemaExistsIndicatorTable)) {
063                        logInfo(ourLog, "The table {} already exists.  Skipping schema initialization for {}", schemaExistsIndicatorTable, driverType);
064                        return;
065                }
066
067                logInfo(ourLog, "Initializing {} schema for {}", driverType, mySchemaInitializationProvider.getSchemaDescription());
068
069                List<String> sqlStatements = mySchemaInitializationProvider.getSqlStatements(driverType);
070
071                for (String nextSql : sqlStatements) {
072                        executeSql(null, nextSql);
073                }
074
075                if (mySchemaInitializationProvider.canInitializeSchema()) {
076                        myInitializedSchema = true;
077                }
078
079                logInfo(ourLog, "{} schema for {} initialized successfully", driverType, mySchemaInitializationProvider.getSchemaDescription());
080        }
081
082        @Override
083        public boolean initializedSchema() {
084                return myInitializedSchema;
085        }
086
087        @Override
088        protected void generateEquals(EqualsBuilder theBuilder, BaseTask theOtherObject) {
089                InitializeSchemaTask otherObject = (InitializeSchemaTask) theOtherObject;
090                theBuilder.append(mySchemaInitializationProvider, otherObject.mySchemaInitializationProvider);
091        }
092
093        @Override
094        protected void generateHashCode(HashCodeBuilder theBuilder) {
095                theBuilder.append(mySchemaInitializationProvider);
096        }
097
098        public ISchemaInitializationProvider getSchemaInitializationProvider() {
099                return mySchemaInitializationProvider;
100        }
101}