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

Class CertificationManager

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.client.CertificationManager

All Implemented Interfaces:

CertificationManagementInterface

public class CertificationManager
extends Object
implements CertificationManagementInterface

CertificationManager is the java client for managing certification types and the certification of elements.

Constructor Summary

Constructors

Constructor	Description
CertificationManager(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
CertificationManager(String serverName, String serverPlatformURLRoot, int maxPageSize, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.
CertificationManager(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
CertificationManager(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.
CertificationManager(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
void	certifyElement(String userId, String elementGUID, String certificationTypeGUID, CertificationProperties properties)	Link an element to a certification type and include details of the certification in the relationship properties.
String	createCertificationType(String userId, CertificationTypeProperties properties, GovernanceDefinitionStatus initialStatus)	Create a description of the certification type.
void	decertifyElement(String userId, String elementGUID, String certificationTypeGUID, String certificateId)	Remove the certification for an element.
void	deleteCertificationType(String userId, String certificationTypeGUID)	Delete the properties of the certification type.
CertificationTypeElement	getCertificationTypeByDocId(String userId, String documentIdentifier)	Retrieve the certification type by its assigned unique document identifier.
List<CertificationTypeElement>	getCertificationTypeByDomainId(String userId, int domainIdentifier, int startFrom, int pageSize)	Retrieve all of the certification type definitions for a specific governance domain.
CertificationTypeElement	getCertificationTypeByGUID(String userId, String certificationTypeGUID)	Retrieve the certification type by the unique identifier assigned by this service when it was created.
List<CertificationTypeElement>	getCertificationTypesByTitle(String userId, String title, int startFrom, int pageSize)	Retrieve all of the certification types for a particular title.
void	updateCertification(String userId, String elementGUID, String certificationTypeGUID, boolean isMergeUpdate, CertificationProperties properties)	Update the properties of a certification.
void	updateCertificationType(String userId, String certificationTypeGUID, boolean isMergeUpdate, CertificationTypeProperties properties)	Update the properties of the certification type.

Methods inherited from class java.lang.Object

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

Constructor Detail

CertificationManager

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

CertificationManager

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

CertificationManager

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

CertificationManager

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

CertificationManager

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

createCertificationType

public String createCertificationType(String userId,
                                      CertificationTypeProperties properties,
                                      GovernanceDefinitionStatus initialStatus)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Create a description of the certification type.

Specified by:

createCertificationType in interface CertificationManagementInterface

Parameters:

userId - calling user

properties - certification properties

initialStatus - what is the initial status for the certification type - default value is DRAFT

Returns:

unique identifier of new definition

Throws:

InvalidParameterException - documentIdentifier or userId is null; documentIdentifier is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateCertificationType

public void updateCertificationType(String userId,
                                    String certificationTypeGUID,
                                    boolean isMergeUpdate,
                                    CertificationTypeProperties properties)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Update the properties of the certification type.

Specified by:

updateCertificationType in interface CertificationManagementInterface

Parameters:

userId - calling user

certificationTypeGUID - identifier of the governance definition to change

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - certification properties

Throws:

InvalidParameterException - guid, documentIdentifier or userId is null; documentIdentifier is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteCertificationType

public void deleteCertificationType(String userId,
                                    String certificationTypeGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Delete the properties of the certification type.

Specified by:

deleteCertificationType in interface CertificationManagementInterface

Parameters:

userId - calling user

certificationTypeGUID - identifier of the governance definition to delete

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCertificationTypeByGUID

public CertificationTypeElement getCertificationTypeByGUID(String userId,
                                                           String certificationTypeGUID)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Retrieve the certification type by the unique identifier assigned by this service when it was created.

Specified by:

getCertificationTypeByGUID in interface CertificationManagementInterface

Parameters:

userId - calling user

certificationTypeGUID - identifier of the governance definition to retrieve

Returns:

properties of the certification type

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCertificationTypeByDocId

public CertificationTypeElement getCertificationTypeByDocId(String userId,
                                                            String documentIdentifier)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Retrieve the certification type by its assigned unique document identifier.

Specified by:

getCertificationTypeByDocId in interface CertificationManagementInterface

Parameters:

userId - calling user

documentIdentifier - identifier to search for

Returns:

properties of the matching certification type

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCertificationTypesByTitle

public List<CertificationTypeElement> getCertificationTypesByTitle(String userId,
                                                                   String title,
                                                                   int startFrom,
                                                                   int pageSize)
                                                            throws UserNotAuthorizedException,
                                                                   InvalidParameterException,
                                                                   PropertyServerException

Retrieve all of the certification types for a particular title. The title can include regEx wildcards.

Specified by:

getCertificationTypesByTitle in interface CertificationManagementInterface

Parameters:

userId - calling user

title - short description of the role

startFrom - where to start from in the list of definitions

pageSize - max number of results to return in one call

Returns:

list of matching roles (null if no matching elements)

Throws:

InvalidParameterException - title or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCertificationTypeByDomainId

public List<CertificationTypeElement> getCertificationTypeByDomainId(String userId,
                                                                     int domainIdentifier,
                                                                     int startFrom,
                                                                     int pageSize)
                                                              throws InvalidParameterException,
                                                                     UserNotAuthorizedException,
                                                                     PropertyServerException

Retrieve all of the certification type definitions for a specific governance domain.

Specified by:

getCertificationTypeByDomainId in interface CertificationManagementInterface

Parameters:

userId - calling user

domainIdentifier - identifier to search for

startFrom - where to start from in the list of definitions

pageSize - max number of results to return in one call

Returns:

properties of the matching certification type definitions

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

certifyElement

public void certifyElement(String userId,
                           String elementGUID,
                           String certificationTypeGUID,
                           CertificationProperties properties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Link an element to a certification type and include details of the certification in the relationship properties.

Specified by:

certifyElement in interface CertificationManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element being certified

certificationTypeGUID - unique identifier for the certification type

properties - the properties of the certification

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateCertification

public void updateCertification(String userId,
                                String elementGUID,
                                String certificationTypeGUID,
                                boolean isMergeUpdate,
                                CertificationProperties properties)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Update the properties of a certification. Remember to include the certificationId in the properties if the element has multiple certifications for the same certification type.

Specified by:

updateCertification in interface CertificationManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element being certified

certificationTypeGUID - unique identifier for the certification type

isMergeUpdate - should the supplied properties overlay the existing properties or replace them

properties - the properties of the certification

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

decertifyElement

public void decertifyElement(String userId,
                             String elementGUID,
                             String certificationTypeGUID,
                             String certificateId)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove the certification for an element.

Specified by:

decertifyElement in interface CertificationManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element being certified

certificationTypeGUID - unique identifier for the certification type

certificateId - optional unique identifier from the certification authority - it is used to disambiguate the certifications for the element.

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem