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

Interface SurveyActionAPI

All Known Implementing Classes:

SurveyActionClient

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
ConnectorReport	validateConnector(String userId, String connectorProviderClassName)	Validate the connector and return its connector type.

Method Details

validateConnector

ConnectorReport validateConnector(String userId,
 String connectorProviderClassName)
                           throws InvalidParameterException,
UserNotAuthorizedException,
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:

InvalidParameterException - the connector provider class name is not a valid connector fo this service

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - there was a problem detected by the integration service