org.odpi.openmetadata.accessservices.governanceengine.server

Class GovernanceEngineRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.governanceengine.server.GovernanceEngineRESTServices

public class GovernanceEngineRESTServices
extends Object

The GovernanceEngineRESTServices provides the handlers-side implementation of the GovernanceEngine Open Metadata Access Service (OMAS).

This package deals with supporting the REST API from within the OMAG Server

Governance engines such as Apache Ranger are interested in the classification of resources that they provide access to. They are unlikely to be interested in all the nitty gritty properties of that resource, only knowing that it is PI or SPI and perhaps masking or preventing access.

They tend to use this information in two ways - At policy authoring time - where knowing what tags are available is interesting to help in that definition process - At data access time - where we need to know if resource X is protected in some way due to it's metadata ie classification

Initially this OMAS client will provide information on those - classifiers - we'll call them 'tags' here - Managed assets - those resources - and in effect any tags associated with them. Details on the assets themselves are better supported through the AssetConsumer OMAS API, and additionally the governance engine is not interested currently in HOW the assets get classified - ie through the association of a classification directly to an asset, or via business terms, so effectively flatten this

The result is a fairly simple object being made available to the engine, which will evolve as work is done on enhancing the interaction (for example capturing information back from the engine), and as we interconnect with new governance engines

Constructor Summary

Constructors

Constructor and Description
GovernanceEngineRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
GovernanceClassificationDefAPIResponse	getClassificationDefs(String userId, String classificationGuid) Returns a single governance tag for the enforcement engine
GovernanceClassificationDefListAPIResponse	getGovernanceClassificationDefs(String userId, List<String> classification) Returns the list of governance tags for the enforcement engine
GovernedAssetAPIResponse	getGovernedAsset(String userId, String assetGuid) Returns a single governed asset
GovernedAssetListAPIResponse	getGovernedAssets(String userId, List<String> classification, List<String> type) Returns the list of governed asset
static void	setRepositoryConnector(String accessServiceName, OMRSRepositoryConnector repositoryConnector) Provide a connector to the REST Services.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceEngineRESTServices

public GovernanceEngineRESTServices()

Default constructor

Method Detail

setRepositoryConnector

public static void setRepositoryConnector(String accessServiceName,
                                          OMRSRepositoryConnector repositoryConnector)

Provide a connector to the REST Services.

Parameters:

accessServiceName - - name of this access service

repositoryConnector - - OMRS Repository Connector to the property handlers.

getGovernanceClassificationDefs

public GovernanceClassificationDefListAPIResponse getGovernanceClassificationDefs(String userId,
                                                                                  List<String> classification)

Returns the list of governance tags for the enforcement engine

These are the definitions - so tell us the name, guid, attributes associated with the tag. The security engine will want to know about these tags to assist in policy authoring/validation, as well as know when they change, since any existing assets classified with the tags are affected

Parameters:

userId - - String - userId of user making request.

classification - - this may be the qualifiedName or displayName of the connection.

Returns:

GovernanceClassificationDefinitionList or InvalidParameterException - one of the parameters is null or invalid. UnrecognizedConnectionNameException - there is no connection defined for this name. AmbiguousConnectionNameException - there is more than one connection defined for this name. PropertyServerException - there is a problem retrieving information from the property (metadata) handlers. UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getClassificationDefs

public GovernanceClassificationDefAPIResponse getClassificationDefs(String userId,
                                                                    String classificationGuid)

Returns a single governance tag for the enforcement engine

These are the definitions - so tell us the name, guid, attributes associated with the tag. The security engine will want to know about these tags to assist in policy authoring/validation, as well as know when they change, since any existing assets classified with the tags are affected

Parameters:

userId - - String - userId of user making request.

classificationGuid - - guid of the definition to retrieve

Returns:

GovernanceClassificationDef or InvalidParameterException - one of the parameters is null or invalid. UnrecognizedConnectionNameException - there is no connection defined for this name. AmbiguousConnectionNameException - there is more than one connection defined for this name. PropertyServerException - there is a problem retrieving information from the property (metadata) handlers. UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getGovernedAssets

public GovernedAssetListAPIResponse getGovernedAssets(String userId,
                                                      List<String> classification,
                                                      List<String> type)

Returns the list of governed asset

These include the tag associations but not the definitions of those tags

Parameters:

userId - - String - userId of user making request.

classification - - this may be the qualifiedName or displayName of the connection.

type - types to start query from

Returns:

GovernedAssetComponentList or InvalidParameterException - one of the parameters is null or invalid. UnrecognizedConnectionNameException - there is no connection defined for this name. AmbiguousConnectionNameException - there is more than one connection defined for this name. PropertyServerException - there is a problem retrieving information from the property (metadata) handlers. UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getGovernedAsset

public GovernedAssetAPIResponse getGovernedAsset(String userId,
                                                 String assetGuid)

Returns a single governed asset

These include the tag associations but not the definitions of those tags

Parameters:

userId - - String - userId of user making request.

assetGuid - - Guid of the asset component to retrieve

Returns:

GovernedAsset or InvalidParameterException - one of the parameters is null or invalid. UnrecognizedConnectionNameException - there is no connection defined for this name. AmbiguousConnectionNameException - there is more than one connection defined for this name. PropertyServerException - there is a problem retrieving information from the property (metadata) handlers. UserNotAuthorizedException - the requesting user is not authorized to issue this request.