org.odpi.openmetadata.accessservices.governanceprogram.client

Class GovernanceClassificationLevelManager

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceClassificationLevelManager

All Implemented Interfaces:

GovernanceClassificationLevelInterface

public class GovernanceClassificationLevelManager
extends Object
implements GovernanceClassificationLevelInterface

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

Constructor Summary

Constructors

Constructor and Description
GovernanceClassificationLevelManager(String serverName, String serverPlatformURLRoot) Create a new client with no authentication embedded in the HTTP request.
GovernanceClassificationLevelManager(String serverName, String serverPlatformURLRoot, GovernanceProgramRESTClient restClient, int maxPageSize) Create a new client that uses the supplied rest client.
GovernanceClassificationLevelManager(String serverName, String serverPlatformURLRoot, int maxPageSize, AuditLog auditLog) Create a new client with no authentication embedded in the HTTP request.
GovernanceClassificationLevelManager(String serverName, String serverPlatformURLRoot, String userId, String password) Create a new client that passes userId and password in each HTTP request.
GovernanceClassificationLevelManager(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
String	createGovernanceLevelIdentifier(String userId, String setGUID, GovernanceLevelIdentifierProperties properties) Create a new metadata element to represent a governance classification level identifier.
String	createGovernanceLevelIdentifierSet(String userId, GovernanceLevelIdentifierSetProperties properties) Create a new metadata element to represent the root of a Governance Level Classification Identifier Set.
String	createStandardGovernanceClassificationLevels(String userId, String classificationName) 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.
GovernanceLevelIdentifierElement	getGovernanceLevelIdentifier(String userId, String classificationName, int levelIdentifier) Retrieve the governance classification level identifier metadata element for the requested level within a specific governance classification.
GovernanceLevelIdentifierSetElement	getGovernanceLevelIdentifierSet(String userId, String classificationName) Retrieve the Governance Level Identifier Set for a requested governance classification.
GovernanceLevelIdentifierSetElement	getGovernanceLevelIdentifierSetByGUID(String userId, String setGUID) Retrieve the Governance Level Identifier Set metadata element with the supplied unique identifier.
List<GovernanceLevelIdentifierSetElement>	getGovernanceLevelIdentifierSets(String userId) Retrieve the list of defined Governance Classification Level Identifier Sets.
void	removeGovernanceLevelIdentifier(String userId, String identifierGUID) Remove the metadata element representing a governance classification level identifier.
void	removeGovernanceLevelIdentifierSet(String userId, String setGUID) Remove the metadata element representing a Governance Classification Level Identifier Set and all linked level identifiers.
void	updateGovernanceLevelIdentifier(String userId, String identifierGUID, GovernanceLevelIdentifierProperties properties) Update the metadata element representing a governance classification level identifier.
void	updateGovernanceLevelIdentifierSet(String userId, String setGUID, GovernanceLevelIdentifierSetProperties properties) Update the metadata element representing a Governance Classification Level Identifier Set.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceClassificationLevelManager

public GovernanceClassificationLevelManager(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.

GovernanceClassificationLevelManager

public GovernanceClassificationLevelManager(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.

GovernanceClassificationLevelManager

public GovernanceClassificationLevelManager(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.

GovernanceClassificationLevelManager

public GovernanceClassificationLevelManager(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.

GovernanceClassificationLevelManager

public GovernanceClassificationLevelManager(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 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

createStandardGovernanceClassificationLevels

public String createStandardGovernanceClassificationLevels(String userId,
                                                           String classificationName)
                                                    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:

createStandardGovernanceClassificationLevels in interface GovernanceClassificationLevelInterface

Parameters:

userId - calling user

classificationName - name of the classification level to set up

Returns:

unique identifier of the governance level identifier set

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

createGovernanceLevelIdentifierSet

public String createGovernanceLevelIdentifierSet(String userId,
                                                 GovernanceLevelIdentifierSetProperties properties)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

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

Specified by:

createGovernanceLevelIdentifierSet in interface GovernanceClassificationLevelInterface

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)

updateGovernanceLevelIdentifierSet

public void updateGovernanceLevelIdentifierSet(String userId,
                                               String setGUID,
                                               GovernanceLevelIdentifierSetProperties properties)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Update the metadata element representing a Governance Classification Level Identifier Set.

Specified by:

updateGovernanceLevelIdentifierSet in interface GovernanceClassificationLevelInterface

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)

removeGovernanceLevelIdentifierSet

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

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

Specified by:

removeGovernanceLevelIdentifierSet in interface GovernanceClassificationLevelInterface

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)

getGovernanceLevelIdentifierSets

public List<GovernanceLevelIdentifierSetElement> getGovernanceLevelIdentifierSets(String userId)
                                                                           throws InvalidParameterException,
                                                                                  UserNotAuthorizedException,
                                                                                  PropertyServerException

Retrieve the list of defined Governance Classification Level Identifier Sets.

Specified by:

getGovernanceLevelIdentifierSets in interface GovernanceClassificationLevelInterface

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)

getGovernanceLevelIdentifierSet

public GovernanceLevelIdentifierSetElement getGovernanceLevelIdentifierSet(String userId,
                                                                           String classificationName)
                                                                    throws InvalidParameterException,
                                                                           UserNotAuthorizedException,
                                                                           PropertyServerException

Retrieve the Governance Level Identifier Set for a requested governance classification.

Specified by:

getGovernanceLevelIdentifierSet in interface GovernanceClassificationLevelInterface

Parameters:

userId - calling user

classificationName - classificationName to search for

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)

getGovernanceLevelIdentifierSetByGUID

public GovernanceLevelIdentifierSetElement getGovernanceLevelIdentifierSetByGUID(String userId,
                                                                                 String setGUID)
                                                                          throws InvalidParameterException,
                                                                                 UserNotAuthorizedException,
                                                                                 PropertyServerException

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

Specified by:

getGovernanceLevelIdentifierSetByGUID in interface GovernanceClassificationLevelInterface

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)

createGovernanceLevelIdentifier

public String createGovernanceLevelIdentifier(String userId,
                                              String setGUID,
                                              GovernanceLevelIdentifierProperties properties)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

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

Specified by:

createGovernanceLevelIdentifier in interface GovernanceClassificationLevelInterface

Parameters:

userId - calling user

setGUID - unique identifier of the set that this identifier belongs

properties - properties about the GovernanceClassificationLevelIdentifier 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)

updateGovernanceLevelIdentifier

public void updateGovernanceLevelIdentifier(String userId,
                                            String identifierGUID,
                                            GovernanceLevelIdentifierProperties properties)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Update the metadata element representing a governance classification level identifier.

Specified by:

updateGovernanceLevelIdentifier in interface GovernanceClassificationLevelInterface

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)

removeGovernanceLevelIdentifier

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

Remove the metadata element representing a governance classification level identifier.

Specified by:

removeGovernanceLevelIdentifier in interface GovernanceClassificationLevelInterface

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)

getGovernanceLevelIdentifier

public GovernanceLevelIdentifierElement getGovernanceLevelIdentifier(String userId,
                                                                     String classificationName,
                                                                     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:

getGovernanceLevelIdentifier in interface GovernanceClassificationLevelInterface

Parameters:

userId - calling user

classificationName - string to find in the properties

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)