org.odpi.openmetadata.accessservices.governanceengine.client

Class GovernanceEngineImpl

java.lang.Object

org.odpi.openmetadata.accessservices.governanceengine.client.GovernanceEngineImpl

All Implemented Interfaces:

GovernanceEngineClient

public class GovernanceEngineImpl
extends Object
implements GovernanceEngineClient

The Governance Engine Open Metadata Access Service (OMAS) provides an interface to support a policy engine such as Apache Ranger. See interface definition for more explanation

Constructor Summary

Constructors

Constructor and Description
GovernanceEngineImpl(String newServerURL) Create a new GovernanceEngine client.

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)

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceEngineImpl

public GovernanceEngineImpl(String newServerURL)

Create a new GovernanceEngine client.

Parameters:

newServerURL - - the network address of the handlers running the OMAS REST servers

Method Detail

getGovernedAssetList

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

Specified by:

getGovernedAssetList in interface GovernanceEngineClient

Parameters:

userId - - String - userId of user making request.

classification - - String - name of base classification type

type - - String - root asset type

Returns:

governedAssetList - 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

getGovernanceClassificationDefList

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

Specified by:

getGovernanceClassificationDefList in interface GovernanceEngineClient

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

getGovernedAsset

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

Specified by:

getGovernedAsset in interface GovernanceEngineClient

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

getGovernanceClassificationDef

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

Specified by:

getGovernanceClassificationDef in interface GovernanceEngineClient

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