Package org.odpi.openmetadata.frameworks.opensurvey

Class SurveyActionServiceProvider

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.ConnectorProvider

org.odpi.openmetadata.frameworks.connectors.ConnectorProviderBase

org.odpi.openmetadata.frameworks.connectors.OpenConnectorProviderBase

org.odpi.openmetadata.frameworks.opengovernance.GovernanceServiceProviderBase

org.odpi.openmetadata.frameworks.opensurvey.SurveyActionServiceProvider

All Implemented Interfaces:

AuditLoggingComponent

Direct Known Subclasses:

CocoClinicalTrialCertifyWeeklyMeasurementsProvider, CSVSurveyServiceProvider, DB2LUWDatabaseSurveyActionProvider, DB2LUWServerSurveyActionProvider, DuckDBDatabaseSurveyActionProvider, FileSurveyServiceProvider, FolderSurveyServiceProvider, MSSQLDatabaseSurveyActionProvider, MSSQLServerSurveyActionProvider, OracleDatabaseSurveyActionProvider, OracleServerSurveyActionProvider, OSSUnityCatalogInsideCatalogSurveyProvider, OSSUnityCatalogInsideSchemaSurveyProvider, OSSUnityCatalogInsideVolumeSurveyProvider, OSSUnityCatalogServerSurveyProvider, PostgresDatabaseSurveyActionProvider, PostgresServerSurveyActionProvider, SequentialSurveyPipelineProvider, SurveyApacheAtlasProvider, SurveyApacheKafkaServerProvider, SurveyWSO2MIServerProvider

public abstract class SurveyActionServiceProvider
extends GovernanceServiceProviderBase

SurveyActionServiceProvider implements the base class for the connector provider for a survey action service.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AnnotationTypeType>	producedAnnotationTypes
protected List<AnalysisStepType>	supportedAnalysisSteps

Fields inherited from class org.odpi.openmetadata.frameworks.opengovernance.GovernanceServiceProviderBase

producedActionTargetTypes, producedGuards, producedRequestParameters, supportedActionTargetTypes, supportedAssetTypeName, supportedDeployedImplementationType, supportedRequestParameters, supportedRequestTypes

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorProviderBase

auditLog, connectorClassName, connectorComponentDescription, connectorInterfaces, connectorTypeBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorProvider

supportedConfigurationProperties, supportedTechnologyTypes, supportedTemplateTypes

Constructor Summary

Constructors

Constructor	Description
SurveyActionServiceProvider()	Base provider for all survey action services.
SurveyActionServiceProvider(OpenConnectorDefinition openConnectorDescription, String connectorClassName, List<String> recognizedConfigurationPropertyNames)	Constructor for an open connector provider.

Method Summary

Modifier and Type	Method	Description
List<AnnotationTypeType>	getProducedAnnotationTypes()	Return the supported annotation types.
List<AnalysisStepType>	getSupportedAnalysisSteps()	Return the analysis steps that the service supports.
protected void	setFinalAnalysisSteps(AnalysisStep[] finalAnalysisSteps)	Declare the analysis steps that the survey action service can stop after, in the order it runs them.

Methods inherited from class org.odpi.openmetadata.frameworks.opengovernance.GovernanceServiceProviderBase

getProducedActionTargetTypes, getProducedGuards, getProducedRequestParameters, getSupportedActionTargetTypes, getSupportedRequestParameters, getSupportedRequestTypes

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorProviderBase

equals, getClassForConnector, getConnector, getConnectorClassName, getConnectorComponentDescription, getConnectorType, getNewConnectorGUID, hashCode, setAuditLog, setConnectorClassName, setConnectorComponentDescription, setConnectorTypeProperties, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorProvider

getSupportedConfigurationProperties, getSupportedTechnologyTypes, getSupportedTemplateTypes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

supportedAnalysisSteps

protected List<AnalysisStepType> supportedAnalysisSteps

producedAnnotationTypes

protected List<AnnotationTypeType> producedAnnotationTypes

Constructor Details

SurveyActionServiceProvider

public SurveyActionServiceProvider()

Base provider for all survey action services.

SurveyActionServiceProvider

public SurveyActionServiceProvider(OpenConnectorDefinition openConnectorDescription,
 String connectorClassName,
 List<String> recognizedConfigurationPropertyNames)

Constructor for an open connector provider.

Parameters:

openConnectorDescription - connector definition

connectorClassName - connector class name

recognizedConfigurationPropertyNames - list of recognized configuration property names

Method Details

setFinalAnalysisSteps

protected void setFinalAnalysisSteps(AnalysisStep[] finalAnalysisSteps)

Declare the analysis steps that the survey action service can stop after, in the order it runs them. They are advertised as the valid values of the finalAnalysisStep request parameter and configuration property, which this method adds to the provider's supported request parameters, supported configuration properties and recognized configuration properties. Call it at the end of the subclass's constructor, after those lists have been set up.

Parameters:

finalAnalysisSteps - analysis steps, in the order the service runs them

getSupportedAnalysisSteps

public List<AnalysisStepType> getSupportedAnalysisSteps()

Return the analysis steps that the service supports.

Returns:

list of analysis steps

getProducedAnnotationTypes

public List<AnnotationTypeType> getProducedAnnotationTypes()

Return the supported annotation types.

Returns:

list of annotation types