Package org.odpi.openmetadata.frameworks.connectors

Class ConnectorBroker

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.ConnectorBroker
public class ConnectorBroker extends Object
The ConnectorBroker is a generic factory for Open Connector Framework (OCF) Connectors. The OCF provides a default implementation because all the implementation that is specific to a particular type of connector is delegated to the connector provider specified in the connection.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConnectorBroker()
    Typical constructor
    ConnectorBroker(org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Constructor to supply the audit log to all connectors that implement the AuditLoggingConnector interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object object)
    Provide a common implementation of equals for all OCF Connector Broker objects.
    Connector
    getConnector(Connection connection)
    Creates a new instance of a connector using the name of the connector provider in the supplied connection.
    Connector
    getConnector(ConnectionProperties connection)
    Creates a new instance of a connector using the name of the connector provider in the supplied connection.
    int
    hashCode()
    Provide an implementation of hashCode for all OCF Connector Broker objects.
    String
    toString()
    Standard toString method.
    void
    validateConnection(Connection connection)
    Validate that the connection has sufficient properties to attempt to create a connector.
    void
    validateConnection(ConnectionProperties connection)
    Validate that the connection has sufficient properties to attempt to create a connector.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ConnectorBroker

      public ConnectorBroker()
      Typical constructor

    • ConnectorBroker

      public ConnectorBroker(org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
      Constructor to supply the audit log to all connectors that implement the AuditLoggingConnector interface.
      Parameters:
      auditLog - audit log to pass on to the connector providers

  • Method Details

    • validateConnection

      public void validateConnection(Connection connection) throws ConnectionCheckedException
      Validate that the connection has sufficient properties to attempt to create a connector. Any problems found are expressed as a ConnectionCheckedException.
      Parameters:
      connection - connection properties
      Throws:
      ConnectionCheckedException - an error with the connection.

    • validateConnection

      public void validateConnection(ConnectionProperties connection) throws ConnectionCheckedException
      Validate that the connection has sufficient properties to attempt to create a connector. Any problems found are expressed as a ConnectionCheckedException.
      Parameters:
      connection - connection properties
      Throws:
      ConnectionCheckedException - an error with the connection.

    • getConnector

      public Connector getConnector(Connection connection) throws ConnectionCheckedException, ConnectorCheckedException
      Creates a new instance of a connector using the name of the connector provider in the supplied connection.
      Parameters:
      connection - properties for the connector and connector provider.
      Returns:
      new connector instance.
      Throws:
      ConnectionCheckedException - an error with the connection.
      ConnectorCheckedException - an error initializing the connector.

    • getConnector

      public Connector getConnector(ConnectionProperties connection) throws ConnectionCheckedException, ConnectorCheckedException
      Creates a new instance of a connector using the name of the connector provider in the supplied connection.
      Parameters:
      connection - properties for the connector and connector provider.
      Returns:
      new connector instance.
      Throws:
      ConnectionCheckedException - an error with the connection.
      ConnectorCheckedException - an error initializing the connector.

    • hashCode

      public int hashCode()
      Provide an implementation of hashCode for all OCF Connector Broker objects. The UUID is unique and is randomly assigned and so its hashCode is as good as anything to describe the hash code of the connector broker object.
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Provide a common implementation of equals for all OCF Connector Broker objects. The UUID is unique and is randomly assigned and so its hashCode is as good as anything to evaluate the equality of the connector broker object.
      Overrides:
      equals in class Object
      Parameters:
      object - object to test
      Returns:
      boolean flag

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style