org.odpi.openmetadata.accessservices.governanceengine.server.spring

Class GovernanceEngineOMASResource

java.lang.Object

org.odpi.openmetadata.accessservices.governanceengine.server.spring.GovernanceEngineOMASResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/governance-engine/users/{userId}")
public class GovernanceEngineOMASResource
extends Object

Constructor Summary

Constructors

Constructor and Description
GovernanceEngineOMASResource()

Method Summary

Modifier and Type	Method and Description
org.odpi.openmetadata.accessservices.governanceengine.api.objects.GovernanceClassificationDefListAPIResponse	getGovernanceClassificationDefs(String serverName, String userId, List<String> classification) Returns the list of governance tags for the enforcement engine
org.odpi.openmetadata.accessservices.governanceengine.api.objects.GovernedAssetAPIResponse	getGovernedAsset(String serverName, String userId, String assetGuid) Returns a single governed asset

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceEngineOMASResource

public GovernanceEngineOMASResource()

Method Detail

getGovernanceClassificationDefs

@RequestMapping(method=GET,
                path="/classificationdefs")
public org.odpi.openmetadata.accessservices.governanceengine.api.objects.GovernanceClassificationDefListAPIResponse getGovernanceClassificationDefs(@PathVariable
                                                                                                                                                                                                                            String serverName,
                                                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                                                            String userId,
                                                                                                                                                                                                                            @RequestParam(value="classification",required=false)
                                                                                                                                                                                                                            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.

getGovernedAsset

@RequestMapping(method=GET,
                path="/assets/{assetGuid}")
public org.odpi.openmetadata.accessservices.governanceengine.api.objects.GovernedAssetAPIResponse getGovernedAsset(@PathVariable
                                                                                                                                                                                           String serverName,
                                                                                                                                                                                           @PathVariable
                                                                                                                                                                                           String userId,
                                                                                                                                                                                           @PathVariable
                                                                                                                                                                                           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.