Package com.evolveum.midpoint.certification.api

Interface CertificationManager

public interface CertificationManager

BEWARE: CertificationManager is responsible for authorizing all actions carried out through it.

Author:

mederly

Method Summary

Modifier and Type	Method	Description
void	cleanupCampaigns(@NotNull CleanupPolicyType policy, Task task, OperationResult result)
void	closeCampaign(String campaignOid, Task task, OperationResult result)	Closes a campaign.
void	closeCurrentStage(String campaignOid, Task task, OperationResult parentResult)	Opens the next stage in the certification campaign.
int	countOpenWorkItems(ObjectQuery caseQuery, boolean notDecidedOnly, boolean allItems, Collection<SelectorOptions<GetOperationOptions>> options, Task task, OperationResult parentResult)
default int	countOpenWorkItems(ObjectQuery caseQuery, boolean notDecidedOnly, Collection<SelectorOptions<GetOperationOptions>> options, Task task, OperationResult parentResult)
AccessCertificationCampaignType	createCampaign(String definitionOid, Task task, OperationResult parentResult)	Creates a certification campaign: creates AccessCertificationCampaignType object, based on general information in certification definition.
AccessCertificationCasesStatisticsType	getCampaignStatistics(String campaignOid, boolean currentStageOnly, Task task, OperationResult parentResult)	Provides statistical information about outcomes of cases in a given campaign.
void	openNextStage(String campaignOid, Task task, OperationResult parentResult)	Opens the next review stage in the certification campaign.
void	recordDecision(String campaignOid, long caseId, long workItemId, AccessCertificationResponseType response, String comment, Task task, OperationResult parentResult)	Records a particular decision of a reviewer.
void	registerCertificationEventListener(AccessCertificationEventListener listener)
void	reiterateCampaign(String campaignOid, Task task, OperationResult result)	Reiterates a closed campaign.
List<AccessCertificationWorkItemType>	searchOpenWorkItems(ObjectQuery caseQuery, boolean notDecidedOnly, boolean allItems, Collection<SelectorOptions<GetOperationOptions>> options, Task task, OperationResult parentResult)	Returns a set of certification work items for currently logged-in user (or all users).
default List<AccessCertificationWorkItemType>	searchOpenWorkItems(ObjectQuery caseQuery, boolean notDecidedOnly, Collection<SelectorOptions<GetOperationOptions>> options, Task task, OperationResult parentResult)
void	startRemediation(String campaignOid, Task task, OperationResult result)	Starts the remediation phase for the campaign.

Method Detail

createCampaign

AccessCertificationCampaignType createCampaign(String definitionOid,
                                               Task task,
                                               OperationResult parentResult)
                                        throws SchemaException,
                                               SecurityViolationException,
                                               ObjectNotFoundException,
                                               ObjectAlreadyExistsException,
                                               ExpressionEvaluationException,
                                               CommunicationException,
                                               ConfigurationException

Creates a certification campaign: creates AccessCertificationCampaignType object, based on general information in certification definition. Mandatory information in the certification definition are: - definition name - definition description - handlerUri - scope definition - stage(s) definition Optional information in the certification definition: - tenant reference Owner of newly created campaign is the currently logged-on user. The campaign will NOT be started upon creation. It should be started explicitly by calling openNextStage method.

Parameters:

definitionOid - OID of certification definition for this campaign.

task - Task in context of which all operations will take place.

parentResult - Result for the operations.

Returns:

Object for the created campaign. It will be stored in the repository as well.

Throws:

SchemaException

SecurityViolationException

ObjectNotFoundException

ObjectAlreadyExistsException

ExpressionEvaluationException

CommunicationException

ConfigurationException

openNextStage

void openNextStage(String campaignOid,
                   Task task,
                   OperationResult parentResult)
            throws SchemaException,
                   SecurityViolationException,
                   ObjectNotFoundException,
                   ObjectAlreadyExistsException,
                   ExpressionEvaluationException,
                   CommunicationException,
                   ConfigurationException

