Package org.odpi.openmetadata.commonservices.ffdc.properties

Class ConnectorReport

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.properties.ConnectorReport
public class ConnectorReport extends Object
ConnectorReport is a collection of information provided by a connector provider that describes the operation of a connector. It is designed to aid an administrator setting up the configuration for a connector.

  • Constructor Details

    • ConnectorReport

      public ConnectorReport()
      Default constructor

    • ConnectorReport

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

  • Method Details

    • getComponentDescription

      public ComponentDescription getComponentDescription()
      Return the component description information that the connector uses to register with the audit log.
      Returns:
      component description structure

    • setComponentDescription

      public void setComponentDescription(ComponentDescription componentDescription)
      Set up the component description information that the connector uses to register with the audit log.
      Parameters:
      componentDescription - component description structure

    • getConnectorType

      public ConnectorType getConnectorType()
      Return the ConnectorType object.
      Returns:
      connectorType

    • setConnectorType

      public void setConnectorType(ConnectorType connectorType)
      Set up the ConnectorType object.
      Parameters:
      connectorType - - connectorType object

    • getRefreshTimeInterval

      public long getRefreshTimeInterval()
      Return the recommended number of minutes between each call to the connector to refresh the metadata. Zero means that refresh is only called at server start up and whenever the refresh REST API request is made to the integration daemon. If the refresh time interval is greater than 0 then additional calls to refresh are added spaced out by the refresh time interval.
      Returns:
      minute count

    • setRefreshTimeInterval

      public void setRefreshTimeInterval(long refreshTimeInterval)
      Set up the recommended number of minutes between each call to the connector to refresh the metadata. Zero means that refresh is only called at server start up and whenever the refresh REST API request is made to the integration daemon. If the refresh time interval is greater than 0 then additional calls to refresh are added spaced out by the refresh time interval.
      Parameters:
      refreshTimeInterval - minute count

    • getUsesBlockingCalls

      public boolean getUsesBlockingCalls()
      Return if the connector should be started in its own thread to allow it to block on a listening call.
      Returns:
      boolean flag

    • setUsesBlockingCalls

      public void setUsesBlockingCalls(boolean usesBlockingCalls)
      Set up if the connector should be started in its own thread to allow it to block on a listening call.
      Parameters:
      usesBlockingCalls - boolean flag

    • getSupportedConfigurationProperties

      public List<ConfigurationPropertyType> getSupportedConfigurationProperties()
      Return the list of supported configuration property types that describe how the connector's behaviour can be modified.
      Returns:
      list of configuration property types

    • setSupportedConfigurationProperties

      public void setSupportedConfigurationProperties(List<ConfigurationPropertyType> supportedConfigurationProperties)
      Set up the list of supported configuration property types that describe how the connector's behaviour can be modified.
      Parameters:
      supportedConfigurationProperties - list of configuration property types

    • getSupportedRequestTypes

      public List<RequestTypeType> getSupportedRequestTypes()
      The request types returned are those that affect the governance service's behaviour. Other request types may be used to call the governance service, but they result in default behaviour.
      Returns:
      list of request types with special meaning

    • setSupportedRequestTypes

      public void setSupportedRequestTypes(List<RequestTypeType> supportedRequestTypes)
      Set up the supported request types.
      Parameters:
      supportedRequestTypes - list of request types with special meaning

    • getSupportedRequestParameters

      public List<RequestParameterType> getSupportedRequestParameters()
      The request parameters returned are used by the governance service to control its behaviour.
      Returns:
      list of parameter names with special meaning

    • setSupportedRequestParameters

      public void setSupportedRequestParameters(List<RequestParameterType> supportedRequestParameters)
      Set up request parameters returned are used by the governance service to control its behaviour.
      Parameters:
      supportedRequestParameters - list of parameter names with special meaning

    • getSupportedActionTargetTypes

      public List<ActionTargetType> getSupportedActionTargetTypes()
      The action target names returned are those that affect the governance service's behaviour. Other action target names may be used in a call the governance service, but they result in default behaviour.
      Returns:
      list of action target names with special meaning

    • setSupportedActionTargetTypes

      public void setSupportedActionTargetTypes(List<ActionTargetType> supportedActionTargetTypes)
      Set up the supported action target names
      Parameters:
      supportedActionTargetTypes - list of action target names with special meaning

    • getSupportedAnalysisSteps

      public List<AnalysisStepType> getSupportedAnalysisSteps()
      Return the list of analysis steps (survey action service only).
      Returns:
      list

    • setSupportedAnalysisSteps

      public void setSupportedAnalysisSteps(List<AnalysisStepType> supportedAnalysisSteps)
      Set up the list of analysis steps (survey action service only).
      Parameters:
      supportedAnalysisSteps - list

    • getSupportedAnnotationTypes

      public List<AnnotationTypeType> getSupportedAnnotationTypes()
      Return the list of annotation types (survey action service only).
      Returns:
      list

    • setSupportedAnnotationTypes

      public void setSupportedAnnotationTypes(List<AnnotationTypeType> supportedAnnotationTypes)
      Set up the list of annotation types (survey action service only).
      Parameters:
      supportedAnnotationTypes - list

    • getProducedRequestParameters

      public List<RequestParameterType> getProducedRequestParameters()
      The request parameters returned are produced by the governance service.
      Returns:
      list of parameter names with special meaning

    • setProducedRequestParameters

      public void setProducedRequestParameters(List<RequestParameterType> producedRequestParameters)
      Set up request parameters returned are returned by the governance service.
      Parameters:
      producedRequestParameters - list of parameter names with special meaning

    • getProducedActionTargetTypes

      public List<ActionTargetType> getProducedActionTargetTypes()
      The action target names returned are those produced by the governance service.
      Returns:
      list of action target names with special meaning

    • setProducedActionTargetTypes

      public void setProducedActionTargetTypes(List<ActionTargetType> producedActionTargetTypes)
      Set up the produced action target names
      Parameters:
      producedActionTargetTypes - list of action target names with special meaning

    • getProducedGuards

      public List<GuardType> getProducedGuards()
      The guards describe the output assessment from the governance action service. The list returned is the complete list of guards to expect from the governance action service. They are used when defining governance action processes that choreograph the execution of governance action services using the guards to determine the path in the process to take.
      Returns:
      list of guards produced by this service with descriptions

    • setProducedGuards

      public void setProducedGuards(List<GuardType> producedGuards)
      Set up the supported guards
      Parameters:
      producedGuards - list of guards produced by this service with descriptions

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Object
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int hash code