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

Class ConnectedAssetUniverse

java.lang.Object

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

org.odpi.openmetadata.frameworks.connectors.properties.AssetDescriptor

org.odpi.openmetadata.frameworks.connectors.properties.AssetSummary

org.odpi.openmetadata.frameworks.connectors.properties.AssetDetail

org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse

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

All Implemented Interfaces:

Serializable

public class ConnectedAssetUniverse
extends AssetUniverse

ConnectedAssetUniverse is the OMAS client library implementation of the Open Connector Framework (OCF) AssetUniverse object. AssetUniverse provides read-only access to the properties known about an asset. ConnectedAssetUniverse configures AssetUniverse (and its dependent objects) with the information necessary to populate the AssetUniverse contents from the open metadata repositories. All of ConnectedAssetUniverse's work is done in the constructors. They extract basic information about the asset and push objects to the super class to retrieve the more detailed properties. These properties are only retrieved on demand.

See Also:

Serialized Form

Field Summary

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

feedback, knownLocations, lineage, meanings, relatedAssets, schema

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

certifications, connections, externalIdentifiers, externalReferences, licenses, noteLogs, relatedMediaReferences

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

assetBean

Constructor Summary

Constructors

Constructor and Description
ConnectedAssetUniverse(String serviceName, String remoteServerName, String omasServerURL, String userId, String assetGUID) Constructor used by Asset Consumer OMAS for getAssetProperties() with no authentication information being attached to the HTTP requests.
ConnectedAssetUniverse(String serviceName, String remoteServerName, String omasServerURL, String userId, String assetGUID, OCFRESTClient restClient) Constructor used by Connected Asset OMAS for related asset properties.
ConnectedAssetUniverse(String serviceName, String remoteServerName, String omasServerURL, String userId, String assetGUID, String connectionGUID) Constructor used by ConnectedAssetProperties.refresh() with no authentication information being attached to the HTTP requests.
ConnectedAssetUniverse(String serviceName, String remoteServerName, String localServerUserId, String localServerPassword, String omasServerURL, String userId, String assetGUID) Constructor used by Asset Consumer OMAS for getExtendedProperties() where a userId and password of the local calling server are embedded in the HTTP requests.
ConnectedAssetUniverse(String serviceName, String remoteServerName, String localServerUserId, String localServerPassword, String omasServerURL, String userId, String assetGUID, String connectionGUID) Constructor used by ConnectedAssetProperties.refresh() with no authentication information being attached to the HTTP requests.

Method Summary

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

equals, getFeedback, getKnownLocations, getLineage, getMeanings, getRelatedAssets, getSchema, toString

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

getCertifications, getConnections, getExternalIdentifiers, getExternalReferences, getLicenses, getNoteLogs, getRelatedMediaReferences

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

getAdditionalProperties, getAssetClassifications, getDescription, getDisplayName, getExtendedProperties, getGUID, getLatestChange, getOwner, getOwnerType, getQualifiedName, getShortDescription, getType, getURL, getZoneMembership, hashCode

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

getAssetBean, getAssetName, getAssetSuperTypeNames, getAssetTypeName, setAssetBean

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectedAssetUniverse

public ConnectedAssetUniverse(String serviceName,
                              String remoteServerName,
                              String omasServerURL,
                              String userId,
                              String assetGUID)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Constructor used by Asset Consumer OMAS for getAssetProperties() with no authentication information being attached to the HTTP requests. The calling user of the specific request flows as a property in the URL.

Parameters:

serviceName - calling service

remoteServerName - name of the server.

omasServerURL - url used to call the server.

userId - userId of user making request.

assetGUID - unique id for asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem retrieving the asset properties from the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

ConnectedAssetUniverse

public ConnectedAssetUniverse(String serviceName,
                              String remoteServerName,
                              String localServerUserId,
                              String localServerPassword,
                              String omasServerURL,
                              String userId,
                              String assetGUID)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Constructor used by Asset Consumer OMAS for getExtendedProperties() where a userId and password of the local calling server are embedded in the HTTP requests. The calling user of the specific request flows as a property in the URL.

Parameters:

serviceName - calling service

remoteServerName - name of the server.

localServerUserId - userId of the local server.

localServerPassword - password of the local server.

omasServerURL - url used to call the server.

userId - userId of user making request.

assetGUID - unique id for asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem retrieving the asset properties from the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

ConnectedAssetUniverse

public ConnectedAssetUniverse(String serviceName,
                              String remoteServerName,
                              String omasServerURL,
                              String userId,
                              String assetGUID,
                              OCFRESTClient restClient)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Constructor used by Connected Asset OMAS for related asset properties.

Parameters:

serviceName - calling service

remoteServerName - name of the server.

omasServerURL - url used to call the server.

userId - userId of user making request.

assetGUID - unique id for asset.

restClient - client for calling rest APIs

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem retrieving the asset properties from the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

ConnectedAssetUniverse

public ConnectedAssetUniverse(String serviceName,
                              String remoteServerName,
                              String omasServerURL,
                              String userId,
                              String assetGUID,
                              String connectionGUID)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Constructor used by ConnectedAssetProperties.refresh() with no authentication information being attached to the HTTP requests. The calling user of the specific request flows as a property in the URL.

Parameters:

serviceName - calling service

remoteServerName - name of the server.

omasServerURL - url used to call the server.

userId - userId of user making request.

assetGUID - unique id for asset.

connectionGUID - unique id for connection used to access asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem retrieving the asset properties from the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

ConnectedAssetUniverse

public ConnectedAssetUniverse(String serviceName,
                              String remoteServerName,
                              String localServerUserId,
                              String localServerPassword,
                              String omasServerURL,
                              String userId,
                              String assetGUID,
                              String connectionGUID)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Constructor used by ConnectedAssetProperties.refresh() with no authentication information being attached to the HTTP requests. The calling user of the specific request flows as a property in the URL.

Parameters:

serviceName - calling service

remoteServerName - name of the server.

localServerUserId - userId of the local server.

localServerPassword - password of the local server.

omasServerURL - url used to call the server.

userId - userId of user making request.

assetGUID - unique id for asset.

connectionGUID - unique id for connection used to access asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem retrieving the asset properties from the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.