KNOX-3202: Oracle DB support for TokeStateService, Refactored JDBCUti… (#1134)

* KNOX-3202: Oracle DB support for TokeStateService, Refactored JDBCUtils into DataSourceFactory

* KNOX-3202: Oracle support for RemoteConfigDatabase, Removed IF NOT EXISTS from Oracle sql for older DB support

* KNOX-3202: Changed ojdbc11 scope to provided

Author: hanicz

gateway-server/pom.xml

@@ -435,6 +435,11 @@
             <artifactId>mysql-connector-java</artifactId>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.oracle.database.jdbc</groupId>
+            <artifactId>ojdbc11</artifactId>
+            <scope>provided</scope>
+        </dependency>
         <dependency>
             <groupId>org.mariadb.jdbc</groupId>
             <artifactId>mariadb-java-client</artifactId>

gateway-server/src/main/java/org/apache/knox/gateway/database/AbstractDataSource.java

@@ -0,0 +1,61 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.knox.gateway.database;
+
+import org.apache.knox.gateway.config.GatewayConfig;
+import org.apache.knox.gateway.services.security.AliasService;
+import org.apache.knox.gateway.services.security.AliasServiceException;
+
+import javax.sql.DataSource;
+import java.sql.SQLException;
+
+public abstract class AbstractDataSource {
+
+    public static final String TOKENS_TABLE_CREATE_SQL_FILE_NAME = "createKnoxTokenDatabaseTable.sql";
+    public static final String TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME = "createKnoxTokenMetadataDatabaseTable.sql";
+    public static final String ORACLE_TOKENS_TABLE_CREATE_SQL_FILE_NAME = "createKnoxTokenDatabaseTableOracle.sql";
+    public static final String ORACLE_TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME = "createKnoxTokenMetadataDatabaseTableOracle.sql";
+    public static final String DERBY_TOKENS_TABLE_CREATE_SQL_FILE_NAME = "createKnoxTokenDatabaseTableDerby.sql";
+    public static final String DERBY_TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME = "createKnoxTokenMetadataDatabaseTableDerby.sql";
+
+    public static final String KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME = "createKnoxProvidersTable.sql";
+    public static final String KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME = "createKnoxDescriptorsTable.sql";
+    public static final String ORACLE_KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME = "createKnoxProvidersTableOracle.sql";
+    public static final String ORACLE_KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME = "createKnoxDescriptorsTableOracle.sql";
+    public static final String DERBY_KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME = "createKnoxProvidersTableDerby.sql";
+    public static final String DERBY_KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME = "createKnoxDescriptorsTableDerby.sql";
+
+    public static final String DATABASE_USER_ALIAS_NAME = "gateway_database_user";
+    public static final String DATABASE_PASSWORD_ALIAS_NAME = "gateway_database_password";
+    public static final String DATABASE_TRUSTSTORE_PASSWORD_ALIAS_NAME = "gateway_database_ssl_truststore_password";
+
+    public abstract DataSource createDataSource(GatewayConfig gatewayConfig, AliasService aliasService) throws AliasServiceException, SQLException;
+
+    protected String getDatabaseUser(AliasService aliasService) throws AliasServiceException {
+        return getDatabaseAlias(aliasService, DATABASE_USER_ALIAS_NAME);
+    }
+
+    protected String getDatabasePassword(AliasService aliasService) throws AliasServiceException {
+        return getDatabaseAlias(aliasService, DATABASE_PASSWORD_ALIAS_NAME);
+    }
+
+    protected String getDatabaseAlias(AliasService aliasService, String aliasName) throws AliasServiceException {
+        final char[] value = aliasService.getPasswordFromAliasForGateway(aliasName);
+        return value == null ? null : new String(value);
+    }
+}

gateway-server/src/main/java/org/apache/knox/gateway/database/DataSourceFactory.java

@@ -0,0 +1,45 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.knox.gateway.database;
+
+import org.apache.knox.gateway.config.GatewayConfig;
+import org.apache.knox.gateway.services.security.AliasService;
+import org.apache.knox.gateway.services.security.AliasServiceException;
+
+import javax.sql.DataSource;
+import java.sql.SQLException;
+
+public class DataSourceFactory {
+
+    public static DataSource getDataSource(GatewayConfig gatewayConfig, AliasService aliasService) throws AliasServiceException, SQLException {
+        DatabaseType dbType = DatabaseType.fromString(gatewayConfig.getDatabaseType());
+        AbstractDataSource dsFactory;
+
+        switch (dbType) {
+            case POSTGRESQL -> dsFactory = new PostgresDataSource();
+            case MYSQL -> dsFactory = new MysqlDataSource();
+            case MARIADB -> dsFactory = new MariaDBDataSource();
+            case DERBY -> dsFactory = new DerbyDataSource();
+            case HSQL -> dsFactory = new HsqlDataSource();
+            case ORACLE -> dsFactory = new OracleDataSource();
+            default -> throw new IllegalArgumentException("Invalid database type: " + gatewayConfig.getDatabaseType());
+        }
+
+        return dsFactory.createDataSource(gatewayConfig, aliasService);
+    }
+}

gateway-server/src/main/java/org/apache/knox/gateway/database/DatabaseType.java

@@ -0,0 +1,100 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.knox.gateway.database;
+
+public enum DatabaseType {
+    POSTGRESQL("postgresql",
+            AbstractDataSource.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
+    ),
+    MYSQL("mysql",
+            AbstractDataSource.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
+    ),
+    MARIADB("mariadb",
+            AbstractDataSource.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
+    ),
+    HSQL("hsql",
+            AbstractDataSource.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
+    ),
+    DERBY("derbydb",
+            AbstractDataSource.DERBY_TOKENS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.DERBY_TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.DERBY_KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.DERBY_KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
+    ),
+    ORACLE("oracle",
+            AbstractDataSource.ORACLE_TOKENS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.ORACLE_TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.ORACLE_KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
+            AbstractDataSource.ORACLE_KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
+    );
+
+    private final String type;
+    private final String tokensTableSql;
+    private final String metadataTableSql;
+    private final String providersTableSql;
+    private final String descriptorsTableSql;
+
+    DatabaseType(String type, String tokensTableSql, String metadataTableSql,  String providersTableSql, String descriptorsTableSql) {
+        this.type = type;
+        this.tokensTableSql = tokensTableSql;
+        this.metadataTableSql = metadataTableSql;
+        this.providersTableSql = providersTableSql;
+        this.descriptorsTableSql = descriptorsTableSql;
+    }
+
+    public String type() {
+        return type;
+    }
+
+    public String tokensTableSql() {
+        return tokensTableSql;
+    }
+
+    public String metadataTableSql() {
+        return metadataTableSql;
+    }
+
+    public String providersTableSql() {
+        return providersTableSql;
+    }
+
+    public String descriptorsTableSql() {
+        return descriptorsTableSql;
+    }
+
+    public static DatabaseType fromString(String dbType) {
+        for (DatabaseType dt : values()) {
+            if (dt.type.equalsIgnoreCase(dbType)) {
+                return dt;
+            }
+        }
+        throw new IllegalArgumentException("Invalid database type: " + dbType);
+    }
+}

gateway-server/src/main/java/org/apache/knox/gateway/database/DerbyDataSource.java

@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.knox.gateway.database;
+
+import org.apache.derby.jdbc.EmbeddedDataSource;
+import org.apache.knox.gateway.config.GatewayConfig;
+import org.apache.knox.gateway.services.security.AliasService;
+import org.apache.knox.gateway.services.security.AliasServiceException;
+
+import javax.sql.DataSource;
+import java.sql.SQLException;
+
+public class DerbyDataSource extends AbstractDataSource {
+
+    @Override
+    public DataSource createDataSource(GatewayConfig gatewayConfig, AliasService aliasService) throws AliasServiceException, SQLException {
+        final EmbeddedDataSource embeddedDataSource = new EmbeddedDataSource();
+        embeddedDataSource.setDatabaseName(gatewayConfig.getDatabaseName());
+        embeddedDataSource.setUser(getDatabaseUser(aliasService));
+        embeddedDataSource.setPassword(getDatabasePassword(aliasService));
+        return embeddedDataSource;
+    }
+}

gateway-server/src/main/java/org/apache/knox/gateway/database/HsqlDataSource.java

@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.knox.gateway.database;
+
+import org.apache.knox.gateway.config.GatewayConfig;
+import org.apache.knox.gateway.services.security.AliasService;
+import org.apache.knox.gateway.services.security.AliasServiceException;
+import org.hsqldb.jdbc.JDBCDataSource;
+
+import javax.sql.DataSource;
+import java.sql.SQLException;
+
+public class HsqlDataSource extends AbstractDataSource {
+
+    @Override
+    public DataSource createDataSource(GatewayConfig gatewayConfig, AliasService aliasService) throws AliasServiceException, SQLException {
+        JDBCDataSource hsqlDatasource = new JDBCDataSource();
+        hsqlDatasource.setUrl(gatewayConfig.getDatabaseConnectionUrl());
+        hsqlDatasource.setUser(getDatabaseUser(aliasService));
+        hsqlDatasource.setPassword(getDatabasePassword(aliasService));
+        return hsqlDatasource;
+    }
+}

gateway-server/src/main/java/org/apache/knox/gateway/database/JDBCUtils.java

@@ -0,0 +1,54 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.knox.gateway.database;
+
+import org.apache.commons.io.IOUtils;
+
+import javax.sql.DataSource;
+import java.io.InputStream;
+import java.sql.Connection;
+import java.sql.DatabaseMetaData;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.sql.Statement;
+import java.util.Locale;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+
+public class JDBCUtils {
+
+    public static boolean tableExists(String tableName, DataSource dataSource) throws SQLException {
+        boolean exists;
+        try (Connection connection = dataSource.getConnection()) {
+            final DatabaseMetaData dbMetadata = connection.getMetaData();
+            final String tableNameToCheck = dbMetadata.storesUpperCaseIdentifiers() ? tableName : tableName.toLowerCase(Locale.ROOT);
+            try (ResultSet tables = dbMetadata.getTables(connection.getCatalog(), null, tableNameToCheck, null)) {
+                exists = tables.next();
+            }
+        }
+        return exists;
+    }
+
+    public static void createTableFromSQL(String createSqlFileName, DataSource dataSource, ClassLoader classLoader) throws Exception {
+        try (InputStream is = classLoader.getResourceAsStream(createSqlFileName);
+             Connection connection = dataSource.getConnection();Statement createTableStatement = connection.createStatement()) {
+            String createTableSql = IOUtils.toString(is, UTF_8);
+            createTableStatement.execute(createTableSql);
+        }
+    }
+}

gateway-server/src/main/java/org/apache/knox/gateway/database/MariaDBDataSource.java

@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.knox.gateway.database;
+
+import org.apache.knox.gateway.config.GatewayConfig;
+import org.apache.knox.gateway.services.security.AliasService;
+import org.apache.knox.gateway.services.security.AliasServiceException;
+import org.mariadb.jdbc.MariaDbDataSource;
+
+import javax.sql.DataSource;
+import java.sql.SQLException;
+
+public class MariaDBDataSource extends AbstractDataSource {
+
+    @Override
+    public DataSource createDataSource(GatewayConfig gatewayConfig, AliasService aliasService) throws AliasServiceException, SQLException {
+        if (gatewayConfig.getDatabaseConnectionUrl() != null) {
+            return new MariaDbDataSource(gatewayConfig.getDatabaseConnectionUrl());
+        } else {
+            throw new IllegalArgumentException("MariaDB Java Datasource requires a connection string!");
+        }
+    }
+}