org.odpi.openmetadata.accessservices.governanceprogram.server.spring

Class GovernanceZonesResource

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.server.spring.GovernanceZonesResource

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

The GovernanceLeadershipResource provides a Spring based server-side REST API that supports the GovernanceLeadershipInterface. It delegates each request to the GovernanceZoneRESTServices.

Constructor Summary

Constructors

Constructor and Description
GovernanceZonesResource() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	createGovernanceZone(String serverName, String userId, ZoneRequestBody requestBody) Create a definition of a governance zone.
ZoneResponse	getGovernanceZone(String serverName, String userId, String qualifiedName) Return information about a specific governance zone.
ZoneListResponse	getGovernanceZones(String serverName, String userId, int startingFrom, int maximumResults) Return information about all of the governance zones.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceZonesResource

public GovernanceZonesResource()

Default constructor

Method Detail

createGovernanceZone

@PostMapping(path="/governance-zones")
public VoidResponse createGovernanceZone(@PathVariable
                                                                                String serverName,
                                                                                @PathVariable
                                                                                String userId,
                                                                                @RequestBody
                                                                                ZoneRequestBody requestBody)

Create a definition of a governance zone. The qualified name of these governance zones can be added to the supportedZones and defaultZones properties of an OMAS to control which assets are processed and how they are set up. In addition the qualified names of zones can be added to Asset definitions to indicate which zone(s) they belong to.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

requestBody - other properties for a governance zone

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getGovernanceZones

@GetMapping(path="/governance-zones")
public ZoneListResponse getGovernanceZones(@PathVariable
                                                                                 String serverName,
                                                                                 @PathVariable
                                                                                 String userId,
                                                                                 @RequestParam
                                                                                 int startingFrom,
                                                                                 @RequestParam
                                                                                 int maximumResults)

Return information about all of the governance zones.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

startingFrom - position in the list (used when there are so many reports that paging is needed

maximumResults - maximum number of elements to return an this call

Returns:

properties of the governance zone or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getGovernanceZone

@GetMapping(path="/governance-zones/name/{qualifiedName}")
public ZoneResponse getGovernanceZone(@PathVariable
                                                                                                 String serverName,
                                                                                                 @PathVariable
                                                                                                 String userId,
                                                                                                 @PathVariable
                                                                                                 String qualifiedName)

Return information about a specific governance zone.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

qualifiedName - unique name for the zone

Returns:

properties of the governance zone or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem