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

Class EgeriaConnectedAssetProperties

java.lang.Object

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

org.odpi.openmetadata.frameworks.connectors.properties.ConnectedAssetProperties

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

public class EgeriaConnectedAssetProperties
extends org.odpi.openmetadata.frameworks.connectors.properties.ConnectedAssetProperties

EgeriaConnectedAssetProperties is associated with a Connector. Connectors provide access to assets. EgeriaConnectedAssetProperties 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 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

EgeriaConnectedAssetProperties 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.

Field Summary

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

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor	Description
EgeriaConnectedAssetProperties(String serviceName, String remoteServerName, String localServerUserId, String localServerPassword, String userId, String platformURLRoot, String connectorInstanceId, org.odpi.openmetadata.frameworks.connectors.properties.ConnectionProperties connection, String assetGUID)	Constructor with userId and password embedded in the HTTP request.
EgeriaConnectedAssetProperties(String serviceName, String remoteServerName, String userId, String platformURLRoot, String connectorInstanceId, org.odpi.openmetadata.frameworks.connectors.properties.ConnectionProperties connection, String assetGUID)	Constructor with no security used on the HTTP request.
EgeriaConnectedAssetProperties(EgeriaConnectedAssetProperties 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.ConnectedAssetProperties

getAssetDetail, getAssetSummary, getAssetUniverse

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

equals, getHeaderVersion, hashCode, setHeaderVersion

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EgeriaConnectedAssetProperties

public EgeriaConnectedAssetProperties(String serviceName,
 String remoteServerName,
 String userId,
 String platformURLRoot,
 String connectorInstanceId,
 org.odpi.openmetadata.frameworks.connectors.properties.ConnectionProperties connection,
 String assetGUID)

Constructor with no security used on the HTTP request.

Parameters:

serviceName - calling service

remoteServerName - name of the server.

userId - identifier of calling user

platformURLRoot - url of server

connectorInstanceId - unique identifier of connector.

connection - connection information for connector.

assetGUID - String unique id for connected asset.

EgeriaConnectedAssetProperties

public EgeriaConnectedAssetProperties(String serviceName,
 String remoteServerName,
 String localServerUserId,
 String localServerPassword,
 String userId,
 String platformURLRoot,
 String connectorInstanceId,
 org.odpi.openmetadata.frameworks.connectors.properties.ConnectionProperties connection,
 String assetGUID)

Constructor with userId and password embedded in the HTTP request.

Parameters:

serviceName - calling service

remoteServerName - name of the server to call.

localServerUserId - userId to use on the rest call.

localServerPassword - password to use on the rest call.

userId - identifier of calling user

platformURLRoot - url of server

connectorInstanceId - unique identifier of connector.

connection - connection information for connector.

assetGUID - String unique id for connected asset.

EgeriaConnectedAssetProperties

public EgeriaConnectedAssetProperties(EgeriaConnectedAssetProperties template)

Copy/clone constructor.

Parameters:

template - template to copy.

Method Details

refresh

public void refresh()
             throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

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

Specified by:

refresh in class org.odpi.openmetadata.frameworks.connectors.properties.ConnectedAssetProperties

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem connecting to the server to retrieve metadata.

org.odpi.openmetadata.frameworks.connectors.ffdc.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 org.odpi.openmetadata.frameworks.connectors.properties.ConnectedAssetProperties

Returns:

JSON style description of variables.