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
    org.odpi.openmetadata.frameworks.connectors.Connector
    getConnectorByConnection(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Returns the connector corresponding to the supplied connection.
    org.odpi.openmetadata.frameworks.connectors.Connector
    getConnectorByGUID(String connectionGUID)
    Returns the connector corresponding to the supplied connection GUID.
    org.odpi.openmetadata.frameworks.connectors.Connector
    getConnectorByName(String connectionName)
    Returns the connector corresponding to the supplied connection name.
    org.odpi.openmetadata.frameworks.connectors.Connector
    getConnectorForAsset(String assetGUID, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Returns the connector corresponding to the supplied asset GUID.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • getConnectorByName

      public org.odpi.openmetadata.frameworks.connectors.Connector getConnectorByName(String connectionName) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getConnectorForAsset

      public org.odpi.openmetadata.frameworks.connectors.Connector getConnectorForAsset(String assetGUID, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getConnectorByGUID

      public org.odpi.openmetadata.frameworks.connectors.Connector getConnectorByGUID(String connectionGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getConnectorByConnection

      public org.odpi.openmetadata.frameworks.connectors.Connector getConnectorByConnection(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.