Opens the next review stage in the certification campaign. If the stage being opened is the first stage, certification cases will be generated for the campaign, depending on the certification definition (scope and handler). In all stages, reviewers will be assigned to cases, based again on the definition (reviewer specification in stage definition and handler).

Parameters:

campaignOid - Certification campaign OID.

task - Task in context of which all operations will take place.

parentResult - Result for the operations.

Throws:

SchemaException

SecurityViolationException

ObjectNotFoundException

ObjectAlreadyExistsException

ExpressionEvaluationException

CommunicationException

ConfigurationException

closeCurrentStage

void closeCurrentStage(String campaignOid,
                       Task task,
                       OperationResult parentResult)
                throws SchemaException,
                       SecurityViolationException,
                       ObjectNotFoundException,
                       ObjectAlreadyExistsException,
                       ExpressionEvaluationException,
                       CommunicationException,
                       ConfigurationException

Opens the next stage in the certification campaign. If the stage being opened is the first stage, certification cases will be generated for the campaign, depending on the certification definition (scope and handler). In all stages, reviewers will be assigned to cases, based again on the definition (reviewer specification in stage definition and handler).

Parameters:

campaignOid - Certification campaign OID.

task - Task in context of which all operations will take place.

parentResult - Result for the operations.

Throws:

SchemaException

SecurityViolationException

ObjectNotFoundException

ObjectAlreadyExistsException

ExpressionEvaluationException

CommunicationException

ConfigurationException

startRemediation

void startRemediation(String campaignOid,
                      Task task,
                      OperationResult result)
               throws ObjectNotFoundException,
                      SchemaException,
                      SecurityViolationException,
                      ObjectAlreadyExistsException,
                      ExpressionEvaluationException,
                      CommunicationException,
                      ConfigurationException

Starts the remediation phase for the campaign. The campaign has to be in the last stage and that stage has to be already closed.

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

ObjectAlreadyExistsException

ExpressionEvaluationException

CommunicationException

ConfigurationException

closeCampaign

void closeCampaign(String campaignOid,
                   Task task,
                   OperationResult result)
            throws ObjectNotFoundException,
                   SchemaException,
                   SecurityViolationException,
                   ObjectAlreadyExistsException,
                   ExpressionEvaluationException,
                   CommunicationException,
                   ConfigurationException

Closes a campaign.

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

ObjectAlreadyExistsException

ExpressionEvaluationException

CommunicationException

ConfigurationException

reiterateCampaign

void reiterateCampaign(String campaignOid,
                       Task task,
                       OperationResult result)
                throws ObjectNotFoundException,
                       SchemaException,
                       SecurityViolationException,
                       ObjectAlreadyExistsException,
                       ExpressionEvaluationException,
                       CommunicationException,
                       ConfigurationException

Reiterates a closed campaign.

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

ObjectAlreadyExistsException

ExpressionEvaluationException

CommunicationException

ConfigurationException

searchOpenWorkItems

List<AccessCertificationWorkItemType> searchOpenWorkItems(ObjectQuery caseQuery,
                                                          boolean notDecidedOnly,
                                                          boolean allItems,
                                                          Collection<SelectorOptions<GetOperationOptions>> options,
                                                          Task task,
                                                          OperationResult parentResult)
                                                   throws ObjectNotFoundException,
                                                          SchemaException,
                                                          SecurityViolationException,
                                                          ExpressionEvaluationException,
                                                          CommunicationException,
                                                          ConfigurationException

Returns a set of certification work items for currently logged-in user (or all users). Query argument for cases is the same as in the model.searchContainers(AccessCertificationCaseType...) call.

Parameters:

caseQuery - Specification of the cases to retrieve.

notDecidedOnly - If true, only response==(NO_DECISION or null) should be returned. Although it can be formulated in Query API terms, this would refer to implementation details - so the cleaner way is keep this knowledge inside certification module only.

allItems - If true, retrieves work items for all users. Requires root ("ALL") authorization.

options - Options to use (e.g. RESOLVE_NAMES).

task - Task in context of which all operations will take place.

