org.odpi.openmetadata.accessservices.governanceengine.client

Interface GovernanceEngineClient

All Known Implementing Classes:

GovernanceEngineImpl

public interface GovernanceEngineClient

The Governance Engine Open Metadata Access Service (OMAS) is used by enforcement engines to retrieve asset and classification information in a suitable form for implementing policies This OMAS is mostly concerned with: - A Classification Definition - this tells us what the classification type is, what parms it may have - and can be useful for authoring and validation - An asset , or part (hence we call it an asset component) that has a classification Furthermore in order to scope queries we restrict by - root classification - the node in the classification tree of where we are interested (for example all governance classifications) - root type - the base type that we are interested in

Method Summary

Modifier and Type	Method and Description
GovernanceClassificationDef	getGovernanceClassificationDef(String userId, String classificationGuid)
List<GovernanceClassificationDef>	getGovernanceClassificationDefList(String userId, String classification)
GovernedAsset	getGovernedAsset(String userId, String assetGuid)
List<GovernedAsset>	getGovernedAssetList(String userId, String classification, String type)

Method Detail

getGovernedAssetList

List<GovernedAsset> getGovernedAssetList(String userId,
                                         String classification,
                                         String type)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         ClassificationNotFoundException,
                                         MetadataServerException,
                                         TypeNotFoundException

Parameters:

userId - - String - userId of user making request.

classification - - String - name of base classification type (can be null)

type - - String - root type of asset (can be null)

Returns:

AssetTagMap - map of classification

Throws:

InvalidParameterException - - one of the parameters is null or invalid.

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

ClassificationNotFoundException - - the classification to scope search is not found

TypeNotFoundException - - the classification to scope search is not found

MetadataServerException - - A failure occurred communicating with the metadata repository

getGovernedAsset

GovernedAsset getGovernedAsset(String userId,
                               String assetGuid)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               MetadataServerException,
                               GuidNotFoundException

Parameters:

userId - - String - userId of user making request.

assetGuid - - String - guid of asset component

Returns:

AssetTagMap - map of classification

Throws:

InvalidParameterException - - one of the parameters is null or invalid.

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

MetadataServerException - - A failure occurred communicating with the metadata repository

GuidNotFoundException - - the guid is not found

getGovernanceClassificationDefList

List<GovernanceClassificationDef> getGovernanceClassificationDefList(String userId,
                                                                     String classification)
                                                              throws InvalidParameterException,
                                                                     UserNotAuthorizedException,
                                                                     ClassificationNotFoundException,
                                                                     MetadataServerException

Parameters:

userId - - String - userId of user making request.

classification - - String - name of base classification type

Returns:

AssetTagDefinitions - Tag definitions

Throws:

InvalidParameterException - - one of the parameters is null or invalid.

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

MetadataServerException - - A failure occurred communicating with the metadata repository

ClassificationNotFoundException - - the classification to scope search is not found

getGovernanceClassificationDef

GovernanceClassificationDef getGovernanceClassificationDef(String userId,
                                                           String classificationGuid)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           MetadataServerException,
                                                           GuidNotFoundException

Parameters:

userId - - String - userId of user making request.

classificationGuid - - String - classification guid

Returns:

AssetTagDefinitions - Tag definitions

Throws:

InvalidParameterException - - one of the parameters is null or invalid.

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

MetadataServerException - - A failure occurred communicating with the metadata repository

GuidNotFoundException - - the guid is not found