Skip to content

Commit 4152685

Browse files
Vipinofficial11Vipinofficial11
committed
Enable TLS Support (DTS - Specific)
(cherry picked from commit e9dd995)
1 parent 0830837 commit 4152685

File tree

10 files changed

+159
-19
lines changed

10 files changed

+159
-19
lines changed

‎oracle-plugin/src/main/java/io/cdap/plugin/oracle/OracleAction.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public static class OracleActionConfig extends DBSpecificQueryConfig {
5757

5858
@Override
5959
public String getConnectionString() {
60-
return OracleConstants.getConnectionString(this.connectionType, host, port, database);
60+
return OracleConstants.getConnectionString(this.connectionType, host, port, database, null);
6161
}
6262

6363
@Override

‎oracle-plugin/src/main/java/io/cdap/plugin/oracle/OracleConnector.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ protected String getConnectionString(@Nullable String database) {
126126
return config.getConnectionString();
127127
}
128128
return OracleConstants.getConnectionString(config.getConnectionType(),
129-
config.getHost(), config.getPort(), database);
129+
config.getHost(), config.getPort(), database, config.getSSlMode());
130130
}
131131

132132
@Override

‎oracle-plugin/src/main/java/io/cdap/plugin/oracle/OracleConnectorConfig.java‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ public OracleConnectorConfig(String host, int port, String user, String password
4343

4444
public OracleConnectorConfig(String host, int port, String user, String password, String jdbcPluginName,
4545
String connectionArguments, String connectionType, String database) {
46-
this(host, port, user, password, jdbcPluginName, connectionArguments, connectionType, database, null);
46+
this(host, port, user, password, jdbcPluginName, connectionArguments, connectionType, database, null, null);
4747
}
4848

4949
public OracleConnectorConfig(String host, int port, String user, String password, String jdbcPluginName,
5050
String connectionArguments, String connectionType, String database,
51-
String role) {
51+
String role, Boolean useSSL) {
5252

5353
this.host = host;
5454
this.port = port;
@@ -59,11 +59,12 @@ public OracleConnectorConfig(String host, int port, String user, String password
5959
this.connectionType = connectionType;
6060
this.database = database;
6161
this.role = role;
62+
this.useSSL = useSSL;
6263
}
6364

6465
@Override
6566
public String getConnectionString() {
66-
return OracleConstants.getConnectionString(connectionType, host, getPort(), database);
67+
return OracleConstants.getConnectionString(connectionType, host, getPort(), database, useSSL);
6768
}
6869

6970
@Name(OracleConstants.CONNECTION_TYPE)
@@ -86,6 +87,11 @@ public String getConnectionString() {
8687
@Nullable
8788
private String transactionIsolationLevel;
8889

90+
@Name(OracleConstants.USE_SSL)
91+
@Description("Turns on SSL encryption. Connection will fail if SSL is not available")
92+
@Nullable
93+
public Boolean useSSL;
94+
8995
@Override
9096
protected int getDefaultPort() {
9197
return 1521;
@@ -103,6 +109,11 @@ public String getDatabase() {
103109
return database;
104110
}
105111

112+
public Boolean getSSlMode() {
113+
// return false if useSSL is null, otherwise return its value
114+
return useSSL != null && useSSL;
115+
}
116+
106117
@Override
107118
public Properties getConnectionArgumentsProperties() {
108119
Properties prop = super.getConnectionArgumentsProperties();

‎oracle-plugin/src/main/java/io/cdap/plugin/oracle/OracleConstants.java‎

Lines changed: 77 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,35 +29,103 @@ private OracleConstants() {
2929
public static final String PLUGIN_NAME = "Oracle";
3030
public static final String ORACLE_CONNECTION_STRING_SID_FORMAT = "jdbc:oracle:thin:@%s:%s:%s";
3131
public static final String ORACLE_CONNECTION_STRING_SERVICE_NAME_FORMAT = "jdbc:oracle:thin:@//%s:%s/%s";
32+
// Connection formats to accept protocol (e.g., jdbc:oracle:thin:@<protocol>://<host>:<port>/<SID>)
33+
public static final String ORACLE_CONNECTION_STRING_SID_FORMAT_WITH_PROTOCOL = "jdbc:oracle:thin:@%s:%s:%s/%s";
34+
public static final String ORACLE_CONNECTION_STRING_SERVICE_NAME_FORMAT_WITH_PROTOCOL =
35+
"jdbc:oracle:thin:@%s://%s:%s/%s";
3236
public static final String ORACLE_CONNECTION_STRING_TNS_FORMAT = "jdbc:oracle:thin:@%s";
3337
public static final String DEFAULT_BATCH_VALUE = "defaultBatchValue";
3438
public static final String DEFAULT_ROW_PREFETCH = "defaultRowPrefetch";
3539
public static final String SERVICE_CONNECTION_TYPE = "service";
3640
public static final String CONNECTION_TYPE = "connectionType";
3741
public static final String ROLE = "role";
3842
public static final String NAME_DATABASE = "database";
39-
public static final String TNS_CONNECTION_TYPE = "TNS";
43+
public static final String TNS_CONNECTION_TYPE = "tns";
4044
public static final String TRANSACTION_ISOLATION_LEVEL = "transactionIsolationLevel";
45+
public static final String USE_SSL = "useSSL";
4146

4247
/**
43-
* Returns the Connection String for the given ConnectionType.
48+
* Constructs the Oracle connection string based on the provided connection type, host, port, and database.
49+
* If SSL is enabled, the connection protocol will be "tcps" instead of "tcp".
4450
*
4551
* @param connectionType TNS/Service/SID
4652
* @param host Host name of the oracle server
4753
* @param port Port of the oracle server
4854
* @param database Database to connect to
49-
* @return Connection String based on the given ConnectionType
55+
* @param useSSL Whether SSL/TLS is required(YES/NO)
56+
* @return Connection String based on the given parameters and connection type.
5057
*/
5158
public static String getConnectionString(String connectionType,
5259
@Nullable String host,
5360
@Nullable int port,
54-
String database) {
55-
if (OracleConstants.TNS_CONNECTION_TYPE.equalsIgnoreCase(connectionType)) {
56-
return String.format(OracleConstants.ORACLE_CONNECTION_STRING_TNS_FORMAT, database);
61+
String database,
62+
@Nullable Boolean useSSL) {
63+
// Use protocol as "tcps" when SSL is requested or else use "tcp".
64+
String connectionProtocol;
65+
boolean isSSLEnabled = false;
66+
if (useSSL != null && useSSL) {
67+
connectionProtocol = "tcps";
68+
isSSLEnabled = true;
69+
} else {
70+
connectionProtocol = "tcp";
5771
}
58-
if (OracleConstants.SERVICE_CONNECTION_TYPE.equalsIgnoreCase(connectionType)) {
59-
return String.format(OracleConstants.ORACLE_CONNECTION_STRING_SERVICE_NAME_FORMAT,
60-
host, port, database);
72+
73+
switch (connectionType.toLowerCase()) {
74+
case OracleConstants.TNS_CONNECTION_TYPE:
75+
// TNS connection doesn't require protocol
76+
return String.format(OracleConstants.ORACLE_CONNECTION_STRING_TNS_FORMAT, database);
77+
case OracleConstants.SERVICE_CONNECTION_TYPE:
78+
// Create connection string for SERVICE type.
79+
return getConnectionStringWithService(host, port, database, connectionProtocol, isSSLEnabled);
80+
default:
81+
// Default to SID format if no matching case is found.
82+
return getConnectionStringWithSID(host, port, database, connectionProtocol, isSSLEnabled);
83+
}
84+
}
85+
86+
/**
87+
* Constructs the connection string for a SERVICE connection type.
88+
*
89+
* @param host Host name of the Oracle server.
90+
* @param port Port of the Oracle server.
91+
* @param database Database name to connect to.
92+
* @param connectionProtocol Protocol to use for the connection ("tcp" or "tcps").
93+
* @param isSSLEnabled Indicates if SSL is enabled.
94+
* @return Formatted connection string for a SERVICE connection.
95+
*/
96+
private static String getConnectionStringWithService(@Nullable String host,
97+
@Nullable int port,
98+
String database,
99+
String connectionProtocol,
100+
boolean isSSLEnabled) {
101+
// Choose the appropriate format based on whether SSL is enabled.
102+
if (isSSLEnabled) {
103+
return String.format(OracleConstants.ORACLE_CONNECTION_STRING_SERVICE_NAME_FORMAT_WITH_PROTOCOL,
104+
connectionProtocol, host, port, database);
105+
}
106+
return String.format(OracleConstants.ORACLE_CONNECTION_STRING_SERVICE_NAME_FORMAT,
107+
host, port, database);
108+
}
109+
110+
/**
111+
* Constructs the connection string for a SID connection type.
112+
*
113+
* @param host Host name of the Oracle server.
114+
* @param port Port of the Oracle server.
115+
* @param database Database name to connect to.
116+
* @param connectionProtocol Protocol to use for the connection ("tcp" or "tcps").
117+
* @param isSSLEnabled Indicates if SSL is enabled.
118+
* @return Formatted connection string for a SID connection.
119+
*/
120+
private static String getConnectionStringWithSID(@Nullable String host,
121+
@Nullable int port,
122+
String database,
123+
String connectionProtocol,
124+
boolean isSSLEnabled) {
125+
// Choose the appropriate format based on whether SSL is enabled.
126+
if (isSSLEnabled) {
127+
return String.format(OracleConstants.ORACLE_CONNECTION_STRING_SID_FORMAT_WITH_PROTOCOL,
128+
connectionProtocol, host, port, database);
61129
}
62130
return String.format(OracleConstants.ORACLE_CONNECTION_STRING_SID_FORMAT,
63131
host, port, database);

‎oracle-plugin/src/main/java/io/cdap/plugin/oracle/OraclePostAction.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public static class OracleQueryActionConfig extends DBSpecificQueryActionConfig
5757

5858
@Override
5959
public String getConnectionString() {
60-
return OracleConstants.getConnectionString(this.connectionType, host, port, database);
60+
return OracleConstants.getConnectionString(this.connectionType, host, port, database, null);
6161
}
6262

6363
@Override

‎oracle-plugin/src/main/java/io/cdap/plugin/oracle/OracleSource.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,9 @@ public OracleSourceConfig(String host, int port, String user, String password, S
117117
String connectionArguments, String connectionType, String database, String role,
118118
int defaultBatchValue, int defaultRowPrefetch,
119119
String importQuery, Integer numSplits, int fetchSize,
120-
String boundingQuery, String splitBy) {
120+
String boundingQuery, String splitBy, Boolean useSSL) {
121121
this.connection = new OracleConnectorConfig(host, port, user, password, jdbcPluginName, connectionArguments,
122-
connectionType, database, role);
122+
connectionType, database, role, useSSL);
123123
this.defaultBatchValue = defaultBatchValue;
124124
this.defaultRowPrefetch = defaultRowPrefetch;
125125
this.fetchSize = fetchSize;
@@ -132,7 +132,7 @@ public OracleSourceConfig(String host, int port, String user, String password, S
132132
@Override
133133
public String getConnectionString() {
134134
return OracleConstants.getConnectionString(connection.getConnectionType(), connection.getHost(),
135-
connection.getPort(), connection.getDatabase());
135+
connection.getPort(), connection.getDatabase(), connection.getSSlMode());
136136
}
137137

138138
@Override

‎oracle-plugin/src/test/java/io/cdap/plugin/oracle/OracleFailedConnectionTest.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ public class OracleFailedConnectionTest extends DBSpecificFailedConnectionTest {
2828
public void test() throws ClassNotFoundException, IOException {
2929

3030
OracleConnector connector = new OracleConnector(
31-
new OracleConnectorConfig("localhost", 1521, "username", "password", "jdbc", "", "database"));
31+
new OracleConnectorConfig("localhost", 1521, "username", "password", "jdbc", "",
32+
"SID", "database"));
3233

3334
super.test(JDBC_DRIVER_CLASS_NAME, connector, "Failed to create connection to database via connection string:" +
3435
" jdbc:oracle:thin:@localhost:1521:database and arguments: " +

‎oracle-plugin/widgets/Oracle-batchsink.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,26 @@
100100
"default": "TRANSACTION_SERIALIZABLE"
101101
}
102102
},
103+
{
104+
"widget-type": "hidden",
105+
"label": "TLS Encryption",
106+
"name": "useSSL",
107+
"description": "Enable TLS encryption (true/false)",
108+
"widget-attributes": {
109+
"layout": "inline",
110+
"default": "false",
111+
"options": [
112+
{
113+
"id": "true",
114+
"label": "true"
115+
},
116+
{
117+
"id": "false",
118+
"label": "false"
119+
}
120+
]
121+
}
122+
},
103123
{
104124
"name": "connectionType",
105125
"label": "Connection Type",

‎oracle-plugin/widgets/Oracle-batchsource.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,26 @@
100100
"default": "TRANSACTION_SERIALIZABLE"
101101
}
102102
},
103+
{
104+
"widget-type": "hidden",
105+
"label": "TLS Encryption",
106+
"name": "useSSL",
107+
"description": "Enable TLS encryption (true/false)",
108+
"widget-attributes": {
109+
"layout": "inline",
110+
"default": "false",
111+
"options": [
112+
{
113+
"id": "true",
114+
"label": "true"
115+
},
116+
{
117+
"id": "false",
118+
"label": "false"
119+
}
120+
]
121+
}
122+
},
103123
{
104124
"name": "connectionType",
105125
"label": "Connection Type",

‎oracle-plugin/widgets/Oracle-connector.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,26 @@
109109
],
110110
"default": "TRANSACTION_SERIALIZABLE"
111111
}
112+
},
113+
{
114+
"widget-type": "hidden",
115+
"label": "TLS Encryption",
116+
"name": "useSSL",
117+
"description": "Enable TLS encryption (true/false)",
118+
"widget-attributes": {
119+
"layout": "inline",
120+
"default": "false",
121+
"options": [
122+
{
123+
"id": "true",
124+
"label": "true"
125+
},
126+
{
127+
"id": "false",
128+
"label": "false"
129+
}
130+
]
131+
}
112132
}
113133
]
114134
},

0 commit comments

Comments
 (0)