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

Class DataFilesMonitorForTarget

java.lang.Object
org.odpi.openmetadata.adapters.connectors.integration.basicfiles.DirectoryToMonitor
org.odpi.openmetadata.adapters.connectors.integration.basicfiles.DataFilesMonitorForTarget
All Implemented Interfaces:
FileDirectoryListenerInterface, FileListenerInterface
Direct Known Subclasses:
OMArchiveFilesMonitorForTarget, OMSecretsFilesMonitorForTarget
public class DataFilesMonitorForTarget extends DirectoryToMonitor
Manages the cataloguing of data files for a specific catalog target.

  • Constructor Details

    • DataFilesMonitorForTarget

      public DataFilesMonitorForTarget(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 data folder GUID
      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

    • refresh

      public void 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.
      Specified by:
      refresh in class DirectoryToMonitor

    • onFileCreate

      public void onFileCreate(File file)
      File created Event.
      Parameters:
      file - The file that was created

    • onFileDelete

      public void onFileDelete(File file)
      Description copied from interface: FileListenerInterface
      File deleted Event.
      Parameters:
      file - The file that was deleted

    • onFileChange

      public void onFileChange(File file)
      File changed Event.
      Parameters:
      file - The file that changed

    • onDirectoryCreate

      public void onDirectoryCreate(File directory)
      Directory created Event.
      Parameters:
      directory - The directory that was created

    • onDirectoryChange

      public void onDirectoryChange(File directory)
      Directory changed Event.
      Parameters:
      directory - The directory that changed

    • onDirectoryDelete

      public void onDirectoryDelete(File directory)
      Directory deleted Event.
      Parameters:
      directory - The directory that was deleted

    • catalogFile

      protected String catalogFile(File file, String methodName)
      Create a catalog entry for a specific file.
      Parameters:
      file - Java File accessor
      methodName - calling method
      Returns:
      unique identifier of the catalogued element

    • addDataFileToCatalog

      protected String addDataFileToCatalog(String typeName, String fileAddress, DataFileProperties properties, DataAssetEncodingProperties encodingProperties, String connectorTypeGUID) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Return the unique identifier of a new metadata element describing the file.
      Parameters:
      typeName - subtype name for the file asset
      fileAddress - local file path name
      properties - basic properties to use
      encodingProperties - properties for DataAssetEncoding classification
      connectorTypeGUID - unique identifier for the connector type
      Returns:
      unique identifier (guid)
      Throws:
      InvalidParameterException - invalid parameter
      PropertyServerException - unable to communicate with the repository
      UserNotAuthorizedException - access problem for userId

    • addDataFileViaTemplate

      protected String addDataFileViaTemplate(String assetTypeName, String fileTemplateGUID, ElementProperties replacementProperties, Map<String,String> placeholderProperties) throws ConnectorCheckedException, InvalidParameterException, PropertyServerException, UserNotAuthorizedException
      Return the unique identifier of a new metadata element describing the file created using the supplied template.
      Parameters:
      assetTypeName - type of asset to create
      fileTemplateGUID - template to use
      replacementProperties - properties from the template to replace
      placeholderProperties - values to use to replace placeholders in the template
      Returns:
      unique identifier (guid)
      Throws:
      ConnectorCheckedException - connector has been shutdown
      InvalidParameterException - invalid parameter
      PropertyServerException - unable to communicate with the repository
      UserNotAuthorizedException - access problem for userId