org.odpi.openmetadata.accessservices.assetowner.client

Class AssetOwner

java.lang.Object

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

org.odpi.openmetadata.accessservices.assetowner.client.AssetOwner

All Implemented Interfaces:

AssetClassificationInterface, AssetDecommissioningInterface, AssetOnboardingInterface, AssetReviewInterface

public class AssetOwner
extends ConnectedAssetClientBase
implements AssetOnboardingInterface, AssetClassificationInterface, AssetReviewInterface, AssetDecommissioningInterface

AssetOwner provides the generic client-side interface for the Asset Owner Open Metadata Access Service (OMAS). There are other clients that provide specialized methods for specific types of Asset. This client is initialized with the URL and name of the server that is running the Asset Owner OMAS. This server is responsible for locating and managing the asset owner's definitions exchanged with this client.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

invalidParameterHandler, nullRequestBody, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor and Description
AssetOwner(String serverName, String serverPlatformRootURL) Create a new client with no authentication embedded in the HTTP request.
AssetOwner(String serverName, String serverPlatformRootURL, String userId, String password) Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method and Description
void	addAssetOrigin(String userId, String assetGUID, String organizationGUID, String businessCapabilityGUID, Map<String,String> otherOriginValues) Add the asset origin classification to an asset.
String	addAssetToCatalog(String userId, String typeName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) Add a simple asset description to the catalog.
void	addConnectionToAsset(String userId, String assetGUID, String assetSummary, Connection connection) Adds a connection to an asset.
void	addSchemaAttributesToSchema(String userId, String schemaTypeGUID, List<SchemaAttribute> schemaAttributes) Adds attributes to a complex schema type like a relational table or a structured document.
String	addSchemaToAsset(String userId, String assetGUID, SchemaType schemaType, List<SchemaAttribute> schemaAttributes) Links the supplied schema to the asset.
void	addSecurityTags(String userId, String assetGUID, String assetElementGUID, List<String> securityLabels, Map<String,Object> securityProperties) Add or replace the security tags for an asset or one of its elements.
void	addSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID) Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).
void	deleteAsset(String userId, String assetGUID) Deletes an asset and all of its associated elements such as schema, connections (unless they are linked to another asset), discovery reports and associated feedback.
List<Asset>	findAssets(String userId, String searchString, int startFrom, int pageSize) Return a list of assets with the requested search string in their name, qualified name or description.
AssetUniverse	getAssetProperties(String userId, String assetGUID) Returns a comprehensive collection of properties about the requested asset.
List<Asset>	getAssetsByName(String userId, String name, int startFrom, int pageSize) Return a list of assets with the requested name.
Asset	getAssetSummary(String userId, String assetGUID) Return the basic attributes of an asset.
Connector	getConnectorToAsset(String userId, String assetGUID) Return a connector for the asset to enable the calling user to access the content.
List<DiscoveryAnalysisReport>	getDiscoveryAnalysisReports(String userId, String assetGUID, int startingFrom, int maximumResults) Return the discovery analysis reports about the asset.
List<Annotation>	getDiscoveryReportAnnotations(String userId, String discoveryReportGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults) Return the annotations linked directly to the report.
List<Annotation>	getExtendedAnnotations(String userId, String annotationGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults) Return any annotations attached to this annotation.
void	removeAssetOrigin(String userId, String assetGUID) Remove the asset origin classification to an asset.
void	removeSecurityTags(String userId, String assetGUID, String assetElementGUID) Remove the security tags classification to an asset or one of its elements.
void	removeSemanticAssignment(String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID) Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
void	updateAssetOwner(String userId, String assetGUID, String ownerId, OwnerType ownerType) Update the owner information for a specific asset.
void	updateAssetZones(String userId, String assetGUID, List<String> assetZones) Update the zones for a specific asset.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

getAssetForConnection, getAssetProperties, getAssetSummary, getConnectionByGUID, getConnectionForAsset, getConnectorForConnection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetOwner

public AssetOwner(String serverName,
                  String serverPlatformRootURL)
           throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

AssetOwner

public AssetOwner(String serverName,
                  String serverPlatformRootURL,
                  String userId,
                  String password)
           throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

addAssetToCatalog

public String addAssetToCatalog(String userId,
                                String typeName,
                                String qualifiedName,
                                String displayName,
                                String description,
                                Map<String,String> additionalProperties,
                                Map<String,Object> extendedProperties)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Add a simple asset description to the catalog.

Specified by:

addAssetToCatalog in interface AssetOnboardingInterface

Parameters:

userId - calling user (assumed to be the owner)

typeName - specific type of the asset - this must match a defined subtype

qualifiedName - unique name for the asset in the catalog

displayName - display name for the asset in the catalog

description - description of the asset in the catalog

Returns:

unique identifier (guid) of the asset

Throws:

InvalidParameterException - full path or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addSchemaToAsset

