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

Class ConnectedAssetUniverse

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

org.odpi.openmetadata.frameworks.openmetadata.metadataelements.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.AssetSummary

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

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

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

public class ConnectedAssetUniverse
extends AssetUniverse

ConnectedAssetUniverse is the 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.

Field Summary

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

feedback, knownLocations, lineage, meanings, relatedAssets

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

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

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

abbreviation, deployedImplementationType, displayDescription, displayName, displaySummary, resourceDescription, resourceName, usage, versionIdentifier

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

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

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

CURRENT_AUDIT_HEADER_VERSION

Method Summary

Modifier and Type	Method	Description
static ConnectedAssetUniverse	create(String serviceName, String remoteServerName, String platformURLRoot, String userId, String assetGUID)	Static factory method used for creating a ConnectedAssetUniverse object without authentication.
static ConnectedAssetUniverse	create(String serviceName, String remoteServerName, String platformURLRoot, String userId, String assetGUID, String connectionGUID)	Static factory method used by EgeriaConnectedAssetProperties.refresh() to instantiate a ConnectedAssetUniverse object with no authentication information being attached to the HTTP requests.
static ConnectedAssetUniverse	create(String serviceName, String remoteServerName, String localServerUserId, String localServerPassword, String platformURLRoot, String userId, String assetGUID)	Static factory method used for creating a ConnectedAssetUniverse object where a userId and password of the local calling server are embedded in the HTTP request.
static ConnectedAssetUniverse	create(String serviceName, String remoteServerName, String localServerUserId, String localServerPassword, String platformURLRoot, String userId, String assetGUID, String connectionGUID)	Static factory method used by EgeriaConnectedAssetProperties.refresh() to instantiate a ConnectedAssetUniverse object where a usedId and password of the local calling server are embedded in the HTTP request.
static ConnectedAssetUniverse	create(String serviceName, String remoteServerName, String platformURLRoot, String userId, String assetGUID, OCFRESTClient restClient)	Static factory method used for creating a ConnectedAssetUniverse object.

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

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

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

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

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

getAbbreviation, getDeployedImplementationType, getDisplayDescription, getDisplayName, getDisplaySummary, getResourceDescription, getResourceName, getUsage, getVersionIdentifier, setAbbreviation, setDeployedImplementationType, setDisplayDescription, setDisplayName, setDisplaySummary, setResourceDescription, setResourceName, setUsage, setVersionIdentifier

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

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, setExtendedProperties

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader

getClassifications, getGUID, setClassifications, setGUID

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader

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

Methods inherited from class java.lang.Object

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

Method Details

create

public static ConnectedAssetUniverse create(String serviceName,
 String remoteServerName,
 String platformURLRoot,
 String userId,
 String assetGUID)
                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Static factory method used for creating a ConnectedAssetUniverse object without authentication.

Parameters:

serviceName - calling service

remoteServerName - name of the server.

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

create

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

Static factory method used for creating a ConnectedAssetUniverse object where a userId and password of the local calling server are embedded in the HTTP request.

Parameters:

serviceName - calling service

remoteServerName - name of the server.

localServerUserId - userId of the local server.

localServerPassword - password of the local server.

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

create

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

Static factory method used for creating a ConnectedAssetUniverse object.

Parameters:

serviceName - calling service

remoteServerName - name of the server.

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

create

public static ConnectedAssetUniverse create(String serviceName,
 String remoteServerName,
 String platformURLRoot,
 String userId,
 String assetGUID,
 String connectionGUID)
                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Static factory method used by EgeriaConnectedAssetProperties.refresh() to instantiate a ConnectedAssetUniverse object with no authentication information being attached to the HTTP requests.

Parameters:

serviceName - calling service

remoteServerName - name of the server.

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

create

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

Static factory method used by EgeriaConnectedAssetProperties.refresh() to instantiate a ConnectedAssetUniverse object where a usedId and password of the local calling server are embedded in the HTTP request.

Parameters:

serviceName - calling service

remoteServerName - name of the server.

localServerUserId - userId of the local server.

localServerPassword - password of the local server.

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