Package org.odpi.openmetadata.viewservices.securityofficer.server.spring

Class SecurityOfficerResource

java.lang.Object

org.odpi.openmetadata.viewservices.securityofficer.server.spring.SecurityOfficerResource

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/security-officer")
public class SecurityOfficerResource
extends Object

The SecurityOfficerResource provides part of the server-side implementation of the Security Officer OMVS. =

Constructor Summary

Constructors

Constructor	Description
SecurityOfficerResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	detachGovernanceZones(String serverName, String parentGovernanceZoneGUID, String memberDataFieldGUID, DeleteRelationshipRequestBody requestBody)	Detach a governance zone definition from a hierarchical relationship.
VoidResponse	linkGovernanceZones(String serverName, String governanceZoneGUID, String nestedGovernanceZoneGUID, NewRelationshipRequestBody requestBody)	Attach a nested governance zone to a broader governance zone definition.

Methods inherited from class java.lang.Object

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

Constructor Details

SecurityOfficerResource

public SecurityOfficerResource()

Default constructor

Method Details

linkGovernanceZones

@PostMapping(path="/governance-zones/{governanceZoneGUID}/governance-zone-hierarchies/{nestedGovernanceZoneGUID}/attach")
public VoidResponse linkGovernanceZones(@PathVariable
 String serverName,
 @PathVariable
 String governanceZoneGUID,
 @PathVariable
 String nestedGovernanceZoneGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a nested governance zone to a broader governance zone definition.

Parameters:

serverName - name of called server

governanceZoneGUID - unique identifier of the first governance zone definition

nestedGovernanceZoneGUID - unique identifier of the second governance zone definition

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachGovernanceZones

@PostMapping(path="/governance-zones/{parentGovernanceZoneGUID}/governance-zone-hierarchies/{memberDataFieldGUID}/detach")
public VoidResponse detachGovernanceZones(@PathVariable
 String serverName,
 @PathVariable
 String parentGovernanceZoneGUID,
 @PathVariable
 String memberDataFieldGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a governance zone definition from a hierarchical relationship.

Parameters:

serverName - name of called server

parentGovernanceZoneGUID - unique identifier of the first governance zone definition

memberDataFieldGUID - unique identifier of the second governance zone definition

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.