Package org.odpi.openmetadata.engineservices.surveyaction.api

Interface SurveyActionAPI

public interface SurveyActionAPI
SurveyActionAPI is the interface to validate that a connector is suitable to run in the Survey Action OMES. It validates that it implements the correct interfaces and returns the connector type for the connector.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.properties.ConnectorReport
    validateConnector(String userId, String connectorProviderClassName)
    Validate the connector and return its connector type.

  • Method Details

    • validateConnector

      org.odpi.openmetadata.commonservices.ffdc.properties.ConnectorReport validateConnector(String userId, String connectorProviderClassName) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Validate the connector and return its connector type.
      Parameters:
      userId - calling user
      connectorProviderClassName - name of a specific connector or null for all connectors
      Returns:
      connector report for this connector
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the connector provider class name is not a valid connector fo this service
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there was a problem detected by the integration service