public String addSchemaToAsset(String userId,
                               String assetGUID,
                               SchemaType schemaType,
                               List<SchemaAttribute> schemaAttributes)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Links the supplied schema to the asset. If the schema has the GUID set, it is assumed to refer to an existing schema defined in the metadata repository. If this schema is either not found, or already attached to an asset, then an error occurs. If the GUID is null then a new schemaType is added to the metadata repository and attached to the asset. If another schema is currently attached to the asset, it is unlinked and deleted.

Specified by:

addSchemaToAsset in interface AssetOnboardingInterface

Parameters:

userId - calling user

assetGUID - unique identifier of the asset that the schema is to be attached to

schemaType - schema to attach

schemaAttributes - list of schema attribute objects.

Returns:

unique identifier (guid) of the schema

Throws:

InvalidParameterException - full path or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addSchemaAttributesToSchema

public void addSchemaAttributesToSchema(String userId,
                                        String schemaTypeGUID,
                                        List<SchemaAttribute> schemaAttributes)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Adds attributes to a complex schema type like a relational table or a structured document. This method can be called repeatedly to add many attributes to a schema.

Specified by:

addSchemaAttributesToSchema in interface AssetOnboardingInterface

Parameters:

userId - calling user

schemaTypeGUID - unique identifier if the schema to anchor these attributes to.

schemaAttributes - list of schema attribute objects.

Throws:

InvalidParameterException - full path or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addConnectionToAsset

public void addConnectionToAsset(String userId,
                                 String assetGUID,
                                 String assetSummary,
                                 Connection connection)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Adds a connection to an asset. Assets can have multiple connections attached.

Specified by:

addConnectionToAsset in interface AssetOnboardingInterface

Parameters:

userId - calling user

assetGUID - unique identifier of the attest to attach the connection to

assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.

connection - connection object. If the connection is already stored (matching guid) then the existing connection is used.

Throws:

InvalidParameterException - full path or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addSemanticAssignment

public void addSemanticAssignment(String userId,
                                  String assetGUID,
                                  String glossaryTermGUID,
                                  String assetElementGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).

Specified by:

addSemanticAssignment in interface AssetClassificationInterface

Parameters:

userId - calling user

assetGUID - unique identifier of asset

glossaryTermGUID - unique identifier of the glossary term

assetElementGUID - element to link it to - its type must inherit from Referenceable. If null then the assetGUID is used.

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeSemanticAssignment

public void removeSemanticAssignment(String userId,
                                     String assetGUID,
                                     String glossaryTermGUID,
                                     String assetElementGUID)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).

Specified by:

removeSemanticAssignment in interface AssetClassificationInterface

Parameters:

userId - calling user

assetGUID - unique identifier of asset

glossaryTermGUID - unique identifier of the glossary term

assetElementGUID - element to link it to - its type must inherit from Referenceable. If null then the assetGUID is used.

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addAssetOrigin

public void addAssetOrigin(String userId,
                           String assetGUID,
                           String organizationGUID,
                           String businessCapabilityGUID,
                           Map<String,String> otherOriginValues)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Add the asset origin classification to an asset.

Specified by:

addAssetOrigin in interface AssetClassificationInterface

Parameters:

userId - calling user

assetGUID - unique identifier of asset

organizationGUID - Unique identifier (GUID) of the organization where this asset originated from - or null

businessCapabilityGUID - Unique identifier (GUID) of the business capability where this asset originated from.

otherOriginValues - Descriptive labels describing origin of the asset

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeAssetOrigin

