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

Class GovernanceStatusLevelManager

java.lang.Object

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

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceStatusLevelManager

All Implemented Interfaces:

GovernanceStatusLevelInterface, RelatedElementsManagementInterface

public class GovernanceStatusLevelManager
extends GovernanceProgramBaseClient
implements GovernanceStatusLevelInterface

GovernanceStatusLevelManager is the Java client used to manage the definitions of the level values used in governance classifications.

Field Summary

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

nullRequestBody

Constructor Summary

Constructors

Constructor	Description
GovernanceStatusLevelManager(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
GovernanceStatusLevelManager(String serverName, String serverPlatformURLRoot, int maxPageSize, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.
GovernanceStatusLevelManager(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
GovernanceStatusLevelManager(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.
GovernanceStatusLevelManager(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
String	createGovernanceStatusIdentifier(String userId, String setGUID, GovernanceStatusIdentifierProperties properties)	Create a new metadata element to represent a governance classification level identifier.
String	createGovernanceStatusIdentifierSet(String userId, GovernanceStatusIdentifierSetProperties properties)	Create a new metadata element to represent the root of a Governance Level Classification Identifier Set.
String	createStandardGovernanceStatusLevels(String userId)	Create a governance level identifier set for a specific governance classification: Impact - classification used to document the impact of an issue or situation. Criticality - classification used to document how critical an asset or activity is. Retention - classification used to identify the basis that an asset should be retained. Confidence - classification use to document an assessment of the quality of an asset or element with an asset. Confidentiality - classification use to define how much access to an asset should be restricted.
GovernanceStatusIdentifierElement	getGovernanceStatusIdentifier(String userId, int levelIdentifier)	Retrieve the governance classification level identifier metadata element for the requested level within a specific governance classification.
GovernanceStatusIdentifierSetElement	getGovernanceStatusIdentifierSetByGUID(String userId, String setGUID)	Retrieve the Governance Level Identifier Set metadata element with the supplied unique identifier.
List<GovernanceStatusIdentifierSetElement>	getGovernanceStatusIdentifierSets(String userId)	Retrieve the list of defined Governance Status Identifier Sets.
void	removeGovernanceStatusIdentifier(String userId, String identifierGUID)	Remove the metadata element representing a governance status identifier.
void	removeGovernanceStatusIdentifierSet(String userId, String setGUID)	Remove the metadata element representing a Governance Status Identifier Set and all linked level identifiers.
void	updateGovernanceStatusIdentifier(String userId, String identifierGUID, GovernanceStatusIdentifierProperties properties)	Update the metadata element representing a governance classification level identifier.
void	updateGovernanceStatusIdentifierSet(String userId, String setGUID, GovernanceStatusIdentifierSetProperties properties)	Update the metadata element representing a Governance Status Identifier Set.

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 Detail

GovernanceStatusLevelManager

public GovernanceStatusLevelManager(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 - there is a problem creating the client-side components to issue any REST API calls.

GovernanceStatusLevelManager

public GovernanceStatusLevelManager(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 - there is a problem creating the client-side components to issue any REST API calls.

GovernanceStatusLevelManager

public GovernanceStatusLevelManager(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 - there is a problem creating the client-side components to issue any REST API calls.

GovernanceStatusLevelManager

public GovernanceStatusLevelManager(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 - there is a problem creating the client-side components to issue any REST API calls.

GovernanceStatusLevelManager

public GovernanceStatusLevelManager(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 servers

restClient - internal client for rest calls

maxPageSize - pre-initialized parameter limit

Throws:

InvalidParameterException - bad input parameters

Method Detail

createStandardGovernanceStatusLevels

public String createStandardGovernanceStatusLevels(String userId)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Create a governance level identifier set for a specific governance classification:

• Impact - classification used to document the impact of an issue or situation.
• Criticality - classification used to document how critical an asset or activity is.
• Retention - classification used to identify the basis that an asset should be retained.
• Confidence - classification use to document an assessment of the quality of an asset or element with an asset.
• Confidentiality - classification use to define how much access to an asset should be restricted.

Specified by:

createStandardGovernanceStatusLevels in interface GovernanceStatusLevelInterface

Parameters:

userId - calling user

Returns:

unique identifier of the governance level identifier set

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

createGovernanceStatusIdentifierSet

public String createGovernanceStatusIdentifierSet(String userId,
                                                  GovernanceStatusIdentifierSetProperties properties)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Create a new metadata element to represent the root of a Governance Level Classification Identifier Set.

Specified by:

createGovernanceStatusIdentifierSet in interface GovernanceStatusLevelInterface

Parameters:

userId - calling user

properties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

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)

updateGovernanceStatusIdentifierSet

public void updateGovernanceStatusIdentifierSet(String userId,
                                                String setGUID,
                                                GovernanceStatusIdentifierSetProperties properties)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Update the metadata element representing a Governance Status Identifier Set.

Specified by:

updateGovernanceStatusIdentifierSet in interface GovernanceStatusLevelInterface

Parameters:

userId - calling user

setGUID - unique identifier of the metadata element to remove

properties - new properties for this element

Throws:

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)

removeGovernanceStatusIdentifierSet

public void removeGovernanceStatusIdentifierSet(String userId,
                                                String setGUID)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Remove the metadata element representing a Governance Status Identifier Set and all linked level identifiers.

Specified by:

removeGovernanceStatusIdentifierSet in interface GovernanceStatusLevelInterface

Parameters:

userId - calling user

setGUID - unique identifier of the metadata element to remove

Throws:

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)

getGovernanceStatusIdentifierSets

public List<GovernanceStatusIdentifierSetElement> getGovernanceStatusIdentifierSets(String userId)
                                                                             throws InvalidParameterException,
                                                                                    UserNotAuthorizedException,
                                                                                    PropertyServerException

Retrieve the list of defined Governance Status Identifier Sets.

Specified by:

getGovernanceStatusIdentifierSets in interface GovernanceStatusLevelInterface

Parameters:

userId - calling user

Returns:

list of matching metadata elements

Throws:

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)

getGovernanceStatusIdentifierSetByGUID

public GovernanceStatusIdentifierSetElement getGovernanceStatusIdentifierSetByGUID(String userId,
                                                                                   String setGUID)
                                                                            throws InvalidParameterException,
                                                                                   UserNotAuthorizedException,
                                                                                   PropertyServerException

Retrieve the Governance Level Identifier Set metadata element with the supplied unique identifier.

Specified by:

getGovernanceStatusIdentifierSetByGUID in interface GovernanceStatusLevelInterface

Parameters:

userId - calling user

setGUID - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

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)

createGovernanceStatusIdentifier

public String createGovernanceStatusIdentifier(String userId,
                                               String setGUID,
                                               GovernanceStatusIdentifierProperties properties)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Create a new metadata element to represent a governance classification level identifier.

Specified by:

createGovernanceStatusIdentifier in interface GovernanceStatusLevelInterface

Parameters:

userId - calling user

setGUID - unique identifier of the set that this identifier belongs

properties - properties about the GovernanceStatusLevelIdentifier to store

Returns:

unique identifier of the new GovernanceClassifierLevelIdentifier

Throws:

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)

updateGovernanceStatusIdentifier

public void updateGovernanceStatusIdentifier(String userId,
                                             String identifierGUID,
                                             GovernanceStatusIdentifierProperties properties)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Update the metadata element representing a governance classification level identifier.

Specified by:

updateGovernanceStatusIdentifier in interface GovernanceStatusLevelInterface

Parameters:

userId - calling user

identifierGUID - unique identifier of the metadata element to update

properties - new properties for the metadata element

Throws:

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)

removeGovernanceStatusIdentifier

public void removeGovernanceStatusIdentifier(String userId,
                                             String identifierGUID)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Remove the metadata element representing a governance status identifier.

Specified by:

removeGovernanceStatusIdentifier in interface GovernanceStatusLevelInterface

Parameters:

userId - calling user

identifierGUID - unique identifier of the metadata element to remove

Throws:

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)

getGovernanceStatusIdentifier

public GovernanceStatusIdentifierElement getGovernanceStatusIdentifier(String userId,
                                                                       int levelIdentifier)
                                                                throws InvalidParameterException,
                                                                       UserNotAuthorizedException,
                                                                       PropertyServerException

Retrieve the governance classification level identifier metadata element for the requested level within a specific governance classification.

Specified by:

getGovernanceStatusIdentifier in interface GovernanceStatusLevelInterface

Parameters:

userId - calling user

levelIdentifier - level value to retrieve

Returns:

list of matching metadata elements

Throws:

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)