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

Class GovernanceDomainsResource

java.lang.Object

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

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

GovernanceDomainsResource sets up the governance domains that are part of an organization governance. Each governance domain describes a focus for governance.

Constructor Summary

Constructors

Constructor	Description
GovernanceDomainsResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	addDomainToSet(String serverName, String userId, String governanceDomainSetGUID, String governanceDomainGUID, RelationshipRequestBody requestBody)	Create a parent-child relationship between a governance domain set and a governance domain.
GUIDResponse	createGovernanceDomain(String serverName, String userId, ReferenceableRequestBody requestBody)	Create a new metadata element to represent a governance domain.
GUIDResponse	createGovernanceDomainSet(String serverName, String userId, ReferenceableRequestBody requestBody)	Create a new metadata element to represent the root of a Governance Domain Set.
VoidResponse	deleteGovernanceDomain(String serverName, String userId, String governanceDomainGUID, ExternalSourceRequestBody requestBody)	Remove the metadata element representing a Governance Domain.
GovernanceDomainListResponse	findGovernanceDomains(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)	Retrieve the list of Governance Domain metadata elements that contain the search string.
GovernanceDomainSetListResponse	findGovernanceDomainSets(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)	Retrieve the list of governanceDomainSet metadata elements that contain the search string.
GovernanceDomainResponse	getGovernanceDomainByGUID(String serverName, String userId, String governanceDomainGUID)	Retrieve the Governance Domain metadata element with the supplied unique identifier assigned when the domain description was stored in the metadata repository.
GovernanceDomainResponse	getGovernanceDomainByIdentifier(String serverName, String userId, int domainIdentifier)	Retrieve the Governance Domain metadata element with the supplied domain identifier.
GovernanceDomainListResponse	getGovernanceDomains(String serverName, String userId, int startFrom, int pageSize)	Retrieve the list of Governance Domain metadata elements defined for the governance program.
GovernanceDomainListResponse	getGovernanceDomainsByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody)	Retrieve the list of Governance Domain metadata elements with a matching qualified or display name.
GovernanceDomainSetResponse	getGovernanceDomainSetByGUID(String serverName, String userId, String governanceDomainSetGUID)	Retrieve the governanceDomainSet metadata element with the supplied unique identifier.
GovernanceDomainSetListResponse	getGovernanceDomainSetsByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody)	Retrieve the list of governanceDomainSet metadata elements with a matching qualified or display name.
GovernanceDomainSetListResponse	getSetsForGovernanceDomain(String serverName, String userId, String governanceDomainGUID, int startFrom, int pageSize)	Return the list of governance domain sets that a governance domain belong.
VoidResponse	removeDomainFromSet(String serverName, String userId, String governanceDomainSetGUID, String governanceDomainGUID, RelationshipRequestBody requestBody)	Remove a parent-child relationship between a governance domain set and a governance domain.
VoidResponse	removeGovernanceDomainSet(String serverName, String userId, String governanceDomainSetGUID, ExternalSourceRequestBody requestBody)	Remove the metadata element representing a governanceDomainSet.
VoidResponse	updateGovernanceDomain(String serverName, String userId, String governanceDomainGUID, ReferenceableRequestBody requestBody)	Update the metadata element representing a Governance Domain.
VoidResponse	updateGovernanceDomainSet(String serverName, String userId, String governanceDomainSetGUID, ReferenceableRequestBody requestBody)	Update the metadata element representing a Governance Domain Set.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceDomainsResource

public GovernanceDomainsResource()

Default constructor

Method Detail

createGovernanceDomainSet

@PostMapping(path="/governance-domain-sets")
public GUIDResponse createGovernanceDomainSet(@PathVariable
                                              String serverName,
                                              @PathVariable
                                              String userId,
                                              @RequestBody
                                              ReferenceableRequestBody requestBody)

Create a new metadata element to represent the root of a Governance Domain Set.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

requestBody - properties to store

Returns:

unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

updateGovernanceDomainSet

