Package org.odpi.openmetadata.adapters.connectors.discoveryservices

Class AuditableDiscoveryService

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.Connector
org.odpi.openmetadata.frameworks.connectors.ConnectorBase
org.odpi.openmetadata.frameworks.discovery.DiscoveryService
org.odpi.openmetadata.adapters.connectors.discoveryservices.AuditableDiscoveryService
All Implemented Interfaces:
org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension, org.odpi.openmetadata.frameworks.discovery.OpenDiscoveryService
Direct Known Subclasses:
CSVDiscoveryService, DuplicateSuspectDiscoveryService
public abstract class AuditableDiscoveryService extends org.odpi.openmetadata.frameworks.discovery.DiscoveryService
AuditableDiscoveryService is a base class for discovery services that wish to use the audit log.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

    org.odpi.openmetadata.frameworks.connectors.ConnectorBase.ProtectedConnection

  • Field Summary

    Fields inherited from class org.odpi.openmetadata.frameworks.discovery.DiscoveryService

    auditLog, discoveryContext, discoveryServiceName, embeddedConnectors

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

    connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, securedProperties

  • Constructor Summary

    Constructors
    Constructor
    Description
    AuditableDiscoveryService()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected String
    getAssetTypeName(org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse asset, String methodName)
    Return the type name for the asset.
    protected List<String>
    getNetworkAddresses(org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse asset)
    Return the network address of this asset.
    protected void
    logNoAsset(String assetGUID, String methodName)
    Log that no asset has been returned to the discovery service.
    protected void
    logWrongTypeOfAsset(String assetGUID, String assetType, String supportedAssetType, String methodName)
    Log that the discovery service can not process the type of asset it has been passed.

    Methods inherited from class org.odpi.openmetadata.frameworks.discovery.DiscoveryService

    disconnect, getConnectorComponentDescription, getDiscoveryContext, getEmbeddedDiscoveryServices, handleUnexpectedException, initializeEmbeddedConnectors, setAuditLog, setDiscoveryContext, setDiscoveryServiceName, start

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

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

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • AuditableDiscoveryService

      public AuditableDiscoveryService()

  • Method Details

    • logNoAsset

      protected void logNoAsset(String assetGUID, String methodName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Log that no asset has been returned to the discovery service. It is unable to proceed without this basic information.
      Parameters:
      assetGUID - the unique identifier of the asset from the discovery context
      methodName - calling method
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - resulting exception

    • logWrongTypeOfAsset

      protected void logWrongTypeOfAsset(String assetGUID, String assetType, String supportedAssetType, String methodName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Log that the discovery service can not process the type of asset it has been passed.
      Parameters:
      assetGUID - identifier of the asset
      assetType - type of the asset
      supportedAssetType - supported asset types
      methodName - calling method
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - resulting exception

    • getAssetTypeName

      protected String getAssetTypeName(org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse asset, String methodName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Return the type name for the asset. An exception is thrown if the type name is not available.
      Parameters:
      asset - asset universe
      methodName - calling method
      Returns:
      asset's type name
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - resulting exception

    • getNetworkAddresses

      protected List<String> getNetworkAddresses(org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse asset)
      Return the network address of this asset.
      Parameters:
      asset - asset to extract address from
      Returns:
      the list of network addresses