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

Class ConnectedAssetProperties

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase

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

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetProperties

All Implemented Interfaces:

Serializable

public class ConnectedAssetProperties
extends ConnectedAssetProperties

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

Serialized Form

Field Summary

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

assetProperties

Constructor Summary

Constructors

Constructor	Description
ConnectedAssetProperties(String serviceName, String remoteServerName, String localServerUserId, String localServerPassword, String userId, String omasServerURL, String connectorInstanceId, ConnectionProperties connection, String assetGUID)	Constructor with userId and password embedded in the HTTP request.
ConnectedAssetProperties(String serviceName, String remoteServerName, String userId, String omasServerURL, String connectorInstanceId, ConnectionProperties connection, String assetGUID)	Constructor with no security used on the HTTP request.
ConnectedAssetProperties(ConnectedAssetProperties template)	Copy/clone constructor.

Method Summary

Modifier and Type	Method	Description
void	refresh()	Request the values in the ConnectedAssetProperties 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.AssetPropertyElementBase

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectedAssetProperties

public ConnectedAssetProperties(String serviceName,
                                String remoteServerName,
                                String userId,
                                String omasServerURL,
                                String connectorInstanceId,
                                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

omasServerURL - url of server

connectorInstanceId - unique identifier of connector.

connection - connection information for connector.

assetGUID - String unique id for connected asset.

ConnectedAssetProperties

public ConnectedAssetProperties(String serviceName,
                                String remoteServerName,
                                String localServerUserId,
                                String localServerPassword,
                                String userId,
                                String omasServerURL,
                                String connectorInstanceId,
                                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

omasServerURL - url of server

connectorInstanceId - unique identifier of connector.

connection - connection information for connector.

assetGUID - String unique id for connected asset.

ConnectedAssetProperties

public ConnectedAssetProperties(ConnectedAssetProperties template)

Copy/clone constructor.

Parameters:

template - template to copy.

Method Detail

refresh

public void refresh()
             throws PropertyServerException,
                    UserNotAuthorizedException

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

Specified by:

refresh in class ConnectedAssetProperties

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 ConnectedAssetProperties

Returns:

JSON style description of variables.