Class GovernanceProgramReviewManager
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramReviewManager
-
- All Implemented Interfaces:
GovernanceProgramReviewInterface
public class GovernanceProgramReviewManager extends Object implements GovernanceProgramReviewInterface
The GovernanceProgramReviewInterface supports the periodic review of the governance program. This includes looking at the metrics and the governance zones.
-
-
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
All Methods Instance Methods Concrete Methods 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.List<ElementStub>getElementsGovernedByDefinition(String userId, String governanceDefinitionGUID, int startFrom, int pageSize)Return the elements that are governed by the supplied governance definition.GovernanceDefinitionGraphgetGovernanceDefinitionInContext(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 theList<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.GovernanceZoneInActiongetGovernanceZoneInAction(String userId, String zoneGUID)Return detailed information about the requested governance zone.List<ElementStub>getGovernanceZoneMembers(String userId, String zoneGUID, int startFrom, int pageSize)Return the list of assets that are members of a particular zone.
-
-
-
Constructor Detail
-
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 toserverPlatformURLRoot- the network address of the server running the OMAS REST servers- 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 toserverPlatformURLRoot- the network address of the server running the OMAS REST serversuserId- caller's userId embedded in all HTTP requestspassword- 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 toserverPlatformURLRoot- the network address of the server running the OMAS REST serversmaxPageSize- pre-initialized parameter limitauditLog- 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 toserverPlatformURLRoot- the network address of the server running the OMAS REST serversuserId- caller's userId embedded in all HTTP requestspassword- caller's userId embedded in all HTTP requestsmaxPageSize- pre-initialized parameter limitauditLog- 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 fro manother OMAG Server.- Parameters:
serverName- name of the server to connect toserverPlatformURLRoot- the network address of the server running the OMAS REST serversrestClient- internal client for rest callsmaxPageSize- pre-initialized parameter limit- Throws:
InvalidParameterException- bad input parameters
-
-
Method Detail
-
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:
getGovernanceDefinitionsForDomainin interfaceGovernanceProgramReviewInterface- Parameters:
userId- calling usertypeName- option type name to restrict retrieval to a specific typedomainIdentifier- identifier of the governance domain - 0 = all domainsstartFrom- where to start from in the list of definitionspageSize- max number of results to return in one call- Returns:
- list of governance definitions
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the caller is not authorized to issue the requestPropertyServerException- 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, the should be only one.- Specified by:
getGovernanceDefinitionsForDocIdin interfaceGovernanceProgramReviewInterface- Parameters:
userId- calling usertypeName- option types name to restrict retrieval to a specific typedocId- unique name of the governance definitionstartFrom- where to start from in the list of definitionspageSize- max number of results to return in one call- Returns:
- list of governance definitions
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the caller is not authorized to issue the requestPropertyServerException- 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:
getGovernanceDefinitionInContextin interfaceGovernanceProgramReviewInterface- Parameters:
userId- calling usergovernanceDefinitionGUID- unique identifier of the governance definition- Returns:
- governance definition and its linked elements
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the caller is not authorized to issue the requestPropertyServerException- the metadata service has problems
-
getElementsGovernedByDefinition
public List<ElementStub> getElementsGovernedByDefinition(String userId, String governanceDefinitionGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Return the elements that are governed by the supplied governance definition.- Specified by:
getElementsGovernedByDefinitionin interfaceGovernanceProgramReviewInterface- Parameters:
userId- calling usergovernanceDefinitionGUID- unique name of the governance definitionstartFrom- where to start from in the list of definitionspageSize- max number of results to return in one call- Returns:
- list of headers for the associated elements
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the caller is not authorized to issue the requestPropertyServerException- 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:
findGovernanceDefinitionsin interfaceGovernanceProgramReviewInterface- Parameters:
userId- calling usertypeName- option types name to restrict retrieval to a specific typesearchString- value to search forstartFrom- where to start from in the list of definition resultspageSize- max number of results to return in one call- Returns:
- list of governance definitions
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the caller is not authorized to issue the requestPropertyServerException- 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:
getGovernanceDefinitionMetricsin interfaceGovernanceProgramReviewInterface- Parameters:
userId- calling usergovernanceDefinitionGUID- unique name of the governance definitionstartFrom- where to start from in the list of definitionspageSize- 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 invalidUserNotAuthorizedException- the caller is not authorized to issue the requestPropertyServerException- the metadata service has problems
-
getGovernanceZoneInAction
public GovernanceZoneInAction getGovernanceZoneInAction(String userId, String zoneGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Return detailed information about the requested governance zone.- Specified by:
getGovernanceZoneInActionin interfaceGovernanceProgramReviewInterface- Parameters:
userId- calling userzoneGUID- unique identifier of the zone to search for- Returns:
- detailed information about the requested zone
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the caller is not authorized to issue the requestPropertyServerException- the metadata service has problems
-
getGovernanceZoneMembers
public List<ElementStub> getGovernanceZoneMembers(String userId, String zoneGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Return the list of assets that are members of a particular zone.- Specified by:
getGovernanceZoneMembersin interfaceGovernanceProgramReviewInterface- Parameters:
userId- calling userzoneGUID- unique identifier of the zone to search forstartFrom- where to start from in the list of assetspageSize- 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 invalidUserNotAuthorizedException- the caller is not authorized to issue the requestPropertyServerException- the metadata service has problems
-
-