Package org.odpi.openmetadata.integrationservices.catalog.connector

Class ConnectorFactoryService

java.lang.Object

org.odpi.openmetadata.integrationservices.catalog.connector.ConnectorFactoryService

public class ConnectorFactoryService
extends Object

ConnectorFactoryService is the service for creating connectors to the data and services of a digital resource (represented by an asset).

Method Summary

Modifier and Type	Method	Description
Connector	getConnectorByConnection(Connection connection)	Returns the connector corresponding to the supplied connection.
Connector	getConnectorByGUID(String connectionGUID)	Returns the connector corresponding to the supplied connection GUID.
Connector	getConnectorByName(String connectionName)	Returns the connector corresponding to the supplied connection name.
Connector	getConnectorForAsset(String assetGUID, AuditLog auditLog)	Returns the connector corresponding to the supplied asset GUID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getConnectorByName

public Connector getConnectorByName(String connectionName)
                             throws InvalidParameterException,
ConnectionCheckedException,
ConnectorCheckedException,
PropertyServerException,
UserNotAuthorizedException

Returns the connector corresponding to the supplied connection name.

Parameters:

connectionName - this may be the qualifiedName or displayName of the connection.

Returns:

connector instance - or null if there is no connection

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getConnectorForAsset

public Connector getConnectorForAsset(String assetGUID,
 AuditLog auditLog)
                               throws InvalidParameterException,
ConnectionCheckedException,
ConnectorCheckedException,
PropertyServerException,
UserNotAuthorizedException

Returns the connector corresponding to the supplied asset GUID.

Parameters:

assetGUID - the unique id for the asset within the metadata repository.

auditLog - optional logging destination

Returns:

connector instance - or null if there is no connection

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getConnectorByGUID

public Connector getConnectorByGUID(String connectionGUID)
                             throws InvalidParameterException,
ConnectionCheckedException,
ConnectorCheckedException,
PropertyServerException,
UserNotAuthorizedException

Returns the connector corresponding to the supplied connection GUID.

Parameters:

connectionGUID - the unique id for the connection within the metadata repository.

Returns:

connector instance - or null if there is no connection

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getConnectorByConnection

public Connector getConnectorByConnection(Connection connection)
                                   throws InvalidParameterException,
ConnectionCheckedException,
ConnectorCheckedException

Returns the connector corresponding to the supplied connection.

Parameters:

connection - the connection object that contains the properties needed to create the connection.

Returns:

connector instance

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.