Package org.odpi.openmetadata.frameworks.connectors.properties

Class ConnectedAssetProperties

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
org.odpi.openmetadata.frameworks.connectors.properties.ConnectedAssetProperties
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
EgeriaConnectedAssetProperties, EnterpriseOMRSConnectorProperties
public abstract class ConnectedAssetProperties extends PropertyBase
ConnectedAssetProperties is associated with a Connector. Connectors provide access to assets. ConnectedAssetProperties returns properties (metadata) about the connector's asset. It is a generic interface for all types of open metadata assets. However, it assumes the asset's metadata model inherits from Asset (see model 0010 in Area 0). The ConnectedAssetProperties returns metadata about the asset at three levels of detail:
  • assetSummary used for displaying details of the asset in summary lists or hover text
  • assetDetail used to display all the information known about the asset with summaries of the relationships to other metadata entities
  • assetUniverse used to define the broader context for the asset
ConnectedAssetProperties is a base class for the connector's metadata API that returns null, for the asset's properties. Metadata repository implementations extend this class to add their implementation of the refresh() method that calls to the metadata repository to populate the metadata properties.
See Also:

  • Field Details

  • Constructor Details

    • ConnectedAssetProperties

      public ConnectedAssetProperties()
      Typical constructor.

    • ConnectedAssetProperties

      public ConnectedAssetProperties(ConnectedAssetProperties templateProperties)
      Copy/clone constructor.
      Parameters:
      templateProperties - template to copy.

  • Method Details

    • getAssetSummary

      public AssetSummary getAssetSummary()
      Returns the summary information organized in the assetSummary structure.
      Returns:
      AssetSummary summary object

    • getAssetDetail

      public AssetDetail getAssetDetail()
      Returns detailed information about the asset organized in the assetDetail structure.
      Returns:
      AssetDetail detail object

    • getAssetUniverse

      public AssetUniverse getAssetUniverse()
      Returns all the detail of the asset and information connected to it in organized in the assetUniverse structure.
      Returns:
      AssetUniverse universe object

    • refresh

      public abstract void refresh() throws PropertyServerException, UserNotAuthorizedException
      Request the values in the ConnectedAssetProperties are refreshed with the current values from the metadata repository.
      Throws:
      PropertyServerException - there is a problem connecting to the server to retrieve metadata.
      UserNotAuthorizedException - the userId associated with the connector is not authorized to access the asset properties.

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style