Package org.odpi.openmetadata.adapters.connectors.surveyaction.surveyfolder

Class FolderSurveyService

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.opensurvey.SurveyActionServiceConnector

org.odpi.openmetadata.adapters.connectors.surveyaction.surveyfolder.FolderSurveyService

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, SurveyActionService

public class FolderSurveyService
extends SurveyActionServiceConnector

FolderSurveyService is a survey action service implementation for analysing the files nested in a folder. The depth of the survey is controlled by the analysisLevel request parameter.

• The default value is 'TOP_LEVEL_ONLY' which produces summary statistics for the top-level directory only.
• If it is set to 'ALL_FOLDERS' then there are statistics created for the top level directory, and all subdirectories.
• If it set to 'TOP_LEVEL_AND_FILES' then statistics are created for the top-level directory and all files that are encountered.
• Finally, if it is set to 'ALL_FOLDERS_AND_FILES' then statistics are created for all directories and files encountered.", "string", "myFile.csv".

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.opensurvey.SurveyActionServiceConnector

auditLog, connector, embeddedConnectors, objectMapper, propertyHelper, surveyActionServiceName, surveyContext

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

connectionBean, connectorInstanceId, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
FolderSurveyService()

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Free up any resources held since the connector is no longer needed.
void	start()	Indicates that the survey action service is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.frameworks.opensurvey.SurveyActionServiceConnector

getConnectorComponentDescription, getEmbeddedSurveyActionServices, getJSONProperties, getRootSchemaType, getSurveyContext, handleUnexpectedException, performCheckAssetAnalysisStep, performCheckAssetAnalysisStep, setAuditLog, setSurveyActionServiceName, setSurveyContext, setUpAnnotation, throwMissingSchemaType, writeNameCountInventory, writeNameDescriptionInventory, writeNameListInventory, writePropertyListInventory

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

combineConfigurationProperties, disconnectConnectors, equals, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, 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

FolderSurveyService

public FolderSurveyService()

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 SurveyActionServiceConnector

Throws:

ConnectorCheckedException - there is a problem within the discovery service.

UserNotAuthorizedException - the service was disconnected before/during start

disconnect

public void disconnect()
                throws ConnectorCheckedException

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

Overrides:

disconnect in class SurveyActionServiceConnector

Throws:

ConnectorCheckedException - there is a problem within the connector.