Class DataFilesMonitorIntegrationConnector
java.lang.Object
org.odpi.openmetadata.frameworks.connectors.Connector
org.odpi.openmetadata.frameworks.connectors.ConnectorBase
org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase
org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorConnector
org.odpi.openmetadata.adapters.connectors.integration.basicfiles.BasicFilesMonitorIntegrationConnectorBase
org.odpi.openmetadata.adapters.connectors.integration.basicfiles.DataFilesMonitorIntegrationConnector
- All Implemented Interfaces:
AuditLoggingComponent
,SecureConnectorExtension
,VirtualConnectorExtension
,IntegrationConnector
,FilesIntegratorOMISConnector
- Direct Known Subclasses:
OMArchiveFilesMonitorIntegrationConnector
DataFilesMonitorIntegrationConnector monitors a file directory and catalogues the files it finds.
-
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.integration.connectors.IntegrationConnectorBase
auditLog, catalogTargetsManager, connectorName, integrationContext, propertyHelper
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncreateDirectoryToMonitor
(String sourceName, String pathName, String catalogTargetGUID, DeleteMethod deleteMethod, Map<String, String> templates, Map<String, Object> configurationProperties) Creates a monitor for the target.void
refresh()
Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories.Methods inherited from class org.odpi.openmetadata.adapters.connectors.integration.basicfiles.BasicFilesMonitorIntegrationConnectorBase
archiveFileInCatalog, disconnect, start
Methods inherited from class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorConnector
getContext, setContext
Methods inherited from class org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase
engage, getConnectorComponentDescription, getNetworkAddress, refreshCatalogTargets, registerCatalogTargetChangeListener, setAuditLog, setConnectorName, setContext
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, 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
Methods inherited from interface org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension
initializeEmbeddedConnectors
-
Constructor Details
-
DataFilesMonitorIntegrationConnector
public DataFilesMonitorIntegrationConnector()
-
-
Method Details
-
createDirectoryToMonitor
public DirectoryToMonitor createDirectoryToMonitor(String sourceName, String pathName, String catalogTargetGUID, DeleteMethod deleteMethod, Map<String, String> templates, Map<String, throws ConnectorCheckedExceptionObject> configurationProperties) Creates a monitor for the target.- Specified by:
createDirectoryToMonitor
in classBasicFilesMonitorIntegrationConnectorBase
- Parameters:
sourceName
- source of the pathnamepathName
- pathname to the directorycatalogTargetGUID
- optional catalog target GUIDdeleteMethod
- should the connector use delete or archive?templates
- names and GUIDs of templatesconfigurationProperties
- parameters to further modify the behaviour of the connector.- Returns:
- directory to monitor structure
- Throws:
ConnectorCheckedException
- connector problem
-
refresh
Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories. Refresh is called when the integration connector first starts and then at intervals defined in the connector's configuration as well as any external REST API calls to explicitly refresh the connector.
This method performs two sweeps. It first retrieves the files in the directory and validates that are in the catalog - adding or updating them if necessary. The second sweep is to ensure that all the assets catalogued in this directory actually exist on the file system.- Throws:
ConnectorCheckedException
- there is a problem with the connector. It is not able to refresh the metadata.
-