Class CertificationManager
java.lang.Object
org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient
org.odpi.openmetadata.accessservices.governanceprogram.client.CertificationManager
- All Implemented Interfaces:
CertificationManagementInterface
,RelatedElementsManagementInterface
public class CertificationManager
extends GovernanceProgramBaseClient
implements CertificationManagementInterface
CertificationManager is the java client for managing certification types and the certification of elements.
-
Field Summary
Fields inherited from class org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient
nullRequestBody
-
Constructor Summary
ConstructorDescriptionCertificationManager
(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 TypeMethodDescriptioncertifyElement
(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.createCertificationType
(String userId, CertificationTypeProperties properties, GovernanceDefinitionStatus initialStatus) Create a description of the certification type.void
decertifyElement
(String userId, String certificationGUID) Remove the certification for an element.void
deleteCertificationType
(String userId, String certificationTypeGUID) Delete the properties of the certification type.getCertifications
(String userId, String elementGUID, int startFrom, int pageSize) Return information about the certifications linked to an element.getCertificationTypeByDocId
(String userId, String documentIdentifier) Retrieve the certification type by its assigned unique document identifier.getCertificationTypeByDomainId
(String userId, int domainIdentifier, int startFrom, int pageSize) Retrieve all the certification type definitions for a specific governance domain.getCertificationTypeByGUID
(String userId, String certificationTypeGUID) Retrieve the certification type by the unique identifier assigned by this service when it was created.getCertificationTypesByTitle
(String userId, String title, int startFrom, int pageSize) Retrieve all the certification types for a particular title.getCertifiedElements
(String userId, String certificationTypeGUID, int startFrom, int pageSize) Return information about the elements linked to a certification.void
updateCertification
(String userId, String certificationGUID, 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 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
-
Constructor Details
-
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 toserverPlatformURLRoot
- the network address of the server running the OMAS REST services- 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 toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesuserId
- caller's userId embedded in all HTTP requestspassword
- 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 toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesmaxPageSize
- pre-initialized parameter limitauditLog
- 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 toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesuserId
- 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
-
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 from another OMAG Server.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesrestClient
- internal client for rest callsmaxPageSize
- pre-initialized parameter limit- Throws:
InvalidParameterException
- bad input parameters
-
-
Method Details
-
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 interfaceCertificationManagementInterface
- Parameters:
userId
- calling userproperties
- certification propertiesinitialStatus
- 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 uniquePropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 interfaceCertificationManagementInterface
- Parameters:
userId
- calling usercertificationTypeGUID
- identifier of the governance definition to changeisMergeUpdate
- are unspecified properties unchanged (true) or replaced with null?properties
- certification properties- Throws:
InvalidParameterException
- guid, documentIdentifier or userId is null; documentIdentifier is not uniquePropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 interfaceCertificationManagementInterface
- Parameters:
userId
- calling usercertificationTypeGUID
- identifier of the governance definition to delete- Throws:
InvalidParameterException
- guid or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 interfaceCertificationManagementInterface
- Parameters:
userId
- calling usercertificationTypeGUID
- identifier of the governance definition to retrieve- Returns:
- properties of the certification type
- Throws:
InvalidParameterException
- guid or userId is null; guid is not recognizedPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- 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 interfaceCertificationManagementInterface
- Parameters:
userId
- calling userdocumentIdentifier
- identifier to search for- Returns:
- properties of the matching certification type
- Throws:
InvalidParameterException
- documentIdentifier or userId is null; documentIdentifier is not recognizedPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getCertificationTypesByTitle
public List<CertificationTypeElement> getCertificationTypesByTitle(String userId, String title, int startFrom, int pageSize) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException Retrieve all the certification types for a particular title. The title can include regEx wildcards.- Specified by:
getCertificationTypesByTitle
in interfaceCertificationManagementInterface
- Parameters:
userId
- calling usertitle
- short description of the certificationstartFrom
- where to start from in the list of definitionspageSize
- max number of results to return in one call- Returns:
- list of matching certification types (null if no matching elements)
- Throws:
InvalidParameterException
- title or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getCertificationTypeByDomainId
public List<CertificationTypeElement> getCertificationTypeByDomainId(String userId, int domainIdentifier, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve all the certification type definitions for a specific governance domain.- Specified by:
getCertificationTypeByDomainId
in interfaceCertificationManagementInterface
- Parameters:
userId
- calling userdomainIdentifier
- identifier to search forstartFrom
- where to start from in the list of definitionspageSize
- 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 recognizedPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
certifyElement
public String 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 interfaceCertificationManagementInterface
- Parameters:
userId
- calling userelementGUID
- unique identifier of the element being certifiedcertificationTypeGUID
- unique identifier for the certification typeproperties
- the properties of the certification- Returns:
- unique identifier of the new relationship
- Throws:
InvalidParameterException
- one of the properties is invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
updateCertification
public void updateCertification(String userId, String certificationGUID, boolean isMergeUpdate, CertificationProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the properties of a certification.- Specified by:
updateCertification
in interfaceCertificationManagementInterface
- Parameters:
userId
- calling usercertificationGUID
- unique identifier of the certification relationship being updatedisMergeUpdate
- should the supplied properties overlay the existing properties or replace themproperties
- the properties of the certification- Throws:
InvalidParameterException
- one of the properties is invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
decertifyElement
public void decertifyElement(String userId, String certificationGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the certification for an element.- Specified by:
decertifyElement
in interfaceCertificationManagementInterface
- Parameters:
userId
- calling usercertificationGUID
- unique identifier of the certification relationship- Throws:
InvalidParameterException
- one of the properties is invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getCertifiedElements
public List<RelatedElement> getCertifiedElements(String userId, String certificationTypeGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return information about the elements linked to a certification.- Specified by:
getCertifiedElements
in interfaceCertificationManagementInterface
- Parameters:
userId
- calling usercertificationTypeGUID
- unique identifier for the certificationstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- properties of the certification
- Throws:
InvalidParameterException
- qualifiedName or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getCertifications
public List<RelatedElement> getCertifications(String userId, String elementGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return information about the certifications linked to an element.- Specified by:
getCertifications
in interfaceCertificationManagementInterface
- Parameters:
userId
- calling userelementGUID
- unique identifier for the certificationstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- properties of the certification
- Throws:
InvalidParameterException
- qualifiedName or userId is nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-