org.odpi.openmetadata.adapters.connectors.database.gaian

Class GaianOCFConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adapters.connectors.database.OCFDatabaseConnector

org.odpi.openmetadata.adapters.connectors.database.gaian.GaianOCFConnector

public class GaianOCFConnector
extends OCFDatabaseConnector

A GaianOCFConnector is a connector to Gaian. It will connect to Gaian, execute the query.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.connectors.database.OCFDatabaseConnector

create, dburlDatabase, dburlPrefix, dburlServeraddress, dburlServerport, proxyPwd, proxyUser, securedProperties, sqlConnection, sqlResults, sqlStatement, url

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId

Constructor Summary

Constructors

Constructor and Description
GaianOCFConnector() default constructor
GaianOCFConnector(String dburlPrefix, String dburlServeraddress, String dburlServerport, String dburlDatabase, String proxyUser, String proxyPwd, boolean create) all information about database url is offered for the constructor

Method Summary

Modifier and Type	Method and Description
Connection	connect(String userId) get connection to the database
void	disconnect() disconnect all the connections to the database
ResultSet	executeQuery(String query) execute the query to get data
void	setDBUrl(String userId) set up the database url

Methods inherited from class org.odpi.openmetadata.adapters.connectors.database.OCFDatabaseConnector

getDburlDatabase, getDburlPrefix, getDburlServeraddress, getDburlServerport, getProxyPwd, getProxyUser, getSqlConnection, getSqlResults, getSqlStatement, getUrl, isCreate, setCreate, setDburlDatabase, setDburlPrefix, setDburlServeraddress, setDburlServerport, setProxyPwd, setProxyUser, setSqlConnection, setSqlResults, setSqlStatement, setUrl

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, isActive, start, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GaianOCFConnector

public GaianOCFConnector()

default constructor

GaianOCFConnector

public GaianOCFConnector(String dburlPrefix,
                         String dburlServeraddress,
                         String dburlServerport,
                         String dburlDatabase,
                         String proxyUser,
                         String proxyPwd,
                         boolean create)

all information about database url is offered for the constructor

Parameters:

dburlPrefix - prefix in database url

dburlServeraddress - server address in database url

dburlServerport - database name in database url

dburlDatabase - database name in database url

proxyUser - proxy user in database url, it is for impersonation

proxyPwd - proxy user in database url, it is for impersonation

create - create true or not when connect to Gaian

Method Detail

setDBUrl

public void setDBUrl(String userId)
              throws ConnectionCheckedException

set up the database url

Parameters:

userId - end user id

Throws:

ConnectionCheckedException - properties is not set up correctly

connect

public Connection connect(String userId)
                   throws ConnectionCheckedException

get connection to the database

Specified by:

connect in class OCFDatabaseConnector

Parameters:

userId - the userId needed to connect to the database

Returns:

the connection to the database

Throws:

ConnectionCheckedException - if it is not able to connect to the database

executeQuery

public ResultSet executeQuery(String query)
                       throws ConnectorCheckedException

execute the query to get data

Specified by:

executeQuery in class OCFDatabaseConnector

Parameters:

query - the query

Returns:

return the data

Throws:

ConnectorCheckedException - if there are exceptions when execute the query

disconnect

public void disconnect()
                throws ConnectorCheckedException

disconnect all the connections to the database

Overrides:

disconnect in class ConnectorBase

Throws:

ConnectorCheckedException - if there are exceptions when execute the query