org.odpi.openmetadata.accessservices.securityofficer.spring

Class GovernedAssetOMASResource

java.lang.Object

org.odpi.openmetadata.accessservices.securityofficer.spring.GovernedAssetOMASResource

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

Constructor Summary

Constructors

Constructor and Description
GovernedAssetOMASResource()

Method Summary

Modifier and Type	Method and Description
StringResponse	createSoftwareServerCapability(String serverName, String userId, SoftwareServerCapabilityRequestBody requestBody) Create a Software Server Capability entity
GovernedAssetResponse	getGovernedAsset(String serverName, String userId, String assetGuid) Returns a single governed asset
GovernedAssetListResponse	getGovernedAssets(String serverName, String userId, List<String> entityTypes, Integer offset, Integer pageSize) Returns the list of governed asset
SoftwareServerCapabilityResponse	getSoftwareServerCapabilityByGUID(String serverName, String userId, String guid) Returns the Software Server Capability entity by global identifier

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernedAssetOMASResource

public GovernedAssetOMASResource()

Method Detail

getGovernedAssets

@GetMapping(path="/assets",
            produces="application/json")
public GovernedAssetListResponse getGovernedAssets(@PathVariable
                                                                                                                        String serverName,
                                                                                                                        @PathVariable
                                                                                                                        String userId,
                                                                                                                        @RequestParam(value="entityTypes",required=false)
                                                                                                                        List<String> entityTypes,
                                                                                                                        @RequestParam(value="offset",required=false)
                                                                                                                        Integer offset,
                                                                                                                        @RequestParam(value="pageSize",required=false)
                                                                                                                        Integer pageSize)

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.

entityTypes - - the type of the entities that are returned

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 offset the property (metadata) handlers. UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getGovernedAsset

@GetMapping(path="/assets/{assetGuid}",
            produces="application/json")
public GovernedAssetResponse 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.

createSoftwareServerCapability

@PostMapping(path="/software-server-capabilities")
public StringResponse createSoftwareServerCapability(@PathVariable(value="serverName")
                                                                                                        String serverName,
                                                                                                        @PathVariable(value="userId")
                                                                                                        String userId,
                                                                                                        @RequestBody
                                                                                                        SoftwareServerCapabilityRequestBody requestBody)

Create a Software Server Capability entity

Parameters:

serverName - - String - the name of server instance to call

userId - - String - userId of user making request.

requestBody - - SoftwareServerCapabilityRequestBody

Returns:

the Software Server entity created

getSoftwareServerCapabilityByGUID

@GetMapping(path="/software-server-capabilities/{guid}")
public SoftwareServerCapabilityResponse getSoftwareServerCapabilityByGUID(@PathVariable
                                                                                                                                   String serverName,
                                                                                                                                   @PathVariable
                                                                                                                                   String userId,
                                                                                                                                   @PathVariable
                                                                                                                                   String guid)

Returns the Software Server Capability entity by global identifier

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

guid - guid of the software server

Returns:

unique identifier of the created process