org.odpi.openmetadata.accessservices.assetowner.server

Class AssetOwnerRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.assetowner.server.AssetOwnerRESTServices

public class AssetOwnerRESTServices
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
AssetOwnerRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	addAssetOrigin(String serverName, String userId, String assetGUID, OriginRequestBody requestBody) Set up the labels that classify an asset's origin.
GUIDResponse	addAssetToCatalog(String serverName, String userId, String typeName, AssetRequestBody requestBody) Add a simple asset description to the catalog.
VoidResponse	addConnectionToAsset(String serverName, String userId, String assetGUID, ConnectionRequestBody requestBody) Adds a connection to an asset.
VoidResponse	addSchemaAttributesToSchema(String serverName, String userId, String schemaTypeGUID, List<SchemaAttribute> requestBody) Adds attributes to a complex schema type like a relational table or a structured document.
GUIDResponse	addSchemaToAsset(String serverName, String userId, String assetGUID, SchemaRequestBody requestBody) Links the supplied schema to the asset.
VoidResponse	addSemanticAssignment(String serverName, String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID, NullRequestBody requestBody) Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).
VoidResponse	createGovernanceZone(String serverName, String userId, ZoneRequestBody requestBody) Create a definition of a governance zone.
VoidResponse	deleteAsset(String serverName, String userId, String assetGUID, NullRequestBody requestBody) 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.
AssetsResponse	findAssets(String serverName, 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.
AssetsResponse	getAssetsByName(String serverName, String userId, String name, int startFrom, int pageSize) Return a list of assets with the requested name.
DiscoveryAnalysisReportListResponse	getDiscoveryAnalysisReports(String serverName, String userId, String assetGUID, int startingFrom, int maxPageSize) Return the discovery analysis reports about the asset.
AnnotationListResponse	getDiscoveryReportAnnotations(String serverName, String userId, String discoveryReportGUID, int startingFrom, int maximumResults, StatusRequestBody requestBody) Return the annotations linked directly to the report.
AnnotationListResponse	getExtendedAnnotations(String serverName, String userId, String annotationGUID, int startingFrom, int maximumResults, StatusRequestBody requestBody) Return any annotations attached to this annotation.
ZoneResponse	getGovernanceZone(String serverName, String userId, String qualifiedName) Return information about a specific governance zone.
ZoneListResponse	getGovernanceZones(String serverName, String userId, int startingFrom, int maximumResults) Return information about all of the governance zones.
VoidResponse	updateAssetOwner(String serverName, String userId, String assetGUID, OwnerRequestBody requestBody) Update the owner information for a specific asset.
VoidResponse	updateAssetZones(String serverName, String userId, String assetGUID, List<String> assetZones) Update the zones for a specific asset.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetOwnerRESTServices

public AssetOwnerRESTServices()

Default constructor

Method Detail

addAssetToCatalog

public GUIDResponse addAssetToCatalog(String serverName,
                                      String userId,
                                      String typeName,
                                      AssetRequestBody requestBody)

Add a simple asset description to the catalog.

Parameters:

serverName - name of the server instance to connect to

userId - calling user (assumed to be the owner)

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

requestBody - other properties for asset

Returns:

unique identifier (guid) of the asset or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSchemaToAsset

public GUIDResponse addSchemaToAsset(String serverName,
                                     String userId,
                                     String assetGUID,
                                     SchemaRequestBody requestBody)

Links the supplied schema to the asset. If the schema is not defined in the metadata repository, it is created.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

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

requestBody - schema to attach - a new schema is always created because schema can not be shared between assets.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSchemaAttributesToSchema

public VoidResponse addSchemaAttributesToSchema(String serverName,
                                                String userId,
                                                String schemaTypeGUID,
                                                List<SchemaAttribute> requestBody)

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.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

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

requestBody - list of schema attribute objects.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addConnectionToAsset

public VoidResponse addConnectionToAsset(String serverName,
                                         String userId,
                                         String assetGUID,
                                         ConnectionRequestBody requestBody)

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

Parameters:

serverName - name of the server instance to connect to

userId - calling user

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

requestBody - request body including a summary and connection object. If the connection is already stored (matching guid) then the existing connection is used.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSemanticAssignment

public VoidResponse addSemanticAssignment(String serverName,
                                          String userId,
                                          String assetGUID,
                                          String glossaryTermGUID,
                                          String assetElementGUID,
                                          NullRequestBody requestBody)

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

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset that is being described

glossaryTermGUID - unique identifier of the glossary term

assetElementGUID - element to link it to - its type must inherit from Referenceable.

requestBody - null request body to satisfy POST request.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addAssetOrigin

public VoidResponse addAssetOrigin(String serverName,
                                   String userId,
                                   String assetGUID,
                                   OriginRequestBody requestBody)

Set up the labels that classify an asset's origin.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of asset

requestBody - Descriptive labels describing origin of the asset

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

createGovernanceZone

public VoidResponse createGovernanceZone(String serverName,
                                         String userId,
                                         ZoneRequestBody requestBody)

Create a definition of a governance zone. The qualified name of these governance zones can be added to the supportedZones and defaultZones properties of an OMAS to control which assets are processed and how they are set up. In addition the qualified names of zones can be added to Asset definitions to indicate which zone(s) they belong to.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

requestBody - other properties for a governance zone

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getGovernanceZones

public ZoneListResponse getGovernanceZones(String serverName,
                                           String userId,
                                           int startingFrom,
                                           int maximumResults)

Return information about all of the governance zones.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

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:

properties of the governance zone or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getGovernanceZone

public ZoneResponse getGovernanceZone(String serverName,
                                      String userId,
                                      String qualifiedName)

Return information about a specific governance zone.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

qualifiedName - unique name for the zone

Returns:

properties of the governance zone or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

updateAssetZones

public VoidResponse updateAssetZones(String serverName,
                                     String userId,
                                     String assetGUID,
                                     List<String> assetZones)

Update the zones for a specific asset.

Parameters:

serverName - name of the server instance to connect to

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.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

updateAssetOwner

public VoidResponse updateAssetOwner(String serverName,
                                     String userId,
                                     String assetGUID,
                                     OwnerRequestBody requestBody)

Update the owner information for a specific asset.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier for the asset to update

requestBody - values describing the new owner

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getAssetsByName

public AssetsResponse getAssetsByName(String serverName,
                                      String userId,
                                      String name,
                                      int startFrom,
                                      int pageSize)

Return a list of assets with the requested name.

Parameters:

serverName - name of the server instances for this request

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 Asset summaries or InvalidParameterException the name is invalid or PropertyServerException there is a problem access in the property server or UserNotAuthorizedException the user does not have access to the properties

findAssets

public AssetsResponse findAssets(String serverName,
                                 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.

Parameters:

serverName - name of the server instances for this request

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 or InvalidParameterException the searchString is invalid or PropertyServerException there is a problem access in the property server or UserNotAuthorizedException the user does not have access to the properties

getDiscoveryAnalysisReports

public DiscoveryAnalysisReportListResponse getDiscoveryAnalysisReports(String serverName,
                                                                       String userId,
                                                                       String assetGUID,
                                                                       int startingFrom,
                                                                       int maxPageSize)

Return the discovery analysis reports about the asset.

Parameters:

serverName - name of the server instance to connect to

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

maxPageSize - maximum number of elements to return an this call

Returns:

list of discovery analysis reports or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getDiscoveryReportAnnotations

public AnnotationListResponse getDiscoveryReportAnnotations(String serverName,
                                                            String userId,
                                                            String discoveryReportGUID,
                                                            int startingFrom,
                                                            int maximumResults,
                                                            StatusRequestBody requestBody)

Return the annotations linked directly to the report.

Parameters:

serverName - name of the server instance to connect to

userId - identifier of calling user

discoveryReportGUID - identifier of the discovery request.

startingFrom - initial position in the stored list.

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

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

Returns:

list of annotations or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getExtendedAnnotations

public AnnotationListResponse getExtendedAnnotations(String serverName,
                                                     String userId,
                                                     String annotationGUID,
                                                     int startingFrom,
                                                     int maximumResults,
                                                     StatusRequestBody requestBody)

Return any annotations attached to this annotation.

Parameters:

serverName - name of the server instance to connect to

userId - identifier of calling user

annotationGUID - anchor annotation

startingFrom - starting position in the list

maximumResults - maximum number of annotations that can be returned.

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

Returns:

list of Annotation objects or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

deleteAsset

public VoidResponse deleteAsset(String serverName,
                                String userId,
                                String assetGUID,
                                NullRequestBody requestBody)

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.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

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

requestBody - dummy request body to satisfy POST protocol.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem