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

Class GovernanceLeadershipResource

java.lang.Object

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

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

The GovernanceLeadershipResource provides a Spring based server-side REST API that supports the GovernanceLeadershipInterface. It delegates each request to the GovernanceProgramRESTServices. This provides the server-side implementation of the Governance Program Open Metadata Assess Service (OMAS) which is used to manage the full lifecycle of a governance program.

Constructor Summary

Constructors

Constructor and Description
GovernanceLeadershipResource() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	appointGovernanceOfficer(String serverName, String userId, String governanceOfficerGUID, AppointmentRequestBody requestBody) Link a person to a governance officer.
GUIDResponse	createGovernanceOfficer(String serverName, String userId, GovernanceOfficerDetailsRequestBody requestBody) Create the governance officer appointment.
VoidResponse	deleteGovernanceOfficer(String serverName, String userId, String governanceOfficerGUID, GovernanceOfficerValidatorRequestBody requestBody) Remove the requested governance officer.
GovernanceOfficerListResponse	getActiveGovernanceOfficers(String serverName, String userId) Return all of the active governance officers.
GovernanceOfficerResponse	getGovernanceOfficerByAppointmentId(String serverName, String userId, String appointmentId) Retrieve a governance officer by unique appointment id.
GovernanceOfficerResponse	getGovernanceOfficerByGUID(String serverName, String userId, String governanceOfficerGUID) Retrieve a governance officer description by unique guid.
GovernanceOfficerListResponse	getGovernanceOfficers(String serverName, String userId) Return all of the defined governance officers.
GovernanceOfficerListResponse	getGovernanceOfficersByDomain(String serverName, String userId, GovernanceDomainRequestBody requestBody) Return all of the defined governance officers for a specific governance domain.
VoidResponse	relieveGovernanceOfficer(String serverName, String userId, String governanceOfficerGUID, AppointmentRequestBody requestBody) Unlink a person from a governance officer appointment.
VoidResponse	updateGovernanceOfficer(String serverName, String userId, String governanceOfficerGUID, GovernanceOfficerDetailsRequestBody requestBody) Update selected fields for the governance officer.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceLeadershipResource

public GovernanceLeadershipResource()

Default constructor

Method Detail

createGovernanceOfficer

@RequestMapping(method=POST,
                path="/governance-officers")
public GUIDResponse createGovernanceOfficer(@PathVariable
                                                                                                                      String serverName,
                                                                                                                      @PathVariable
                                                                                                                      String userId,
                                                                                                                      @RequestBody
                                                                                                                      GovernanceOfficerDetailsRequestBody requestBody)

Create the governance officer appointment.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

requestBody - properties of the governance officer.

Returns:

Unique identifier (guid) of the governance officer or InvalidParameterException the governance domain or appointment id is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

updateGovernanceOfficer

@RequestMapping(method=POST,
                path="/governance-officers/{governanceOfficerGUID}")
public VoidResponse updateGovernanceOfficer(@PathVariable
                                                                                                                                              String serverName,
                                                                                                                                              @PathVariable
                                                                                                                                              String userId,
                                                                                                                                              @PathVariable
                                                                                                                                              String governanceOfficerGUID,
                                                                                                                                              @RequestBody
                                                                                                                                              GovernanceOfficerDetailsRequestBody requestBody)

Update selected fields for the governance officer.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

requestBody - properties of the governance officer

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer is either null or invalid or InvalidParameterException the title is null or the governanceDomain/appointmentId does not match the the existing values associated with the governanceOfficerGUID or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

deleteGovernanceOfficer

@RequestMapping(method=POST,
                path="/governance-officers/{governanceOfficerGUID}/delete")
public VoidResponse deleteGovernanceOfficer(@PathVariable
                                                                                                                                                     String serverName,
                                                                                                                                                     @PathVariable
                                                                                                                                                     String userId,
                                                                                                                                                     @PathVariable
                                                                                                                                                     String governanceOfficerGUID,
                                                                                                                                                     @RequestBody
                                                                                                                                                     GovernanceOfficerValidatorRequestBody requestBody)

Remove the requested governance officer.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

requestBody - properties to verify this is the right governance officer

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer is either null or invalid or InvalidParameterException the appointmentId or governance domain is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficerByGUID

