Package org.odpi.openmetadata.frameworks.surveyaction

Class SurveyActionServiceConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.surveyaction.SurveyActionServiceConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, SurveyActionService

Direct Known Subclasses:

CocoClinicalTrialCertifyWeeklyMeasurementsService, CSVSurveyService, FileSurveyService, FolderSurveyService, OSSUnityCatalogServerSurveyBase, PostgresDatabaseSurveyActionService, PostgresServerSurveyActionService, SurveyActionPipelineConnector, SurveyApacheAtlasConnector, SurveyApacheKafkaServerConnector

public abstract class SurveyActionServiceConnector
extends ConnectorBase
implements SurveyActionService, AuditLoggingComponent

SurveyActionServiceConnector describes a specific type of connector that is responsible for analyzing the content of a specific asset. Information about the asset to analyze is passed in the survey context. The returned discovery context also contains the results. Some discovery services manage the invocation of other discovery services. These discovery services are called discovery pipelines.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditLog	auditLog
protected Connector	connector
protected List<Connector>	embeddedConnectors
protected static com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected final PropertyHelper	propertyHelper
protected String	surveyActionServiceName
protected SurveyContext	surveyContext

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

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
SurveyActionServiceConnector()

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Free up any resources held since the connector is no longer needed.
protected AnnotationStore	getAnnotationStore()
ComponentDescription	getConnectorComponentDescription()	Return the component description that is used by this connector in the audit log.
protected List<SurveyActionServiceConnector>	getEmbeddedSurveyActionServices()	Retrieve and validate the list of embedded connectors and cast them to survey action service connector.
String	getJSONProperties(Object properties)	Convert the supplied properties object to a JSON String.
protected NestedSchemaType	getNestedSchemaType(AssetUniverse assetUniverse, String schemaTypeName)	Return the nested schema type associated with the asset
protected SurveyContext	getSurveyContext()	Return the survey context for this survey action service.
protected void	handleUnexpectedException(String methodName, Exception error)	Provide a common exception for unexpected errors.
protected <T> Connector	performCheckAssetAnalysisStep(Class<T> expectedConnectorClass, String expectedAssetType)	This is the typical first analysis step of a survey action service.
protected void	performCheckAssetAnalysisStep(String expectedAssetType)	This is the typical first analysis step of a survey action service.
void	setAuditLog(AuditLog auditLog)	Receive an audit log object that can be used to record audit log messages.
void	setSurveyActionServiceName(String surveyActionServiceName)	Set up the survey action service name.
void	setSurveyContext(SurveyContext surveyContext)	Set up details of the asset to analyze and the results of any previous analysis.
protected void	setUpAnnotation(Annotation annotation, AnnotationType annotationType)	Transfer common properties into an annotation.
void	start()	Indicates that the survey action service is completely configured and can begin processing.
protected void	throwMissingSchemaType(String assetGUID)	Record that an asset does not have a schema.
protected ResourceProfileLogAnnotation	writeNameCountInventory(AnnotationType annotationType, String inventoryName, Map<String,Integer> nameCounts, String surveyReportGUID)	Create an inventory in a CSV File.
protected ResourceProfileLogAnnotation	writeNameDescriptionInventory(AnnotationType annotationType, String inventoryName, Map<String,String> nameDescriptions, String surveyReportGUID)	Create an inventory in a CSV File.
protected ResourceProfileLogAnnotation	writeNameListInventory(AnnotationType annotationType, String inventoryName, List<String> names, String surveyReportGUID)	Create an inventory in a CSV File.
protected ResourceProfileLogAnnotation	writePropertyListInventory(AnnotationType annotationType, String inventoryName, List<String> propertyNames, List<Map<String,String>> propertyList, String surveyReportGUID)	Create an inventory in a CSV File.

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

combineConfigurationProperties, disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

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

clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, setStatisticProperty, setStatisticTimestamp

Methods inherited from class java.lang.Object

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

Field Details

propertyHelper

protected final PropertyHelper propertyHelper

connector

protected Connector connector

objectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper objectMapper

surveyActionServiceName

protected String surveyActionServiceName

surveyContext

protected SurveyContext surveyContext

auditLog

protected AuditLog auditLog

embeddedConnectors

protected List<Connector> embeddedConnectors

Constructor Details