public void removeAssetOrigin(String userId,
                              String assetGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Remove the asset origin classification to an asset.

Specified by:

removeAssetOrigin in interface AssetClassificationInterface

Parameters:

userId - calling user

assetGUID - unique identifier of asset

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addSecurityTags

public void addSecurityTags(String userId,
                            String assetGUID,
                            String assetElementGUID,
                            List<String> securityLabels,
                            Map<String,Object> securityProperties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Add or replace the security tags for an asset or one of its elements.

Specified by:

addSecurityTags in interface AssetClassificationInterface

Parameters:

userId - calling user

assetGUID - unique identifier of asset

assetElementGUID - element to link it to - its type must inherit from Referenceable. If null then the assetGUID is used.

securityLabels - list of security labels defining the security characteristics of the element

securityProperties - Descriptive labels describing origin of the asset

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeSecurityTags

public void removeSecurityTags(String userId,
                               String assetGUID,
                               String assetElementGUID)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Remove the security tags classification to an asset or one of its elements.

Specified by:

removeSecurityTags in interface AssetClassificationInterface

Parameters:

userId - calling user

assetGUID - unique identifier of asset

assetElementGUID - element where the security tags need to be removed. If null then the assetGUID is used.

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateAssetZones

public void updateAssetZones(String userId,
                             String assetGUID,
                             List<String> assetZones)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Update the zones for a specific asset.

Specified by:

updateAssetZones in interface AssetClassificationInterface

Parameters:

userId - calling user

assetGUID - unique identifier for the asset to update

assetZones - list of zones for the asset - these values override the current values - null means belongs to no zones.

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateAssetOwner

public void updateAssetOwner(String userId,
                             String assetGUID,
                             String ownerId,
                             OwnerType ownerType)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Update the owner information for a specific asset.

Specified by:

updateAssetOwner in interface AssetClassificationInterface

Parameters:

userId - calling user

assetGUID - unique identifier for the asset to update

ownerId - userId or profileGUID of the owner - or null to clear the field

ownerType - indicator of the type of Id provides above - or null to clear the field

Throws:

InvalidParameterException - userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getAssetsByName

public List<Asset> getAssetsByName(String userId,
                                   String name,
                                   int startFrom,
                                   int pageSize)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Return a list of assets with the requested name.

Specified by:

getAssetsByName in interface AssetReviewInterface

Parameters:

userId - calling user

name - name to search for

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

list of unique identifiers of assets with matching name.

Throws:

InvalidParameterException - the name is invalid

PropertyServerException - there is a problem access in the property server

UserNotAuthorizedException - the user does not have access to the properties

findAssets

public List<Asset> findAssets(String userId,
                              String searchString,
                              int startFrom,
                              int pageSize)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Return a list of assets with the requested search string in their name, qualified name or description.

Specified by:

findAssets in interface AssetReviewInterface

Parameters:

userId - calling user

searchString - string to search for in text

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

list of assets that match the search string.

Throws:

InvalidParameterException - the searchString is invalid

PropertyServerException - there is a problem access in the property server

UserNotAuthorizedException - the user does not have access to the properties

getAssetSummary

public Asset getAssetSummary(String userId,
                             String assetGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Return the basic attributes of an asset.

Specified by:

getAssetSummary in interface AssetReviewInterface

Parameters:

userId - calling user

assetGUID - unique identifier of the asset

Returns:

basic asset properties

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getAssetProperties

public AssetUniverse getAssetProperties(String userId,
                                        String assetGUID)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException

Returns a comprehensive collection of properties about the requested asset.

Specified by:

getAssetProperties in interface AssetReviewInterface

Parameters:

userId - userId of user making request.

assetGUID - unique identifier for asset.

Returns:

a comprehensive collection of properties about the asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving the asset properties from the property servers).

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

getConnectorToAsset

public Connector getConnectorToAsset(String userId,
                                     String assetGUID)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Return a connector for the asset to enable the calling user to access the content.

Specified by:

getConnectorToAsset in interface AssetReviewInterface

Parameters:

userId - calling user

assetGUID - unique identifier of the asset

Returns:

connector object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getDiscoveryAnalysisReports

public List<DiscoveryAnalysisReport> getDiscoveryAnalysisReports(String userId,
                                                                 String assetGUID,
                                                                 int startingFrom,
                                                                 int maximumResults)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException

Return the discovery analysis reports about the asset.

Specified by:

getDiscoveryAnalysisReports in interface AssetReviewInterface

Parameters:

userId - calling user

assetGUID - unique identifier of the asset

startingFrom - position in the list (used when there are so many reports that paging is needed

maximumResults - maximum number of elements to return an this call

Returns:

list of discovery analysis reports

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getDiscoveryReportAnnotations

public List<Annotation> getDiscoveryReportAnnotations(String userId,
                                                      String discoveryReportGUID,
                                                      AnnotationStatus annotationStatus,
                                                      int startingFrom,
                                                      int maximumResults)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Return the annotations linked directly to the report.

Specified by:

getDiscoveryReportAnnotations in interface AssetReviewInterface

Parameters:

userId - identifier of calling user

discoveryReportGUID - identifier of the discovery request.

annotationStatus - status of the desired annotations - null means all statuses.

startingFrom - initial position in the stored list.

maximumResults - maximum number of definitions to return on this call.

Returns:

list of annotations

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getExtendedAnnotations

public List<Annotation> getExtendedAnnotations(String userId,
                                               String annotationGUID,
                                               AnnotationStatus annotationStatus,
                                               int startingFrom,
                                               int maximumResults)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Return any annotations attached to this annotation.

Specified by:

getExtendedAnnotations in interface AssetReviewInterface

Parameters:

userId - identifier of calling user

annotationGUID - anchor annotation

annotationStatus - status of the desired annotations - null means all statuses.

startingFrom - starting position in the list

maximumResults - maximum number of annotations that can be returned.

Returns:

list of Annotation objects

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

deleteAsset

public void deleteAsset(String userId,
                        String assetGUID)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Deletes an asset and all of its associated elements such as schema, connections (unless they are linked to another asset), discovery reports and associated feedback. Given the depth of the delete performed by this call, it should be used with care.

Specified by:

deleteAsset in interface AssetDecommissioningInterface

Parameters:

userId - calling user

assetGUID - unique identifier of the attest to attach the connection to

Throws:

InvalidParameterException - full path or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem