Package org.odpi.openmetadata.governanceservers.integrationdaemonservices.properties

Class IntegrationConnectorReport

java.lang.Object
org.odpi.openmetadata.governanceservers.integrationdaemonservices.properties.IntegrationConnectorReport
public class IntegrationConnectorReport extends Object
IntegrationConnectorReport provides information on the operation of a single connector within an integration service.

  • Constructor Details

    • IntegrationConnectorReport

      public IntegrationConnectorReport()
      Default constructor does nothing.

    • IntegrationConnectorReport

      public IntegrationConnectorReport(IntegrationConnectorReport template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getConnectorId

      public String getConnectorId()
      Return the unique identifier of the connector - set up in the configuration.
      Returns:
      string guid

    • setConnectorId

      public void setConnectorId(String connectorId)
      Set up the unique identifier of the connector - set up in the configuration.
      Parameters:
      connectorId - string guid

    • getConnectorGUID

      public String getConnectorGUID()
      Return the unique identifier of the connector entity - set up in the metadata store.
      Returns:
      string guid

    • setConnectorGUID

      public void setConnectorGUID(String connectorGUID)
      Set up the unique identifier of the connector entity - set up in the metadata store.
      Parameters:
      connectorGUID - string guid

    • getConnectorName

      public String getConnectorName()
      Return the name of the connector. This name is used for routing refresh calls to the connector as well as being used for diagnostics. Ideally it should be unique amongst the connectors for the integration service.
      Returns:
      String name

    • setConnectorName

      public void setConnectorName(String connectorName)
      Set up the name of the connector. This name is used for routing refresh calls to the connector as well as being used for diagnostics. Ideally it should be unique amongst the connectors for the integration service.
      Parameters:
      connectorName - String

    • getConnection

      public Connection getConnection()
      Return the connection used to create the instance of the connector.
      Returns:
      connection object

    • setConnection

      public void setConnection(Connection connection)
      Set up the connection object used to create the instance of the connector.
      Parameters:
      connection - connection object

    • getConnectorInstanceId

      public String getConnectorInstanceId()
      Return the unique identifier of the connector instance.
      Returns:
      string guid

    • setConnectorInstanceId

      public void setConnectorInstanceId(String connectorInstanceId)
      Set up the unique identifier of the connector instance.
      Parameters:
      connectorInstanceId - string guid

    • getConnectorStatus

      public IntegrationConnectorStatus getConnectorStatus()
      Set up the status for the integration connector.
      Returns:
      status object

    • setConnectorStatus

      public void setConnectorStatus(IntegrationConnectorStatus connectorStatus)
      Set up the status for the integration connector.
      Parameters:
      connectorStatus - status object

    • getLastStatusChange

      public Date getLastStatusChange()
      Return the date/time when the status was last changed.
      Returns:
      timestamp

    • setLastStatusChange

      public void setLastStatusChange(Date lastStatusChange)
      Set up the date/time when the status was last changed.
      Parameters:
      lastStatusChange - timestamp

    • getLastRefreshTime

      public Date getLastRefreshTime()
      Return the date/time when the connector was last refreshed. Null means it has never been refreshed.
      Returns:
      timestamp

    • setLastRefreshTime

      public void setLastRefreshTime(Date lastRefreshTime)
      Set up the date/time when the connector was last refreshed. Null means it has never been refreshed.
      Parameters:
      lastRefreshTime - timestamp

    • getMinMinutesBetweenRefresh

      public long getMinMinutesBetweenRefresh()
      Return the configured minimum time between calls to refresh. This gives an indication of when the next refresh is due. Null means refresh is only called at server start up and in response to an API request.
      Returns:
      count

    • setMinMinutesBetweenRefresh

      public void setMinMinutesBetweenRefresh(long minMinutesBetweenRefresh)
      Set up the configured minimum time between calls to refresh. This gives an indication of when the next refresh is due. Null means refresh is only called at server start up and in response to an API request.
      Parameters:
      minMinutesBetweenRefresh - count

    • getFailingExceptionMessage

      public String getFailingExceptionMessage()
      Return the message extracted from an exception returned by the connector. This is only set if the connectorStatus is FAILED. The full exception is logged in the server's audit log.
      Returns:
      string message

    • setFailingExceptionMessage

      public void setFailingExceptionMessage(String failingExceptionMessage)
      Set up the message extracted from an exception returned by the connector. This is only set if the connectorStatus is FAILED. The full exception is logged in the server's audit log.
      Parameters:
      failingExceptionMessage - string message

    • getStatistics

      public Map<String,Object> getStatistics()
      Return the statistics logged by the connector through the context.
      Returns:
      name value pairs for the statistics

    • setStatistics

      public void setStatistics(Map<String,Object> statistics)
      Set up if the connector should be started in its own thread to allow it to block on a listening call.
      Parameters:
      statistics - boolean flag

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      JSON style description of variables.

    • equals

      public boolean equals(Object objectToCompare)
      Validate that an object is equal depending on their stored values.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - object
      Returns:
      boolean result

    • hashCode

      public int hashCode()
      Return a hash code based on the values of this object.
      Overrides:
      hashCode in class Object
      Returns:
      in hash code