Skip to content

Commit 8d5cbdd

Browse files
haniczhanicz
authored
KNOX-3235: Renamed DB factory classes. Fixed PMD suppress for switch-case (#1136)
1 parent 42715c2 commit 8d5cbdd

15 files changed

+83
-86
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import javax.sql.DataSource;
2525
import java.sql.SQLException;
2626

27-
public abstract class AbstractDataSource {
27+
public abstract class AbstractDataSourceFactory {
2828

2929
public static final String TOKENS_TABLE_CREATE_SQL_FILE_NAME = "createKnoxTokenDatabaseTable.sql";
3030
public static final String TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME = "createKnoxTokenMetadataDatabaseTable.sql";

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

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,19 @@
2424
import javax.sql.DataSource;
2525
import java.sql.SQLException;
2626

27-
public class DataSourceFactory {
27+
public class DataSourceProvider {
2828

29-
@SuppressWarnings("PMD.ExhaustiveSwitchHasDefault")
3029
public static DataSource getDataSource(GatewayConfig gatewayConfig, AliasService aliasService) throws AliasServiceException, SQLException {
3130
DatabaseType dbType = DatabaseType.fromString(gatewayConfig.getDatabaseType());
32-
AbstractDataSource dsFactory;
3331

34-
switch (dbType) {
35-
case POSTGRESQL -> dsFactory = new PostgresDataSource();
36-
case MYSQL -> dsFactory = new MysqlDataSource();
37-
case MARIADB -> dsFactory = new MariaDBDataSource();
38-
case DERBY -> dsFactory = new DerbyDataSource();
39-
case HSQL -> dsFactory = new HsqlDataSource();
40-
case ORACLE -> dsFactory = new OracleDataSource();
41-
default -> throw new IllegalArgumentException("Invalid database type: " + gatewayConfig.getDatabaseType());
42-
}
32+
AbstractDataSourceFactory dsFactory = switch (dbType) {
33+
case POSTGRESQL -> new PostgresDataSourceFactory();
34+
case MYSQL -> new MysqlDataSourceFactory();
35+
case MARIADB -> new MariaDBDataSourceFactory();
36+
case DERBY -> new DerbyDataSourceFactory();
37+
case HSQL -> new HsqlDataSourceFactory();
38+
case ORACLE -> new OracleDataSourceFactory();
39+
};
4340

4441
return dsFactory.createDataSource(gatewayConfig, aliasService);
4542
}

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

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,40 +19,40 @@
1919

2020
public enum DatabaseType {
2121
POSTGRESQL("postgresql",
22-
AbstractDataSource.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
23-
AbstractDataSource.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
24-
AbstractDataSource.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
25-
AbstractDataSource.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
22+
AbstractDataSourceFactory.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
23+
AbstractDataSourceFactory.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
24+
AbstractDataSourceFactory.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
25+
AbstractDataSourceFactory.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
2626
),
2727
MYSQL("mysql",
28-
AbstractDataSource.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
29-
AbstractDataSource.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
30-
AbstractDataSource.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
31-
AbstractDataSource.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
28+
AbstractDataSourceFactory.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
29+
AbstractDataSourceFactory.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
30+
AbstractDataSourceFactory.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
31+
AbstractDataSourceFactory.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
3232
),
3333
MARIADB("mariadb",
34-
AbstractDataSource.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
35-
AbstractDataSource.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
36-
AbstractDataSource.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
37-
AbstractDataSource.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
34+
AbstractDataSourceFactory.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
35+
AbstractDataSourceFactory.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
36+
AbstractDataSourceFactory.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
37+
AbstractDataSourceFactory.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
3838
),
3939
HSQL("hsql",
40-
AbstractDataSource.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
41-
AbstractDataSource.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
42-
AbstractDataSource.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
43-
AbstractDataSource.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
40+
AbstractDataSourceFactory.TOKENS_TABLE_CREATE_SQL_FILE_NAME,
41+
AbstractDataSourceFactory.TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
42+
AbstractDataSourceFactory.KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
43+
AbstractDataSourceFactory.KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
4444
),
4545
DERBY("derbydb",
46-
AbstractDataSource.DERBY_TOKENS_TABLE_CREATE_SQL_FILE_NAME,
47-
AbstractDataSource.DERBY_TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
48-
AbstractDataSource.DERBY_KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
49-
AbstractDataSource.DERBY_KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
46+
AbstractDataSourceFactory.DERBY_TOKENS_TABLE_CREATE_SQL_FILE_NAME,
47+
AbstractDataSourceFactory.DERBY_TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
48+
AbstractDataSourceFactory.DERBY_KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
49+
AbstractDataSourceFactory.DERBY_KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
5050
),
5151
ORACLE("oracle",
52-
AbstractDataSource.ORACLE_TOKENS_TABLE_CREATE_SQL_FILE_NAME,
53-
AbstractDataSource.ORACLE_TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
54-
AbstractDataSource.ORACLE_KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
55-
AbstractDataSource.ORACLE_KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
52+
AbstractDataSourceFactory.ORACLE_TOKENS_TABLE_CREATE_SQL_FILE_NAME,
53+
AbstractDataSourceFactory.ORACLE_TOKEN_METADATA_TABLE_CREATE_SQL_FILE_NAME,
54+
AbstractDataSourceFactory.ORACLE_KNOX_PROVIDERS_TABLE_CREATE_SQL_FILE_NAME,
55+
AbstractDataSourceFactory.ORACLE_KNOX_DESCRIPTORS_TABLE_CREATE_SQL_FILE_NAME
5656
);
5757

5858
private final String type;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import javax.sql.DataSource;
2626
import java.sql.SQLException;
2727

28-
public class DerbyDataSource extends AbstractDataSource {
28+
public class DerbyDataSourceFactory extends AbstractDataSourceFactory {
2929

3030
@Override
3131
public DataSource createDataSource(GatewayConfig gatewayConfig, AliasService aliasService) throws AliasServiceException, SQLException {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import javax.sql.DataSource;
2626
import java.sql.SQLException;
2727

28-
public class HsqlDataSource extends AbstractDataSource {
28+
public class HsqlDataSourceFactory extends AbstractDataSourceFactory {
2929

3030
@Override
3131
public DataSource createDataSource(GatewayConfig gatewayConfig, AliasService aliasService) throws AliasServiceException, SQLException {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import javax.sql.DataSource;
2626
import java.sql.SQLException;
2727

28-
public class MariaDBDataSource extends AbstractDataSource {
28+
public class MariaDBDataSourceFactory extends AbstractDataSourceFactory {
2929

3030
@Override
3131
public DataSource createDataSource(GatewayConfig gatewayConfig, AliasService aliasService) throws AliasServiceException, SQLException {

gateway-server/src/main/java/org/apache/knox/gateway/database/MysqlDataSource.java renamed to gateway-server/src/main/java/org/apache/knox/gateway/database/MysqlDataSourceFactory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import javax.sql.DataSource;
2626
import java.sql.SQLException;
2727

28-
public class MysqlDataSource extends AbstractDataSource {
28+
public class MysqlDataSourceFactory extends AbstractDataSourceFactory {
2929

3030
@Override
3131
public DataSource createDataSource(GatewayConfig gatewayConfig, AliasService aliasService) throws AliasServiceException, SQLException {

gateway-server/src/main/java/org/apache/knox/gateway/database/OracleDataSource.java renamed to gateway-server/src/main/java/org/apache/knox/gateway/database/OracleDataSourceFactory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import javax.sql.DataSource;
2626
import java.sql.SQLException;
2727

28-
public class OracleDataSource extends AbstractDataSource {
28+
public class OracleDataSourceFactory extends AbstractDataSourceFactory {
2929

3030
private static final String THIN_DRIVER = "thin";
3131

gateway-server/src/main/java/org/apache/knox/gateway/database/PostgresDataSource.java renamed to gateway-server/src/main/java/org/apache/knox/gateway/database/PostgresDataSourceFactory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
import javax.sql.DataSource;
2929
import java.sql.SQLException;
3030

31-
public class PostgresDataSource extends AbstractDataSource {
31+
public class PostgresDataSourceFactory extends AbstractDataSourceFactory {
3232

3333
@Override
3434
public DataSource createDataSource(GatewayConfig gatewayConfig, AliasService aliasService) throws AliasServiceException, SQLException {

‎gateway-server/src/main/java/org/apache/knox/gateway/services/token/impl/DerbyDBTokenStateService.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
import static org.apache.knox.gateway.config.impl.GatewayConfigImpl.GATEWAY_DATABASE_NAME;
2020
import static org.apache.knox.gateway.config.impl.GatewayConfigImpl.GATEWAY_DATABASE_TYPE;
2121
import static org.apache.knox.gateway.services.security.AliasService.NO_CLUSTER_NAME;
22-
import static org.apache.knox.gateway.database.AbstractDataSource.DATABASE_PASSWORD_ALIAS_NAME;
23-
import static org.apache.knox.gateway.database.AbstractDataSource.DATABASE_USER_ALIAS_NAME;
22+
import static org.apache.knox.gateway.database.AbstractDataSourceFactory.DATABASE_PASSWORD_ALIAS_NAME;
23+
import static org.apache.knox.gateway.database.AbstractDataSourceFactory.DATABASE_USER_ALIAS_NAME;
2424
import static org.apache.knox.gateway.database.DatabaseType.DERBY;
2525

2626
import java.nio.file.Files;

0 commit comments

Comments
 (0)