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

Class DirectoryToMonitor

java.lang.Object
org.odpi.openmetadata.adapters.connectors.integration.basicfiles.DirectoryToMonitor
All Implemented Interfaces:
FileDirectoryListenerInterface, FileListenerInterface
Direct Known Subclasses:
DataFilesMonitorForTarget, DataFolderMonitorForTarget
public abstract class DirectoryToMonitor extends Object implements FileDirectoryListenerInterface
Directory to monitor caches information about a specific directory that is at the root of the monitoring.

  • Field Details

    • propertyHelper

      protected final PropertyHelper propertyHelper

    • auditLog

      protected final AuditLog auditLog

    • integrationConnector

      protected final BasicFilesMonitorIntegrationConnectorBase integrationConnector

    • connectorName

      protected final String connectorName

    • sourceName

      protected String sourceName
      Where did information about this directory come from?

    • directoryName

      protected String directoryName
      What is the short name for this directory?

    • fileSystemName

      protected String fileSystemName
      Default values for the file system name and mount point.

    • localMountPoint

      protected String localMountPoint

    • canonicalMountPoint

      protected String canonicalMountPoint

    • directoryFile

      protected File directoryFile
      This is the Java File object that is accessing the directory.

    • isListening

      protected boolean isListening
      This boolean indicates that the connector is registered to listen for changes in the directory.

    • catalogTargetGUID

      protected final String catalogTargetGUID
      This is the unique identifier of the CatalogTarget relationship that this directory matches. Null means the value was supplied in the endpoint.

    • dataFolderGUID

      protected String dataFolderGUID

    • fileSystemProperties

      protected final FileSystemProperties fileSystemProperties

    • configurationProperties

      protected final Map<String,Object> configurationProperties

    • templates

      protected final Map<String,String> templates
      Templates for cataloguing files and folders

    • toDoTemplateQualifiedName

      protected String toDoTemplateQualifiedName
      Template for creating todos

    • toDoTemplateGUID

      protected String toDoTemplateGUID

    • incidentReportTemplateQualifiedName

      protected String incidentReportTemplateQualifiedName
      Template for creating incident reports

    • incidentReportTemplateGUID

      protected String incidentReportTemplateGUID

    • newFileProcessName

      protected String newFileProcessName

    • allowCatalogDelete

      protected boolean allowCatalogDelete
      Policy for deleting

    • waitForDirectory

      protected boolean waitForDirectory
      Does the physical directory have to exist or will it wait?

    • catalogClassifiedFiles

      protected boolean catalogClassifiedFiles
      Should only file types that are recognized by the classifier be catalogued.

    • metadataSourceGUID

      protected String metadataSourceGUID

    • metadataSourceName

      protected String metadataSourceName

  • Constructor Details

    • DirectoryToMonitor

      public DirectoryToMonitor(String connectorName, String sourceName, String pathName, String catalogTargetGUID, String dataFolderGUID, DeleteMethod deleteMethod, Map<String,String> templates, FileSystemProperties fileSystemProperties, Map<String,Object> configurationProperties, BasicFilesMonitorIntegrationConnectorBase integrationConnector, AuditLog auditLog)
      Construct the monitor for a specific catalog target.
      Parameters:
      connectorName - name of associated connector
      sourceName - source of the pathname
      pathName - pathname to the directory
      catalogTargetGUID - optional catalog target GUID
      dataFolderGUID - optional GUID of the data folder element
      deleteMethod - should the connector use delete or archive?
      templates - names and GUIDs of templates
      fileSystemProperties - properties of the file system
      configurationProperties - parameters to further modify the behaviour of the connector
      integrationConnector - associated connector
      auditLog - logging destination

  • Method Details

    • getDataFolderElement

      protected OpenMetadataRootElement getDataFolderElement() throws ConnectorCheckedException
      Return the data folder element for this directory.
      Returns:
      root element for the data folder
      Throws:
      ConnectorCheckedException - problem accessing information

    • refresh

      public abstract void refresh() throws 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.
      Throws:
      ConnectorCheckedException - a problem with the connector. It is not able to refresh the metadata.