@PostMapping(path="/governance-domain-sets/{governanceDomainSetGUID}/update")
public VoidResponse updateGovernanceDomainSet(@PathVariable
                                              String serverName,
                                              @PathVariable
                                              String userId,
                                              @PathVariable
                                              String governanceDomainSetGUID,
                                              @RequestBody
                                              ReferenceableRequestBody requestBody)

Update the metadata element representing a Governance Domain Set.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

governanceDomainSetGUID - unique identifier of the metadata element to remove

requestBody - new properties for this element

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

removeGovernanceDomainSet

@PostMapping(path="/governance-domain-sets/{governanceDomainSetGUID}/delete")
public VoidResponse removeGovernanceDomainSet(@PathVariable
                                              String serverName,
                                              @PathVariable
                                              String userId,
                                              @PathVariable
                                              String governanceDomainSetGUID,
                                              @RequestBody(required=false)
                                              ExternalSourceRequestBody requestBody)

Remove the metadata element representing a governanceDomainSet. The governance domains are not deleted.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

governanceDomainSetGUID - unique identifier of the metadata element to remove

requestBody - external source request body

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

findGovernanceDomainSets

@PostMapping(path="/governance-domain-sets/by-search-string")
public GovernanceDomainSetListResponse findGovernanceDomainSets(@PathVariable
                                                                String serverName,
                                                                @PathVariable
                                                                String userId,
                                                                @RequestParam
                                                                int startFrom,
                                                                @RequestParam
                                                                int pageSize,
                                                                @RequestBody
                                                                SearchStringRequestBody requestBody)

Retrieve the list of governanceDomainSet metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

requestBody - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGovernanceDomainSetsByName

@PostMapping(path="/governance-domain-sets/by-name")
public GovernanceDomainSetListResponse getGovernanceDomainSetsByName(@PathVariable
                                                                     String serverName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @RequestParam
                                                                     int startFrom,
                                                                     @RequestParam
                                                                     int pageSize,
                                                                     @RequestBody
                                                                     NameRequestBody requestBody)

Retrieve the list of governanceDomainSet metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - name to search for

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGovernanceDomainSetByGUID

@GetMapping(path="/governance-domain-sets/{governanceDomainSetGUID}")
public GovernanceDomainSetResponse getGovernanceDomainSetByGUID(@PathVariable
                                                                String serverName,
                                                                @PathVariable
                                                                String userId,
                                                                @PathVariable
                                                                String governanceDomainSetGUID)

Retrieve the governanceDomainSet metadata element with the supplied unique identifier.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

governanceDomainSetGUID - unique identifier of the requested metadata element

Returns:

matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

createGovernanceDomain

@PostMapping(path="/governance-domain-sets/governance-domains")
public GUIDResponse createGovernanceDomain(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @RequestBody
                                           ReferenceableRequestBody requestBody)

Create a new metadata element to represent a governance domain.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

requestBody - properties about the Governance Domain to store

Returns:

unique identifier of the new Governance Domain or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

updateGovernanceDomain

@PostMapping(path="/governance-domains/{governanceDomainGUID}/update")
public VoidResponse updateGovernanceDomain(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String governanceDomainGUID,
                                           @RequestBody
                                           ReferenceableRequestBody requestBody)

Update the metadata element representing a Governance Domain.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

governanceDomainGUID - unique identifier of the metadata element to update

requestBody - new properties for the metadata element

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

deleteGovernanceDomain

@PostMapping(path="/governance-domains/{governanceDomainGUID}/delete")
public VoidResponse deleteGovernanceDomain(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String governanceDomainGUID,
                                           @RequestBody(required=false)
                                           ExternalSourceRequestBody requestBody)

Remove the metadata element representing a Governance Domain.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

governanceDomainGUID - unique identifier of the metadata element to remove

requestBody - external source request body

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

addDomainToSet

