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

Interface ConnectorFactoryInterface

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

  • Method Details

    • getConnectorByName

      org.odpi.openmetadata.frameworks.connectors.Connector getConnectorByName(String userId, String connectionName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.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.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getConnectorByGUID

      org.odpi.openmetadata.frameworks.connectors.Connector getConnectorByGUID(String userId, String connectionGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.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.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getConnectorForAsset

      org.odpi.openmetadata.frameworks.connectors.Connector getConnectorForAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.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.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getConnectorForAsset

      org.odpi.openmetadata.frameworks.connectors.Connector getConnectorForAsset(String userId, String assetGUID, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.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.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getConnectorByConnection

      org.odpi.openmetadata.frameworks.connectors.Connector getConnectorByConnection(String userId, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.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.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).