SurveyActionServiceConnector

public SurveyActionServiceConnector()

Method Details

setAuditLog

public void setAuditLog(AuditLog auditLog)

Receive an audit log object that can be used to record audit log messages. The caller has initialized it with the correct component description and log destinations.

Specified by:

setAuditLog in interface AuditLoggingComponent

Parameters:

auditLog - audit log object

getConnectorComponentDescription

public ComponentDescription getConnectorComponentDescription()

Return the component description that is used by this connector in the audit log.

Specified by:

getConnectorComponentDescription in interface AuditLoggingComponent

Returns:

id, name, description, wiki page URL.

getJSONProperties

public String getJSONProperties(Object properties)
                         throws PropertyServerException

Convert the supplied properties object to a JSON String.

Parameters:

properties - properties object

Returns:

properties as a JSON String

Throws:

PropertyServerException - parsing error

setSurveyContext

public void setSurveyContext(SurveyContext surveyContext)

Set up details of the asset to analyze and the results of any previous analysis.

Parameters:

surveyContext - information about the asset to analyze and the results of analysis of other survey action service request. Partial results from other survey action services run as part of the same survey action service request may also be stored in the newAnnotations list.

setSurveyActionServiceName

public void setSurveyActionServiceName(String surveyActionServiceName)

Set up the survey action service name. This is used in error messages.

Parameters:

surveyActionServiceName - name of the survey action service

performCheckAssetAnalysisStep

protected <T> Connector performCheckAssetAnalysisStep(Class<T> expectedConnectorClass,
 String expectedAssetType)
                                               throws ConnectorCheckedException,
InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
ConnectionCheckedException

This is the typical first analysis step of a survey action service.

Type Parameters:

T - type of connector

Parameters:

expectedConnectorClass - the class of the desired connector

expectedAssetType - the type of asset that this survey service works on

Returns:

the started connector which is of the correct type

Throws:

ConnectorCheckedException - problem with the connector

InvalidParameterException - invalid property

PropertyServerException - problem with repositories

UserNotAuthorizedException - security problem

ConnectionCheckedException - problem with connection

performCheckAssetAnalysisStep

protected void performCheckAssetAnalysisStep(String expectedAssetType)
                                      throws ConnectorCheckedException,
InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

This is the typical first analysis step of a survey action service. It is used by survey action services that do not use the asset connector.

Parameters:

expectedAssetType - the type of asset that this survey service works on

Throws:

ConnectorCheckedException - problem with the connector

InvalidParameterException - invalid property

PropertyServerException - problem with repositories

UserNotAuthorizedException - security problem

getNestedSchemaType

protected NestedSchemaType getNestedSchemaType(AssetUniverse assetUniverse,
 String schemaTypeName)
                                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
ConnectorCheckedException

Return the nested schema type associated with the asset

Parameters:

assetUniverse - details of asset

schemaTypeName - name of type for schema

Returns:

nested schema type or null

Throws:

ConnectorCheckedException - problem with the connector

InvalidParameterException - invalid property

PropertyServerException - problem with repositories

UserNotAuthorizedException - security problem

throwMissingSchemaType

protected void throwMissingSchemaType(String assetGUID)
                               throws ConnectorCheckedException,
InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Record that an asset does not have a schema.

Parameters:

assetGUID - unique identifier of the asset

Throws:

ConnectorCheckedException - problem with the connector

InvalidParameterException - invalid property

PropertyServerException - problem with repositories

UserNotAuthorizedException - security problem

getSurveyContext

protected SurveyContext getSurveyContext()
                                  throws ConnectorCheckedException

Return the survey context for this survey action service. This is typically called after the disconnect() method is called. If called before disconnect(), it may only contain partial results.

Returns:

survey context containing the results discovered (so far) by the survey action service.

Throws:

ConnectorCheckedException - the service is no longer active

getAnnotationStore

protected AnnotationStore getAnnotationStore()
                                      throws ConnectorCheckedException

Throws:

ConnectorCheckedException

setUpAnnotation

protected void setUpAnnotation(Annotation annotation,
 AnnotationType annotationType)

Transfer common properties into an annotation.

Parameters:

annotation - output annotation

annotationType - annotation type definition

writePropertyListInventory