@PostMapping(path="/governance-domain-sets/{governanceDomainSetGUID}/governance-domains/{governanceDomainGUID}")
public VoidResponse addDomainToSet(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @PathVariable
                                   String governanceDomainSetGUID,
                                   @PathVariable
                                   String governanceDomainGUID,
                                   @RequestBody(required=false)
                                   RelationshipRequestBody requestBody)

Create a parent-child relationship between a governance domain set and a governance domain.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

governanceDomainSetGUID - unique identifier of the governance domain set

governanceDomainGUID - unique identifier of the governance domain

requestBody - relationship request body

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

removeDomainFromSet

@PostMapping(path="/governance-domain-sets/{governanceDomainSetGUID}/governance-domains/{governanceDomainGUID}/delete")
public VoidResponse removeDomainFromSet(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @PathVariable
                                        String governanceDomainSetGUID,
                                        @PathVariable
                                        String governanceDomainGUID,
                                        @RequestBody(required=false)
                                        RelationshipRequestBody requestBody)

Remove a parent-child relationship between a governance domain set and a governance domain.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

governanceDomainSetGUID - unique identifier of the governance domain set

governanceDomainGUID - unique identifier of the governance domain

requestBody - relationship request body

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGovernanceDomains

@GetMapping(path="/governance-domains")
public GovernanceDomainListResponse getGovernanceDomains(@PathVariable
                                                         String serverName,
                                                         @PathVariable
                                                         String userId,
                                                         @RequestParam
                                                         int startFrom,
                                                         @RequestParam
                                                         int pageSize)

Retrieve the list of Governance Domain metadata elements defined for the governance program.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

findGovernanceDomains

@PostMapping(path="/governance-domain/by-search-string")
public GovernanceDomainListResponse findGovernanceDomains(@PathVariable
                                                          String serverName,
                                                          @PathVariable
                                                          String userId,
                                                          @RequestParam
                                                          int startFrom,
                                                          @RequestParam
                                                          int pageSize,
                                                          @RequestBody
                                                          SearchStringRequestBody requestBody)

Retrieve the list of Governance Domain metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getSetsForGovernanceDomain

@GetMapping(path="/governance-domain-sets/by-governance-domains/{governanceDomainGUID}")
public GovernanceDomainSetListResponse getSetsForGovernanceDomain(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String governanceDomainGUID,
                                                                  @RequestParam
                                                                  int startFrom,
                                                                  @RequestParam
                                                                  int pageSize)

Return the list of governance domain sets that a governance domain belong.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

governanceDomainGUID - unique identifier of the governance domain to query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of metadata elements describing the sets associated with the requested governanceDomainSet or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGovernanceDomainsByName

@PostMapping(path="/governance-domain/by-name")
public GovernanceDomainListResponse getGovernanceDomainsByName(@PathVariable
                                                               String serverName,
                                                               @PathVariable
                                                               String userId,
                                                               @RequestParam
                                                               int startFrom,
                                                               @RequestParam
                                                               int pageSize,
                                                               @RequestBody
                                                               NameRequestBody requestBody)

Retrieve the list of Governance Domain metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - name to search for

Returns:

list of matching metadata elements InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGovernanceDomainByGUID

@GetMapping(path="/governance-domains/{governanceDomainGUID}")
public GovernanceDomainResponse getGovernanceDomainByGUID(@PathVariable
                                                          String serverName,
                                                          @PathVariable
                                                          String userId,
                                                          @PathVariable
                                                          String governanceDomainGUID)

Retrieve the Governance Domain metadata element with the supplied unique identifier assigned when the domain description was stored in the metadata repository.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

governanceDomainGUID - unique identifier of the requested metadata element

Returns:

requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGovernanceDomainByIdentifier

@GetMapping(path="/governance-domains/by-identifier/{domainIdentifier}")
public GovernanceDomainResponse getGovernanceDomainByIdentifier(@PathVariable
                                                                String serverName,
                                                                @PathVariable
                                                                String userId,
                                                                @PathVariable
                                                                int domainIdentifier)

Retrieve the Governance Domain metadata element with the supplied domain identifier.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

domainIdentifier - identifier used to identify the domain

Returns:

requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)