Package org.odpi.openmetadata.accessservices.governanceprogram.client

Class GovernanceProgramReviewManager

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramReviewManager

All Implemented Interfaces:

GovernanceProgramReviewInterface, RelatedElementsManagementInterface

public class GovernanceProgramReviewManager
extends GovernanceProgramBaseClient
implements GovernanceProgramReviewInterface

The GovernanceProgramReviewInterface supports the periodic review of the governance program. This includes looking at the metrics and the governance zones.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient

nullRequestBody

Constructor Summary

Constructors

Constructor	Description
GovernanceProgramReviewManager(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
GovernanceProgramReviewManager(String serverName, String serverPlatformURLRoot, int maxPageSize, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.
GovernanceProgramReviewManager(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
GovernanceProgramReviewManager(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.
GovernanceProgramReviewManager(String serverName, String serverPlatformURLRoot, GovernanceProgramRESTClient restClient, int maxPageSize)	Create a new client that uses the supplied rest client.

Method Summary

Modifier and Type	Method	Description
List<GovernanceDefinitionElement>	findGovernanceDefinitions(String userId, String typeName, String searchString, int startFrom, int pageSize)	Return the list of governance definitions that match the search string - this can be a regular expression.
GovernanceDefinitionElement	getGovernanceDefinitionByGUID(String userId, String definitionGUID)	Retrieve the governance definition by the unique identifier assigned by this service when it was created.
GovernanceDefinitionGraph	getGovernanceDefinitionInContext(String userId, String governanceDefinitionGUID)	Return the governance definition associated with a unique identifier and the other governance definitions linked to it.
List<GovernanceMetricImplementation>	getGovernanceDefinitionMetrics(String userId, String governanceDefinitionGUID, int startFrom, int pageSize)	Return details of the metrics for a governance definition along with details of where the
List<GovernanceDefinitionElement>	getGovernanceDefinitionsForDocId(String userId, String typeName, String docId, int startFrom, int pageSize)	Return the list of governance definitions associated with a unique docId.
List<GovernanceDefinitionElement>	getGovernanceDefinitionsForDomain(String userId, String typeName, int domainIdentifier, int startFrom, int pageSize)	Return the list of governance definitions associated with a particular governance domain.
List<ElementStub>	getGovernanceZoneMembers(String userId, String zoneName, String subTypeName, int startFrom, int pageSize)	Return the list of assets that are members of a particular zone.

Methods inherited from class org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient

clearAssignmentScope, clearGovernanceDefinitionScope, clearGovernanceResponsibilityAssignment, clearGovernedBy, clearMoreInformation, clearResource, clearStakeholder, getAssignedActors, getAssignedScopes, getDescriptiveElements, getGovernanceDefinitionScopes, getGovernanceDefinitionsForElement, getGovernedElements, getMoreInformation, getResourceList, getResponsibleRoles, getRoleResponsibilities, getScopedGovernanceDefinitions, getStakeholderCommissionedElements, getStakeholders, getSupportedByResource, removeReferenceable, setupAssignmentScope, setupGovernanceDefinitionScope, setupGovernanceResponsibilityAssignment, setupGovernedBy, setupMoreInformation, setupResource, setupStakeholder, updateGovernanceDefinitionStatus, updateRelationship

Methods inherited from class java.lang.Object

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

Constructor Details

GovernanceProgramReviewManager

public GovernanceProgramReviewManager(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 services

Throws:

InvalidParameterException - bad input parameters

GovernanceProgramReviewManager

public GovernanceProgramReviewManager(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 services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - bad input parameters

GovernanceProgramReviewManager

public GovernanceProgramReviewManager(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 services

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - bad input parameters

GovernanceProgramReviewManager

public GovernanceProgramReviewManager(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 services

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

GovernanceProgramReviewManager

public GovernanceProgramReviewManager(String serverName,
 String serverPlatformURLRoot,
 GovernanceProgramRESTClient restClient,
 int maxPageSize)
                               throws InvalidParameterException

Create a new client that uses the supplied rest client. This is typically used when called from another OMAG Server.

Parameters:

serverName - name of the server to connect to

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

restClient - internal client for rest calls

maxPageSize - pre-initialized parameter limit

Throws:

InvalidParameterException - bad input parameters

Method Details

getGovernanceDefinitionByGUID

public GovernanceDefinitionElement getGovernanceDefinitionByGUID(String userId,
 String definitionGUID)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance definition by the unique identifier assigned by this service when it was created.

Specified by:

getGovernanceDefinitionByGUID in interface GovernanceProgramReviewInterface

Parameters:

userId - calling user

definitionGUID - identifier of the governance definition to retrieve

Returns:

properties of the governance definition

Throws:

InvalidParameterException - guid or userId is null; guid is not recognized

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceDefinitionsForDomain

public List<GovernanceDefinitionElement> getGovernanceDefinitionsForDomain(String userId,
 String typeName,
 int domainIdentifier,
 int startFrom,
 int pageSize)
                                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of governance definitions associated with a particular governance domain.

Specified by:

getGovernanceDefinitionsForDomain in interface GovernanceProgramReviewInterface

Parameters:

userId - calling user

typeName - option type name to restrict retrieval to a specific type

domainIdentifier - identifier of the governance domain - 0 = all domains

startFrom - where to start from in the list of definitions

pageSize - max number of results to return in one call

Returns:

list of governance definitions

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the caller is not authorized to issue the request

PropertyServerException - the metadata service has problems

getGovernanceDefinitionsForDocId

public List<GovernanceDefinitionElement> getGovernanceDefinitionsForDocId(String userId,
 String typeName,
 String docId,
 int startFrom,
 int pageSize)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of governance definitions associated with a unique docId. In an ideal world, there should be only one.

Specified by:

getGovernanceDefinitionsForDocId in interface GovernanceProgramReviewInterface

Parameters:

userId - calling user

typeName - option types name to restrict retrieval to a specific type

docId - unique name of the governance definition

startFrom - where to start from in the list of definitions

pageSize - max number of results to return in one call

Returns:

list of governance definitions

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the caller is not authorized to issue the request

PropertyServerException - the metadata service has problems

getGovernanceDefinitionInContext

public GovernanceDefinitionGraph getGovernanceDefinitionInContext(String userId,
 String governanceDefinitionGUID)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the governance definition associated with a unique identifier and the other governance definitions linked to it.

Specified by:

getGovernanceDefinitionInContext in interface GovernanceProgramReviewInterface

Parameters:

userId - calling user

governanceDefinitionGUID - unique identifier of the governance definition

Returns:

governance definition and its linked elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the caller is not authorized to issue the request

PropertyServerException - the metadata service has problems

findGovernanceDefinitions

public List<GovernanceDefinitionElement> findGovernanceDefinitions(String userId,
 String typeName,
 String searchString,
 int startFrom,
 int pageSize)
                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of governance definitions that match the search string - this can be a regular expression.

Specified by:

findGovernanceDefinitions in interface GovernanceProgramReviewInterface

Parameters:

userId - calling user

typeName - option types name to restrict retrieval to a specific type

searchString - value to search for

startFrom - where to start from in the list of definition results

pageSize - max number of results to return in one call

Returns:

list of governance definitions

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the caller is not authorized to issue the request

PropertyServerException - the metadata service has problems

getGovernanceDefinitionMetrics

public List<GovernanceMetricImplementation> getGovernanceDefinitionMetrics(String userId,
 String governanceDefinitionGUID,
 int startFrom,
 int pageSize)
                                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return details of the metrics for a governance definition along with details of where the

Specified by:

getGovernanceDefinitionMetrics in interface GovernanceProgramReviewInterface

Parameters:

userId - calling user

governanceDefinitionGUID - unique name of the governance definition

startFrom - where to start from in the list of definitions

pageSize - max number of results to return in one call

Returns:

list of associated metrics and links for retrieving the captured measurements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the caller is not authorized to issue the request

PropertyServerException - the metadata service has problems

getGovernanceZoneMembers

public List<ElementStub> getGovernanceZoneMembers(String userId,
 String zoneName,
 String subTypeName,
 int startFrom,
 int pageSize)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of assets that are members of a particular zone.

Specified by:

getGovernanceZoneMembers in interface GovernanceProgramReviewInterface

Parameters:

userId - calling user

zoneName - unique name of the zone to search for

subTypeName - optional asset subtypeName to limit the results

startFrom - where to start from in the list of assets

pageSize - max number of results to return in one call

Returns:

list of headers for assets in the requested zone

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the caller is not authorized to issue the request

PropertyServerException - the metadata service has problems