Package org.odpi.openmetadata.adapters.connectors.integration.basicfiles

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:
org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension, org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnector, org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorOMISConnector
Direct Known Subclasses:
OMArchiveFilesMonitorIntegrationConnector
public class DataFilesMonitorIntegrationConnector extends BasicFilesMonitorIntegrationConnectorBase
DataFilesMonitorIntegrationConnector monitors a file directory and catalogues the files it finds.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataFilesMonitorIntegrationConnector()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    DirectoryToMonitor
    createDirectoryToMonitor(String sourceName, String pathName, String catalogTargetGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.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, setAuditLog, setConnectorName, setContext

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

    equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, 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

    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, org.odpi.openmetadata.frameworks.openmetadata.enums.DeleteMethod deleteMethod, Map<String,String> templates, Map<String,Object> configurationProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Creates a monitor for the target.
      Parameters:
      sourceName - source of the pathname
      pathName - pathname to the directory
      catalogTargetGUID - optional catalog target GUID
      deleteMethod - should the connector use delete or archive?
      templates - names and GUIDs of templates
      configurationProperties - parameters to further modify the behaviour of the connector.
      Returns:
      directory to monitor structure
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException

    • refresh

      public void refresh() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem with the connector. It is not able to refresh the metadata.