Package org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.api

Interface ConnectorFactoryInterface

All Known Implementing Classes:

AssetCertificationManager, AssetConsumer, AssetLicenseManager, AssetOwner, AssetOwnerBaseClient, AvroFileAssetOwner, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClient, ConnectedAssetClientBase, CSVFileAssetOwner, ExternalReferenceManager, FileSystemAssetOwner, ValidValuesAssetOwner

public interface ConnectorFactoryInterface

ConnectorFactoryInterface is used by applications and tools as a factory for Open Connector Framework (OCF) connectors. The configuration for the connectors is managed as open metadata in a Connection definition. The caller to the interface passes either the name, GUID or URL for the connection to the appropriate method to retrieve a connector. The service retrieves the connection from the metadata repository and creates an appropriate connector as described the connection and returns it to the caller.

Method Summary

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

Method Details

getConnectorByName

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

Returns the connector corresponding to the supplied connection name.

Parameters:

userId - userId of user making request.

connectionName - this may be the qualifiedName or displayName of 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.

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

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

getConnectorByGUID

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

Returns the connector corresponding to the supplied connection GUID.

Parameters:

userId - userId of user making request.

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

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.

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

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

getConnectorForAsset

Connector getConnectorForAsset(String userId,
 String assetGUID)
                        throws InvalidParameterException,
ConnectionCheckedException,
ConnectorCheckedException,
PropertyServerException,
UserNotAuthorizedException

Returns the connector corresponding to the supplied asset GUID.

Parameters:

userId - userId of user making request.

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

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.

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

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

getConnectorForAsset

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

Returns the connector corresponding to the supplied asset GUID.

Parameters:

userId - userId of user making request.

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

auditLog - logging destination

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.

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

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

getConnectorByConnection

Connector getConnectorByConnection(String userId,
 Connection connection)
                            throws InvalidParameterException,
ConnectionCheckedException,
ConnectorCheckedException,
PropertyServerException

Returns the connector corresponding to the supplied connection.

Parameters:

userId - userId of user making request.

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.

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