Class IntegrationConnectorReport

  • All Implemented Interfaces:
    java.io.Serializable

    public class IntegrationConnectorReport
    extends java.lang.Object
    implements java.io.Serializable
    IntegrationConnectorReport provides information on the operation of a single connector within an integration service.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Validate that an object is equal depending on their stored values.
      Connection getConnection()
      Return the connection used to create the instance of the connector.
      java.lang.String getConnectorId()
      Return the unique identifier of the connector - set up in the configuration.
      java.lang.String getConnectorInstanceId()
      Return the unique identifier of the connector instance.
      java.lang.String getConnectorName()
      Return the name of the connector.
      IntegrationConnectorStatus getConnectorStatus()
      Set up the status for the integration connector.
      java.lang.String getFailingExceptionMessage()
      Return the message extracted from an exception returned by the connector.
      java.util.Date getLastRefreshTime()
      Return the date/time when the connector was last refreshed.
      java.util.Date getLastStatusChange()
      Return the date/time when the status was last changed.
      long getMinMinutesBetweenRefresh()
      Return the configured minimum time between calls to refresh.
      java.util.Map<java.lang.String,​java.lang.Object> getStatistics()
      Return the statistics logged by the connector through the context.
      int hashCode()
      Return a hash code based on the values of this object.
      void setConnection​(Connection connection)
      Set up the connection object used to create the instance of the connector.
      void setConnectorId​(java.lang.String connectorId)
      Set up the unique identifier of the connector - set up in the configuration.
      void setConnectorInstanceId​(java.lang.String connectorInstanceId)
      Set up the unique identifier of the connector instance.
      void setConnectorName​(java.lang.String connectorName)
      Set up the name of the connector.
      void setConnectorStatus​(IntegrationConnectorStatus connectorStatus)
      Set up the status for the integration connector.
      void setFailingExceptionMessage​(java.lang.String failingExceptionMessage)
      Set up the message extracted from an exception returned by the connector.
      void setLastRefreshTime​(java.util.Date lastRefreshTime)
      Set up the date/time when the connector was last refreshed.
      void setLastStatusChange​(java.util.Date lastStatusChange)
      Set up the date/time when the status was last changed.
      void setMinMinutesBetweenRefresh​(long minMinutesBetweenRefresh)
      Set up the configured minimum time between calls to refresh.
      void setStatistics​(java.util.Map<java.lang.String,​java.lang.Object> statistics)
      Set up if the connector should be started in its own thread to allow it is block on a listening call.
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • IntegrationConnectorReport

        public IntegrationConnectorReport()
        Default constructor does nothing.
      • IntegrationConnectorReport

        public IntegrationConnectorReport​(IntegrationConnectorReport template)
        Copy/clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getConnectorId

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

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

        public java.lang.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​(java.lang.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 java.lang.String getConnectorInstanceId()
        Return the unique identifier of the connector instance.
        Returns:
        string guid
      • setConnectorInstanceId

        public void setConnectorInstanceId​(java.lang.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 java.util.Date getLastStatusChange()
        Return the date/time when the status was last changed.
        Returns:
        timestamp
      • setLastStatusChange

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

        public java.util.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​(java.util.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 java.lang.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​(java.lang.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 java.util.Map<java.lang.String,​java.lang.Object> getStatistics()
        Return the statistics logged by the connector through the context.
        Returns:
        name value pairs for the statistics
      • setStatistics

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

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

        public boolean equals​(java.lang.Object objectToCompare)
        Validate that an object is equal depending on their stored values.
        Overrides:
        equals in class java.lang.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 java.lang.Object
        Returns:
        in hash code