@RequestMapping(method=GET,
                path="/governance-officers/{governanceOfficerGUID}")
public GovernanceOfficerResponse getGovernanceOfficerByGUID(@PathVariable
                                                                                                                                                             String serverName,
                                                                                                                                                             @PathVariable
                                                                                                                                                             String userId,
                                                                                                                                                             @PathVariable
                                                                                                                                                             String governanceOfficerGUID)

Retrieve a governance officer description by unique guid.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

Returns:

governance officer object or UnrecognizedGUIDException the unique identifier of the governance officer is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficerByAppointmentId

@RequestMapping(method=GET,
                path="/governance-officers/by-appointment-id/{appointmentId}")
public GovernanceOfficerResponse getGovernanceOfficerByAppointmentId(@PathVariable
                                                                                                                                                                                String serverName,
                                                                                                                                                                                @PathVariable
                                                                                                                                                                                String userId,
                                                                                                                                                                                @PathVariable
                                                                                                                                                                                String appointmentId)

Retrieve a governance officer by unique appointment id.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

appointmentId - the unique appointment identifier of the governance officer.

Returns:

governance officer object or InvalidParameterException the appointmentId or governance domain is either null or invalid or AppointmentIdNotUniqueException more than one governance officer entity was retrieved for this appointmentId PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficers

@RequestMapping(method=GET,
                path="/governance-officers")
public GovernanceOfficerListResponse getGovernanceOfficers(@PathVariable
                                                                                                                                    String serverName,
                                                                                                                                    @PathVariable
                                                                                                                                    String userId)

Return all of the defined governance officers.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

Returns:

list of governance officer objects or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getActiveGovernanceOfficers

@RequestMapping(method=GET,
                path="/governance-officers/active")
public GovernanceOfficerListResponse getActiveGovernanceOfficers(@PathVariable
                                                                                                                                                 String serverName,
                                                                                                                                                 @PathVariable
                                                                                                                                                 String userId)

Return all of the active governance officers.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

Returns:

list of governance officer objects or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficersByDomain

@RequestMapping(method=POST,
                path="/governance-officers/by-domain")
public GovernanceOfficerListResponse getGovernanceOfficersByDomain(@PathVariable
                                                                                                                                                       String serverName,
                                                                                                                                                       @PathVariable
                                                                                                                                                       String userId,
                                                                                                                                                       @RequestBody
                                                                                                                                                       GovernanceDomainRequestBody requestBody)

Return all of the defined governance officers for a specific governance domain. In a small organization there is typically only one governance officer. However a large organization may have multiple governance officers, each with a different scope. The governance officer with a null scope is the overall leader.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

requestBody - domain of interest

Returns:

list of governance officer objects or InvalidParameterException the governance domain is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

appointGovernanceOfficer

@RequestMapping(method=POST,
                path="/governance-officers/{governanceOfficerGUID}/appoint")
public VoidResponse appointGovernanceOfficer(@PathVariable
                                                                                                                                                       String serverName,
                                                                                                                                                       @PathVariable
                                                                                                                                                       String userId,
                                                                                                                                                       @PathVariable
                                                                                                                                                       String governanceOfficerGUID,
                                                                                                                                                       @RequestBody
                                                                                                                                                       AppointmentRequestBody requestBody)

Link a person to a governance officer. Only one person may be appointed at any one time.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

requestBody - unique identifier for the profile and start date.

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer or profile is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

relieveGovernanceOfficer

@RequestMapping(method=POST,
                path="/governance-officers/{governanceOfficerGUID}/relieve")
public VoidResponse relieveGovernanceOfficer(@PathVariable
                                                                                                                                                       String serverName,
                                                                                                                                                       @PathVariable
                                                                                                                                                       String userId,
                                                                                                                                                       @PathVariable
                                                                                                                                                       String governanceOfficerGUID,
                                                                                                                                                       @RequestBody
                                                                                                                                                       AppointmentRequestBody requestBody)

Unlink a person from a governance officer appointment.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

requestBody - unique identifier for the profile and end date.

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer or profile is either null or invalid or InvalidParameterException the profile is not linked to this governance officer or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.