Class BasicFilesMonitorIntegrationConnectorBase

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
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:
DataFilesMonitorIntegrationConnector, DataFolderMonitorIntegrationConnector

public abstract class BasicFilesMonitorIntegrationConnectorBase extends org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorConnector
BasicFilesMonitorIntegrationConnectorBase provides common methods for the connectors in this module.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    archiveFileInCatalog(File file, org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DataFileElement retrievedElement, boolean allowCatalogDelete, String methodName)
    The file no longer exists so this method updates the metadata catalog.
    void
    Shutdown file monitoring
    void
    Indicates that the connector is completely configured and can begin processing.

    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.integration.connectors.IntegrationConnector

    refresh

    Methods inherited from interface org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension

    initializeEmbeddedConnectors
  • Constructor Details

    • BasicFilesMonitorIntegrationConnectorBase

      public BasicFilesMonitorIntegrationConnectorBase()
  • Method Details

    • start

      public void start() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Indicates that the connector is completely configured and can begin processing. It extracts all the useful configuration from the connection object.
      Specified by:
      start in interface org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnector
      Overrides:
      start in class org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the connector.
    • archiveFileInCatalog

      public void archiveFileInCatalog(File file, org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DataFileElement retrievedElement, boolean allowCatalogDelete, String methodName)
      The file no longer exists so this method updates the metadata catalog. This may be a call to delete() or an archive action depending on the setting of the allowCatalogDelete configuration property.
      Parameters:
      file - Java file access object
      retrievedElement - catalogued element
      methodName - calling method
    • disconnect

      public void disconnect() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Shutdown file monitoring
      Specified by:
      disconnect in interface org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnector
      Overrides:
      disconnect in class org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - something failed in the super class