Access Live Google Cloud Storage Data in TIBCO Data Virtualization

TIBCO Data Virtualization (TDV) is an enterprise data virtualization solution that orchestrates access to multiple and varied data sources. When paired with the Google Cloud Storage Tibco DV Adapter, you get federated access to live Google Cloud Storage data directly within TIBCO Data Virtualization. This article explains how to deploy an adapter and create a new data source based on Google Cloud Storage.

With built-in optimized data processing, the CData TIBCO DV Adapter offers unmatched performance for interacting with live Google Cloud Storage data. When you issue complex SQL queries to Google Cloud Storage, the adapter pushes supported SQL operations, like filters and aggregations, directly to Google Cloud Storage. Its built-in dynamic metadata querying allows you to work with and analyze Google Cloud Storage data using native data types.

Deploy the Google Cloud Storage TIBCO DV Adapter

1. In a console, navigate to the bin folder in the TDV Server installation directory. If there is a current version of the adapter installed, you will need to undeploy it.

   .\server_util.bat -server localhost -user admin -password ******** -undeploy -version 1 -name GoogleCloudStorage
   

2. Extract the CData TIBCO DV Adapter to a local folder and deploy the JAR file (tdv.googlecloudstorage.jar) to the server from the extract location.

   .\server_util.bat -server localhost -user admin -password ******** -deploy -package /PATH/TO/tdv.googlecloudstorage.jar
   

You may need to restart the server to ensure the new JAR file is loaded properly, which can be accomplished by running the composite.bat script located at: C:\Program Files\TIBCO\TDV Server <version>\bin. Note that reauthenticating to the TDV Studio is required after restarting the server.

Sample Restart Call

.\composite.bat monitor restart

Authenticate with Google Cloud Storage Using OAuth

Since Google Cloud Storage authenticates using the OAuth protocol and TDV Studio does not support browser-based authentication internally, you will need to create and run a simple Java application to retrieve the OAuth tokens. Once retrieved, the tokens are used to connect to Google Cloud Storage directly from the adapter.

Create the Java Application

1. Create a new Java file with preferred name for example GenOAuthSettings.java. This Java file leverages the GoogleCloudStorageOAuth class contained within the TDV Adapter JAR to initiate a test connection and perform the required OAuth authentication flow
2. Copy and insert the following code into the .java file:

public class GenOAuthSettings {
 public static void main(String[] args) {
 try {
 	 if (args.length != 2) {
 			throw new Exception("Input must have two arguments: 'data source', 'connection string'");
 		}
 
 		String source = args[0].replace(" ", "").toLowerCase();
 		String connectionString = args[1];
 		String prefix;
 
 		if (source.equals("googlecloudstorage")) {
 			prefix = "jdbc:googlecloudstorage:";
 
 			com.cdata.cis.googlecloudstorage.GoogleCloudStorageOAuth oauth = new com.cdata.cis.googlecloudstorage.GoogleCloudStorageOAuth();
 
 			if (!connectionString.startsWith(prefix)) connectionString = prefix + connectionString;
 			oauth.generateOAuthSettingsFile(connectionString);
 		}
 		// More sources can be added below using the same format. You must add the import statement and ensure the jar file resides in the classpath
			// else if (source.equals("googlebigquery") || source.equals("bigquery")) {
			// prefix = "jdbc:googlebigquery:";
			//
			// com.cdata.cis.googlebigquery.GoogleBigQueryOAuth oauth = new com.cdata.cis.googlebigquery.GoogleBigQueryOAuth();
			//
			// if (!connectionString.startsWith(prefix)) connectionString = prefix + connectionString;
			// oauth.generateOAuthSettingsFile(connectionString);
			// }
 		else {
				throw new Exception("Data Source not supported. Available Data Sources: Google Cloud Storage");
			}
			
			System.out.println("Test Connection Successful!");
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

3. Place the .java file in the same directory as the tdv.googlecloudstorage.jar file. This is required to prevent classpath resolution errors during compilation and execution

Build and run the Java Application

1. Open Console and navigate to the directory containing the .java file and adapter jar
2. Compile the Java file using the following command:

javac -cp .;tdv.googlecloudstorage.jar GenOAuthSettings.java

3. Execute the application using one of the following commands:

java -cp .;tdv.googlecloudstorage.jar GenOAuthSettings "GoogleCloudStorage" "connection string"

This command initiates the OAuth authentication flow and generates the OAuth settings file at the location specified in the OAuthSettingsLocation parameter. Once you deploy the adapter and authenticate, you can create a new data source for Google Cloud Storage in TDV Studio.

Create a Google Cloud Storage Data Source in TDV Studio

With the Google Cloud Storage Tibco DV Adapter, you can easily create a data source for Google Cloud Storage and introspect the data source to add resources to TDV.

Create the Data Source

1. Right-click on the folder you wish to add the data source to and select New -> New Data Source
2. Scroll until you find the adapter (e.g. Google Cloud Storage) and click Next
3. Name the data source (e.g. CData Google Cloud Storage Source)
4. Fill in the required connection properties

Authenticate with a User Account

You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect.

When you connect, the Google Cloud Storage OAuth endpoint opens in your default browser. Log in and grant permissions, then the OAuth process completes

Authenticate with a Service Account

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes.

You need to create an OAuth application in this flow. See the Help documentation for more information. After setting the following connection properties, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH.
• OAuthJWTCertType: Set this to "PFXFILE".
• OAuthJWTCert: Set this to the path to the .p12 file you generated.
• OAuthJWTCertPassword: Set this to the password of the .p12 file.
• OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
• OAuthJWTIssuer: In the service accounts section, click Manage Service Accounts and set this field to the email address displayed in the service account Id field.
• OAuthJWTSubject: Set this to your enterprise Id if your subject type is set to "enterprise" or your app user Id if your subject type is set to "user".
• ProjectId: Set this to the Id of the project you want to connect to.

The OAuth flow for a service account then completes.

NOTE: Ensure that the OAuthSettingsLocation property in the DV Adapter is set to the same file path used during the OAuth authentication process. Additionally, set the InitiateOAuth property to REFRESH so that the adapter can automatically handle OAuth access-token refreshes in the background without requiring any user action.

👁 Filling in Connection Information (Salesforce is shown.)

5. Click Create & Close.

Introspect the Data Source

Once the data source is created, you can introspect the data source by right-clicking and selecting Open. In the dashboard, click Add/Remove Resources and select the Tables, Views, and Stored Procedures to include as part of the data source. Click Next and Finish to add the selected Google Cloud Storage tables, views, and stored procedures as resources.

After creating and introspecting the data source, you are ready to work with Google Cloud Storage data in TIBCO Data Virtualization just like you would any other relational data source. You can create views, query using SQL, publish the data source, and more.