protected ResourceProfileLogAnnotation writePropertyListInventory(AnnotationType annotationType,
 String inventoryName,
 List<String> propertyNames,
 List<Map<String,String>> propertyList,
 String surveyReportGUID)
                                                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
IOException,
ConnectorCheckedException

Create an inventory in a CSV File.

Parameters:

annotationType - details about the annotation

inventoryName - name of the inventory (needs to be unique within the report

propertyNames - list of properties names in order they should appear in the file

propertyList - list of property maps

surveyReportGUID - unique identifier of the report to connect the log file to

Returns:

inventory annotation

Throws:

IOException - problem writing file

InvalidParameterException - problem creating CSV file asset

PropertyServerException - repository problem creating CSV file asset

UserNotAuthorizedException - authorization problem creating CSV file asset

ConnectorCheckedException - survey has been asked to stop

writeNameListInventory

protected ResourceProfileLogAnnotation writeNameListInventory(AnnotationType annotationType,
 String inventoryName,
 List<String> names,
 String surveyReportGUID)
                                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
IOException,
ConnectorCheckedException

Create an inventory in a CSV File.

Parameters:

annotationType - details about the annotation

inventoryName - name of the inventory (needs to be unique within the report

names - list of names

surveyReportGUID - unique identifier of the report to connect the log file to

Returns:

inventory annotation

Throws:

IOException - problem writing file

InvalidParameterException - problem creating CSV file asset

PropertyServerException - repository problem creating CSV file asset

UserNotAuthorizedException - authorization problem creating CSV file asset

ConnectorCheckedException - survey has been asked to stop

writeNameCountInventory

protected ResourceProfileLogAnnotation writeNameCountInventory(AnnotationType annotationType,
 String inventoryName,
 Map<String,Integer> nameCounts,
 String surveyReportGUID)
                                                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
IOException,
ConnectorCheckedException

Create an inventory in a CSV File.

Parameters:

annotationType - details about the annotation

inventoryName - name of the inventory (needs to be unique within the report

nameCounts - map of names and how many times they appear

surveyReportGUID - unique identifier of the report to connect the log file to

Returns:

inventory annotation

Throws:

IOException - problem writing file

InvalidParameterException - problem creating CSV file asset

PropertyServerException - repository problem creating CSV file asset

UserNotAuthorizedException - authorization problem creating CSV file asset

ConnectorCheckedException - survey has been asked to stop

writeNameDescriptionInventory

protected ResourceProfileLogAnnotation writeNameDescriptionInventory(AnnotationType annotationType,
 String inventoryName,
 Map<String,String> nameDescriptions,
 String surveyReportGUID)
                                                              throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
IOException,
ConnectorCheckedException

Create an inventory in a CSV File.

Parameters:

annotationType - details about the annotation

inventoryName - name of the inventory (needs to be unique within the report

nameDescriptions - map of names and how many times they appear

surveyReportGUID - unique identifier of the report to connect the log file to

Returns:

inventory annotation

Throws:

IOException - problem writing file

InvalidParameterException - problem creating CSV file asset

PropertyServerException - repository problem creating CSV file asset

UserNotAuthorizedException - authorization problem creating CSV file asset

ConnectorCheckedException - survey has been asked to stop

getEmbeddedSurveyActionServices

protected List<SurveyActionServiceConnector> getEmbeddedSurveyActionServices()
                                                                      throws ConnectorCheckedException

Retrieve and validate the list of embedded connectors and cast them to survey action service connector. This is used by SurveyPipelines and SurveyScanningServices.

Returns:

list of survey action service connectors

Throws:

ConnectorCheckedException - one of the embedded connectors is not a survey action service

start

public void start()
           throws ConnectorCheckedException

Indicates that the survey action service is completely configured and can begin processing. This is where the function of the survey action service is implemented. This is a standard method from the Open Connector Framework (OCF) so be sure to call super.start() in your version.

Overrides:

start in class ConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the survey action service.

handleUnexpectedException

protected void handleUnexpectedException(String methodName,
 Exception error)
                                  throws ConnectorCheckedException

Provide a common exception for unexpected errors.

Parameters:

methodName - calling method

error - caught exception

Throws:

ConnectorCheckedException - wrapped exception

disconnect

public void disconnect()
                throws ConnectorCheckedException

Free up any resources held since the connector is no longer needed.

Overrides:

disconnect in class ConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the connector.