parentResult - Result for the operations.

Returns:

A list of relevant certification cases.

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

ExpressionEvaluationException

CommunicationException

ConfigurationException

searchOpenWorkItems

default List<AccessCertificationWorkItemType> searchOpenWorkItems(ObjectQuery caseQuery,
                                                                  boolean notDecidedOnly,
                                                                  Collection<SelectorOptions<GetOperationOptions>> options,
                                                                  Task task,
                                                                  OperationResult parentResult)
                                                           throws ObjectNotFoundException,
                                                                  SchemaException,
                                                                  SecurityViolationException,
                                                                  ExpressionEvaluationException,
                                                                  CommunicationException,
                                                                  ConfigurationException

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

ExpressionEvaluationException

CommunicationException

ConfigurationException

countOpenWorkItems

int countOpenWorkItems(ObjectQuery caseQuery,
                       boolean notDecidedOnly,
                       boolean allItems,
                       Collection<SelectorOptions<GetOperationOptions>> options,
                       Task task,
                       OperationResult parentResult)
                throws ObjectNotFoundException,
                       SchemaException,
                       SecurityViolationException,
                       ExpressionEvaluationException,
                       CommunicationException,
                       ConfigurationException

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

ExpressionEvaluationException

CommunicationException

ConfigurationException

countOpenWorkItems

default int countOpenWorkItems(ObjectQuery caseQuery,
                               boolean notDecidedOnly,
                               Collection<SelectorOptions<GetOperationOptions>> options,
                               Task task,
                               OperationResult parentResult)
                        throws ObjectNotFoundException,
                               SchemaException,
                               SecurityViolationException,
                               ExpressionEvaluationException,
                               CommunicationException,
                               ConfigurationException

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

ExpressionEvaluationException

CommunicationException

ConfigurationException

recordDecision

void recordDecision(String campaignOid,
                    long caseId,
                    long workItemId,
                    AccessCertificationResponseType response,
                    String comment,
                    Task task,
                    OperationResult parentResult)
             throws ObjectNotFoundException,
                    SchemaException,
                    SecurityViolationException,
                    ObjectAlreadyExistsException,
                    ExpressionEvaluationException,
                    CommunicationException,
                    ConfigurationException

Records a particular decision of a reviewer.

Parameters:

campaignOid - OID of the campaign to which the decision belongs.

caseId - ID of the certification case to which the decision belongs.

workItemId - ID of the work item to which the decision belongs.

response - The response.

comment - Reviewer's comment.

task - Task in context of which all operations will take place.

parentResult - Result for the operations.

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

ObjectAlreadyExistsException

ExpressionEvaluationException

CommunicationException

ConfigurationException

getCampaignStatistics

AccessCertificationCasesStatisticsType getCampaignStatistics(String campaignOid,
                                                             boolean currentStageOnly,
                                                             Task task,
                                                             OperationResult parentResult)
                                                      throws ObjectNotFoundException,
                                                             SchemaException,
                                                             SecurityViolationException,
                                                             ObjectAlreadyExistsException,
                                                             ExpressionEvaluationException,
                                                             CommunicationException,
                                                             ConfigurationException

Provides statistical information about outcomes of cases in a given campaign. Doesn't require special authorization. Delegates authorization decisions to model (i.e. requires READ authorization on the campaign object).

Parameters:

campaignOid - OID of the campaign to report on

currentStageOnly - Whether to report on stage outcomes for current-stage cases (if true), or to report on overall outcomes of all cases (if false).

task - Task in context of which all operations will take place.

parentResult - Result for the operations.

Returns:

filled-in statistics object

Throws:

ObjectNotFoundException

SchemaException

SecurityViolationException

ObjectAlreadyExistsException

ExpressionEvaluationException

CommunicationException

ConfigurationException

registerCertificationEventListener

void registerCertificationEventListener(AccessCertificationEventListener listener)

cleanupCampaigns

void cleanupCampaigns(@NotNull
                      @NotNull CleanupPolicyType policy,
                      Task task,
                      OperationResult result)