org.odpi.openmetadata.accessservices.governanceprogram.client

Class GovernanceProgramLeadership

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramLeadership

All Implemented Interfaces:

GovernanceLeadershipInterface

public class GovernanceProgramLeadership
extends Object
implements GovernanceLeadershipInterface

GovernanceProgramLeadership provides the client-side interface for the Governance Program Open Metadata Access Service (OMAS). This client, manages all of the interaction with an open metadata repository. It is initialized with the URL of the server that is running the Open Metadata Access Services. This server is responsible for locating and managing the governance program definitions exchanged with this client.

Constructor Summary

Constructors

Constructor and Description
GovernanceProgramLeadership(String serverName, String serverPlatformURLRoot) Create a new client with no authentication embedded in the HTTP request.
GovernanceProgramLeadership(String serverName, String serverPlatformURLRoot, int maxPageSize, AuditLog auditLog) Create a new client with no authentication embedded in the HTTP request.
GovernanceProgramLeadership(String serverName, String serverPlatformURLRoot, String userId, String password) Create a new client that passes userId and password in each HTTP request.
GovernanceProgramLeadership(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize, AuditLog auditLog) Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method and Description
void	appointGovernanceOfficer(String userId, String governanceOfficerGUID, String profileGUID, Date startDate) Link a person to a governance officer.
String	createGovernanceOfficer(String userId, GovernanceDomain governanceDomain, String appointmentId, String appointmentContext, String title, Map<String,String> additionalProperties, List<ExternalReference> externalReferences) Create the governance officer appointment.
void	deleteGovernanceOfficer(String userId, String governanceOfficerGUID, String appointmentId, GovernanceDomain governanceDomain) Remove the requested governance officer.
List<GovernanceOfficerProperties>	getActiveGovernanceOfficers(String userId) Return all of the currently appointed governance officers.
GovernanceOfficerProperties	getGovernanceOfficerByAppointmentId(String userId, String appointmentId) Retrieve a governance officer by unique appointment id.
GovernanceOfficerProperties	getGovernanceOfficerByGUID(String userId, String governanceOfficerGUID) Retrieve a governance officer description by unique guid.
List<GovernanceOfficerProperties>	getGovernanceOfficers(String userId) Return all of the defined governance officers.
List<GovernanceOfficerProperties>	getGovernanceOfficersByDomain(String userId, GovernanceDomain governanceDomain) Return all of the defined governance officers for a specific governance domain.
void	relieveGovernanceOfficer(String userId, String governanceOfficerGUID, String profileGUID, Date endDate) Unlink a person from a governance officer appointment.
void	updateGovernanceOfficer(String userId, String governanceOfficerGUID, GovernanceDomain governanceDomain, String appointmentId, String appointmentContext, String title, Map<String,String> additionalProperties, List<ExternalReference> externalReferences) 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

GovernanceProgramLeadership

public GovernanceProgramLeadership(String serverName,
                                   String serverPlatformURLRoot)
                            throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - bad input parameters

GovernanceProgramLeadership

public GovernanceProgramLeadership(String serverName,
                                   String serverPlatformURLRoot,
                                   String userId,
                                   String password)
                            throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - bad input parameters

GovernanceProgramLeadership

public GovernanceProgramLeadership(String serverName,
                                   String serverPlatformURLRoot,
                                   int maxPageSize,
                                   AuditLog auditLog)
                            throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - bad input parameters

GovernanceProgramLeadership

public GovernanceProgramLeadership(String serverName,
                                   String serverPlatformURLRoot,
                                   String userId,
                                   String password,
                                   int maxPageSize,
                                   AuditLog auditLog)
                            throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - bad input parameters

Method Detail

createGovernanceOfficer

public String createGovernanceOfficer(String userId,
                                      GovernanceDomain governanceDomain,
                                      String appointmentId,
                                      String appointmentContext,
                                      String title,
                                      Map<String,String> additionalProperties,
                                      List<ExternalReference> externalReferences)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Create the governance officer appointment.

Specified by:

createGovernanceOfficer in interface GovernanceLeadershipInterface

Parameters:

userId - the name of the calling user.

governanceDomain - the governance domain for the governance officer.

appointmentId - the unique identifier of the governance officer.

appointmentContext - the context in which the governance officer is appointed. This may be an organizational scope, location, or scope of assets.

title - job title for the governance officer.

additionalProperties - additional properties for the governance officer.

externalReferences - links to addition information. This could be, for example, the home page for the governance officer, or details of the role.

Returns:

Unique identifier (guid) of the governance officer.

Throws:

InvalidParameterException - the governance domain, title or appointment id is null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

updateGovernanceOfficer

public void updateGovernanceOfficer(String userId,
                                    String governanceOfficerGUID,
                                    GovernanceDomain governanceDomain,
                                    String appointmentId,
                                    String appointmentContext,
                                    String title,
                                    Map<String,String> additionalProperties,
                                    List<ExternalReference> externalReferences)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Update selected fields for the governance officer.

Specified by:

updateGovernanceOfficer in interface GovernanceLeadershipInterface

Parameters:

