Package org.odpi.openmetadata.adapters.connectors.reports.surveyreport

Class SurveyReportService

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.opengovernance.GovernanceActionServiceConnector

org.odpi.openmetadata.frameworks.opengovernance.GeneralGovernanceActionService

org.odpi.openmetadata.adapters.connectors.reports.surveyreport.SurveyReportService

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, GovernanceActionService

public class SurveyReportService
extends GeneralGovernanceActionService

SurveyReportService extracts the requested survey report and turns it into a Markdown document.

Nested Class Summary

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

ConnectorBase.ProtectedConnection

Field Summary

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

governanceContext

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

auditLog, governanceServiceName

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

connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
SurveyReportService()	Default Constructor

Method Summary

Modifier and Type	Method	Description
String	getAnnotationTitle(OpenMetadataElement annotationElement)	Return the title to use on an annotation section of the report.
String	getAnnotationURL(OpenMetadataElement annotationElement)	Return the URL to use to link to an annotation section of the report.
void	start()	Indicates that the survey action service is completely configured and can begin processing.

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

disconnect, getProperty, setGovernanceContext

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

getArrayRequestParameter, getBooleanRequestParameter, getConnectorComponentDescription, getIntRequestParameter, getLongRequestParameter, getStringRequestParameter, handleUnexpectedException, setAuditLog, setGovernanceServiceName, validateContext

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

SurveyReportService

public SurveyReportService()

Default Constructor

Method Details

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

Indicates that the survey action service is completely configured and can begin processing.

Overrides:

start in class GeneralGovernanceActionService

Throws:

ConnectorCheckedException - there is a problem within the discovery service.

UserNotAuthorizedException - connector disconnected

getAnnotationTitle

public String getAnnotationTitle(OpenMetadataElement annotationElement)

Return the title to use on an annotation section of the report.

Parameters:

annotationElement - element describing the annotation

Returns:

title string

getAnnotationURL

public String getAnnotationURL(OpenMetadataElement annotationElement)

Return the URL to use to link to an annotation section of the report.

Parameters:

annotationElement - element describing the annotation

Returns:

title string