Package org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client

Class ConnectedAssetRelatedAssetProperties

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader

org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase

org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable

org.odpi.openmetadata.frameworks.connectors.properties.beans.Asset

org.odpi.openmetadata.frameworks.connectors.properties.beans.RelatedAsset

org.odpi.openmetadata.frameworks.connectors.properties.RelatedAssetProperties

org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetRelatedAssetProperties

All Implemented Interfaces:

Serializable

public class ConnectedAssetRelatedAssetProperties
extends RelatedAssetProperties

RelatedAssetProperties is associated a related asset for a connector's EgeriaConnectedAssetProperties. Connectors provide access to assets. EgeriaConnectedAssetProperties returns properties (metadata) about the connector's asset. RelatedAssetProperties returns similar information for an asset related to the connected 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 EgeriaConnectedAssetProperties 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

RelatedAssetProperties 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:

• Serialized Form

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.RelatedAssetProperties

assetProperties

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Asset

abbreviation, connectionDescription, description, displayDescription, displayName, displaySummary, isReferenceData, name, origin, owner, ownerPropertyName, ownerType, ownerTypeName, resourceDescription, resourceName, usage, versionIdentifier, zoneMembership

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable

meanings, searchKeywords

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

additionalProperties, qualifiedName

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase

extendedProperties, url

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor	Description
ConnectedAssetRelatedAssetProperties(RelatedAsset bean, String serviceName, String serverName, String userId, String platformURLRoot, String assetGUID, OCFRESTClient restClient)	Typical constructor.
ConnectedAssetRelatedAssetProperties(ConnectedAssetRelatedAssetProperties template)	Copy/clone constructor.

Method Summary

Modifier and Type	Method	Description
void	refresh()	Request the values in the EgeriaConnectedAssetProperties are refreshed with the current values from the metadata repository.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.RelatedAssetProperties

getAssetDetail, getAssetSummary, getAssetUniverse

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.RelatedAsset

equals, getAttributeName, getRelationshipName, hashCode, setAttributeName, setRelationshipName

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Asset

getAbbreviation, getAssetOrigin, getConnectionDescription, getDescription, getDisplayDescription, getDisplayName, getDisplaySummary, getName, getOwner, getOwnerPropertyName, getOwnerType, getOwnerTypeName, getResourceDescription, getResourceName, getUsage, getVersionIdentifier, getZoneMembership, isReferenceData, setAbbreviation, setAssetOrigin, setConnectionDescription, setDescription, setDisplayDescription, setDisplayName, setDisplaySummary, setName, setOwner, setOwnerPropertyName, setOwnerType, setOwnerTypeName, setReferenceData, setResourceDescription, setResourceName, setUsage, setVersionIdentifier, setZoneMembership

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable

getMeanings, getSearchKeywords, setMeanings, setSearchKeywords

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase

getExtendedProperties, getURL, setExtendedProperties, setURL

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

getClassifications, getGUID, setClassifications, setGUID

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader

getOrigin, getStatus, getType, getVersions, setOrigin, setStatus, setType, setVersions

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object

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

Constructor Details

ConnectedAssetRelatedAssetProperties

public ConnectedAssetRelatedAssetProperties(RelatedAsset bean,
 String serviceName,
 String serverName,
 String userId,
 String platformURLRoot,
 String assetGUID,
 OCFRESTClient restClient)

Typical constructor.

Parameters:

bean - content for the superclass

serviceName - calling service

serverName - name of the server.

userId - identifier of calling user

platformURLRoot - url of server

assetGUID - String unique id for connected asset.

restClient - client to call REST API

ConnectedAssetRelatedAssetProperties

public ConnectedAssetRelatedAssetProperties(ConnectedAssetRelatedAssetProperties template)

Copy/clone constructor.

Parameters:

template - template to copy.

Method Details

refresh

public void refresh()
             throws PropertyServerException,
UserNotAuthorizedException

Request the values in the EgeriaConnectedAssetProperties are refreshed with the current values from the metadata repository.

Specified by:

refresh in class RelatedAssetProperties

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 RelatedAssetProperties

Returns:

JSON style description of variables.