Package com.evolveum.midpoint.model.api

Interface ModelAuditService

public interface ModelAuditService

Author:

semancik

Method Summary

Modifier and Type	Method	Description
void	audit(com.evolveum.midpoint.audit.api.AuditEventRecord record, com.evolveum.midpoint.task.api.Task task, OperationResult result)
void	cleanupAudit(CleanupPolicyType policy, com.evolveum.midpoint.task.api.Task task, OperationResult parentResult)	Clean up audit records that are older than specified.
int	countObjects(@Nullable ObjectQuery query, @Nullable Collection<SelectorOptions<GetOperationOptions>> options, com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult parentResult)
<O extends ObjectType> PrismObject<O>	reconstructObject(Class<O> type, String oid, String eventIdentifier, com.evolveum.midpoint.task.api.Task task, OperationResult result)
@NotNull SearchResultList<AuditEventRecordType>	searchObjects(@Nullable ObjectQuery query, @Nullable Collection<SelectorOptions<GetOperationOptions>> options, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult parentResult)
void	searchObjectsIterative(@Nullable ObjectQuery query, @Nullable Collection<SelectorOptions<GetOperationOptions>> options, @NotNull com.evolveum.midpoint.audit.api.AuditResultHandler handler, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult parentResult)
boolean	supportsRetrieval()	Returns true if retrieval of objects from the audit trail is supported.

Method Detail

reconstructObject

<O extends ObjectType> PrismObject<O> reconstructObject(Class<O> type,
                                                        String oid,
                                                        String eventIdentifier,
                                                        com.evolveum.midpoint.task.api.Task task,
                                                        OperationResult result)
                                                 throws ObjectNotFoundException,
                                                        SchemaException

Throws:

ObjectNotFoundException

SchemaException

audit

void audit(com.evolveum.midpoint.audit.api.AuditEventRecord record,
           com.evolveum.midpoint.task.api.Task task,
           OperationResult result)
    throws SecurityViolationException,
           SchemaException,
           ObjectNotFoundException,
           ExpressionEvaluationException,
           CommunicationException,
           ConfigurationException

Throws:

SecurityViolationException

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

cleanupAudit

void cleanupAudit(CleanupPolicyType policy,
                  com.evolveum.midpoint.task.api.Task task,
                  OperationResult parentResult)
           throws SecurityViolationException,
                  SchemaException,
                  ObjectNotFoundException,
                  ExpressionEvaluationException,
                  CommunicationException,
                  ConfigurationException

Clean up audit records that are older than specified.

Parameters:

policy - Records will be deleted base on this policy.

Throws:

SecurityViolationException

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

countObjects

int countObjects(@Nullable
                 @Nullable ObjectQuery query,
                 @Nullable
                 @Nullable Collection<SelectorOptions<GetOperationOptions>> options,
                 com.evolveum.midpoint.task.api.Task task,
                 @NotNull
                 @NotNull OperationResult parentResult)
          throws SchemaException,
                 ExpressionEvaluationException,
                 SecurityViolationException,
                 CommunicationException,
                 ConfigurationException,
                 ObjectNotFoundException

Throws:

UnsupportedOperationException - if object retrieval is not supported

SchemaException

ExpressionEvaluationException

SecurityViolationException

CommunicationException

ConfigurationException

ObjectNotFoundException

searchObjects

@NotNull
@NotNull SearchResultList<AuditEventRecordType> searchObjects(@Nullable
                                                              @Nullable ObjectQuery query,
                                                              @Nullable
                                                              @Nullable Collection<SelectorOptions<GetOperationOptions>> options,
                                                              @NotNull
                                                              @NotNull com.evolveum.midpoint.task.api.Task task,
                                                              @NotNull
                                                              @NotNull OperationResult parentResult)
                                                       throws SecurityViolationException,
                                                              SchemaException,
                                                              ObjectNotFoundException,
                                                              ExpressionEvaluationException,
                                                              CommunicationException,
                                                              ConfigurationException

Throws:

UnsupportedOperationException - if object retrieval is not supported

SecurityViolationException

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

supportsRetrieval

boolean supportsRetrieval()

Returns true if retrieval of objects from the audit trail is supported. This applies to listRecords, countObjects, reconstructObject and similar operations.

searchObjectsIterative

void searchObjectsIterative(@Nullable
                            @Nullable ObjectQuery query,
                            @Nullable
                            @Nullable Collection<SelectorOptions<GetOperationOptions>> options,
                            @NotNull
                            @NotNull com.evolveum.midpoint.audit.api.AuditResultHandler handler,
                            @NotNull
                            @NotNull com.evolveum.midpoint.task.api.Task task,
                            @NotNull
                            @NotNull OperationResult parentResult)
                     throws SecurityViolationException,
                            SchemaException,
                            ObjectNotFoundException,
                            ExpressionEvaluationException,
                            CommunicationException,
                            ConfigurationException

Throws:

UnsupportedOperationException - if object retrieval is not supported

SecurityViolationException

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException