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

Class ConnectorReport

  • All Implemented Interfaces:
    Serializable
    public class ConnectorReport
extends Object
implements Serializable
    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.
    See Also:
    Serialized Form

    • Constructor Detail

      • ConnectorReport

        public ConnectorReport()
        Default constructor

      • ConnectorReport

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

      • ConnectorReport

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

    • Method Detail

      • 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 is 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 is block on a listening call.
        Parameters:
        usesBlockingCalls - boolean flag

      • getSupportedRequestTypes

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

      • setSupportedRequestTypes

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

      • getSupportedRequestParameters

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

      • setSupportedRequestParameters

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

      • getSupportedRequestSourceNames

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

      • setSupportedRequestSourceNames

        public void setSupportedRequestSourceNames​(List<String> supportedRequestSourceNames)
        Set up the request source names.
        Parameters:
        supportedRequestSourceNames - list of request source names with special meaning

      • getSupportedActionTargetNames

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

      • setSupportedActionTargetNames

        public void setSupportedActionTargetNames​(List<String> supportedActionTargetNames)
        Set up the supported action target names
        Parameters:
        supportedActionTargetNames - list of action target names with special meaning

      • getSupportedGuards

        public List<String> getSupportedGuards()
        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

      • setSupportedGuards

        public void setSupportedGuards​(List<String> supportedGuards)
        Set up the supported guards
        Parameters:
        supportedGuards - list of guards produced by this service

      • 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