org.odpi.openmetadata.adapters.connectors.database

Class OCFDatabaseConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

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

Direct Known Subclasses:

GaianOCFConnector

public abstract class OCFDatabaseConnector
extends ConnectorBase

The OCFDatabaseConnector provides common services for OCF Database Connector implementations.

Nested Class Summary

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

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	create
protected String	dburlDatabase
protected String	dburlPrefix
protected String	dburlServeraddress
protected String	dburlServerport
protected String	proxyPwd
protected String	proxyUser
protected AdditionalProperties	securedProperties
protected Connection	sqlConnection
protected ResultSet	sqlResults
protected Statement	sqlStatement
protected String	url

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

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, isActive

Constructor Summary

Constructors

Constructor and Description
OCFDatabaseConnector() default constructor
OCFDatabaseConnector(String dburlPrefix, String dburlServeraddress, String dburlServerport, String dburlDatabase, String proxyUser, String proxyPwd, boolean create) constructor with database url settings

Method Summary

Modifier and Type	Method and Description
abstract Connection	connect(String userId) create the connection to the database
abstract ResultSet	executeQuery(String query) execute the query to get data
String	getDburlDatabase()
String	getDburlPrefix()
String	getDburlServeraddress()
String	getDburlServerport()
String	getProxyPwd()
String	getProxyUser()
Connection	getSqlConnection()
ResultSet	getSqlResults()
Statement	getSqlStatement()
String	getUrl()
boolean	isCreate()
void	setCreate(boolean create)
void	setDburlDatabase(String dburlDatabase)
void	setDburlPrefix(String dburlPrefix)
void	setDburlServeraddress(String dburlServeraddress)
void	setDburlServerport(String dburlServerport)
void	setProxyPwd(String proxyPwd)
void	setProxyUser(String proxyUser)
void	setSqlConnection(Connection sqlConnection)
void	setSqlResults(ResultSet sqlResults)
void	setSqlStatement(Statement sqlStatement)
void	setUrl(String url)

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

disconnect, 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

Field Detail

securedProperties

protected AdditionalProperties securedProperties

url

protected String url

sqlResults

protected ResultSet sqlResults

sqlStatement

protected Statement sqlStatement

sqlConnection

protected Connection sqlConnection

dburlPrefix

protected String dburlPrefix

dburlServeraddress

protected String dburlServeraddress

dburlServerport

protected String dburlServerport

dburlDatabase

protected String dburlDatabase

proxyUser

protected String proxyUser

proxyPwd

protected String proxyPwd

create

protected boolean create

Constructor Detail

OCFDatabaseConnector

public OCFDatabaseConnector()

default constructor

OCFDatabaseConnector

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

constructor with database url settings

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

getDburlPrefix

public String getDburlPrefix()

setDburlPrefix

public void setDburlPrefix(String dburlPrefix)

getDburlServeraddress

public String getDburlServeraddress()

setDburlServeraddress

public void setDburlServeraddress(String dburlServeraddress)

getDburlServerport

public String getDburlServerport()

setDburlServerport

public void setDburlServerport(String dburlServerport)

getDburlDatabase

public String getDburlDatabase()

setDburlDatabase

public void setDburlDatabase(String dburlDatabase)

getProxyUser

public String getProxyUser()

setProxyUser

public void setProxyUser(String proxyUser)

getProxyPwd

public String getProxyPwd()

setProxyPwd

public void setProxyPwd(String proxyPwd)

isCreate

public boolean isCreate()

setCreate

public void setCreate(boolean create)

connect

public abstract Connection connect(String userId)
                            throws ConnectionCheckedException

create the connection to the database

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 the database

executeQuery

public abstract ResultSet executeQuery(String query)
                                throws ConnectorCheckedException

execute the query to get data

Parameters:

query - the query

Returns:

return the data

Throws:

ConnectorCheckedException - if there are exceptions when execute the query

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getSqlConnection

public Connection getSqlConnection()

setSqlConnection

public void setSqlConnection(Connection sqlConnection)

getSqlResults

public ResultSet getSqlResults()

setSqlResults

public void setSqlResults(ResultSet sqlResults)

getSqlStatement

public Statement getSqlStatement()

setSqlStatement

public void setSqlStatement(Statement sqlStatement)