userId - the name of the calling user.

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

governanceDomain - the governance domain for the governance officer.

appointmentId - the unique identifier of the governance officer.

appointmentContext - the context in which the governance officer is appointed. This may be an organizational scope, location, or scope of assets.

title - job title for the governance officer.

additionalProperties - additional properties for the governance officer.

externalReferences - links to addition information. This could be, for example, the home page for the governance officer, or details of the role.

Throws:

InvalidParameterException - the title is null or the governanceDomain/appointmentId does not match the the existing values associated with the governanceOfficerGUID.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

deleteGovernanceOfficer

public void deleteGovernanceOfficer(String userId,
                                    String governanceOfficerGUID,
                                    String appointmentId,
                                    GovernanceDomain governanceDomain)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Remove the requested governance officer.

Specified by:

deleteGovernanceOfficer in interface GovernanceLeadershipInterface

Parameters:

userId - the name of the calling user.

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

appointmentId - the unique identifier of the governance officer.

governanceDomain - the governance domain for the governance officer.

Throws:

InvalidParameterException - the appointmentId or governance domain is either null or invalid.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getGovernanceOfficerByGUID

public GovernanceOfficerProperties getGovernanceOfficerByGUID(String userId,
                                                              String governanceOfficerGUID)
                                                       throws InvalidParameterException,
                                                              PropertyServerException,
                                                              UserNotAuthorizedException

Retrieve a governance officer description by unique guid.

Specified by:

getGovernanceOfficerByGUID in interface GovernanceLeadershipInterface

Parameters:

userId - the name of the calling user.

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

Returns:

governance officer object

Throws:

InvalidParameterException - the unique identifier of the governance officer is either null or invalid.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getGovernanceOfficerByAppointmentId

public GovernanceOfficerProperties getGovernanceOfficerByAppointmentId(String userId,
                                                                       String appointmentId)
                                                                throws InvalidParameterException,
                                                                       AppointmentIdNotUniqueException,
                                                                       PropertyServerException,
                                                                       UserNotAuthorizedException

Retrieve a governance officer by unique appointment id.

Specified by:

getGovernanceOfficerByAppointmentId in interface GovernanceLeadershipInterface

Parameters:

userId - the name of the calling user.

appointmentId - the unique appointment identifier of the governance officer.

Returns:

governance officer object

Throws:

InvalidParameterException - the appointmentId or governance domain is either null or invalid.

AppointmentIdNotUniqueException - more than one governance officer entity was retrieved for this appointmentId.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getGovernanceOfficers

public List<GovernanceOfficerProperties> getGovernanceOfficers(String userId)
                                                        throws InvalidParameterException,
                                                               PropertyServerException,
                                                               UserNotAuthorizedException

Return all of the defined governance officers.

Specified by:

getGovernanceOfficers in interface GovernanceLeadershipInterface

Parameters:

userId - the name of the calling user.

Returns:

list of governance officer objects

Throws:

InvalidParameterException - the userId is either null or invalid.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getActiveGovernanceOfficers

public List<GovernanceOfficerProperties> getActiveGovernanceOfficers(String userId)
                                                              throws InvalidParameterException,
                                                                     PropertyServerException,
                                                                     UserNotAuthorizedException

Return all of the currently appointed governance officers.

Specified by:

getActiveGovernanceOfficers in interface GovernanceLeadershipInterface

Parameters:

userId - the name of the calling user.

Returns:

list of governance officer objects

Throws:

InvalidParameterException - the userId is either null or invalid.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getGovernanceOfficersByDomain

public List<GovernanceOfficerProperties> getGovernanceOfficersByDomain(String userId,
                                                                       GovernanceDomain governanceDomain)
                                                                throws InvalidParameterException,
                                                                       PropertyServerException,
                                                                       UserNotAuthorizedException

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.

Specified by:

getGovernanceOfficersByDomain in interface GovernanceLeadershipInterface

Parameters:

userId - the name of the calling user.

governanceDomain - domain of interest

Returns:

list of governance officer objects

Throws:

InvalidParameterException - the governance domain is either null or invalid.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

appointGovernanceOfficer

public void appointGovernanceOfficer(String userId,
                                     String governanceOfficerGUID,
                                     String profileGUID,
                                     Date startDate)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

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

Specified by:

appointGovernanceOfficer in interface GovernanceLeadershipInterface

Parameters:

userId - the name of the calling user.

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

profileGUID - unique identifier for the profile.

startDate - the official start date of the appointment - null means effective immediately.

Throws:

InvalidParameterException - the unique identifier of the governance officer or profile is either null or invalid.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

relieveGovernanceOfficer

public void relieveGovernanceOfficer(String userId,
                                     String governanceOfficerGUID,
                                     String profileGUID,
                                     Date endDate)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

Unlink a person from a governance officer appointment.

Specified by:

relieveGovernanceOfficer in interface GovernanceLeadershipInterface

Parameters:

userId - the name of the calling user.

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

profileGUID - unique identifier for the profile.

endDate - the official end of the appointment - null means effective immediately.

Throws:

InvalidParameterException - the profile is not linked to this governance officer.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.