Package com.evolveum.midpoint.audit.api

Class AuditEventRecord

java.lang.Object

com.evolveum.midpoint.audit.api.AuditEventRecord

All Implemented Interfaces:

DebugDumpable, Serializable

public class AuditEventRecord
extends Object
implements DebugDumpable, Serializable

Audit event record describes a single event (usually data change) in a format suitable for audit. This is more or less equivalent to AuditEventRecordType.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
AuditEventRecord()
AuditEventRecord(AuditEventType eventType)
AuditEventRecord(AuditEventType eventType, AuditEventStage eventStage)

Method Summary

Modifier and Type	Method	Description
void	addDelta(ObjectDeltaOperation<? extends ObjectType> delta)
void	addDeltas(Collection<? extends ObjectDeltaOperation<? extends ObjectType>> deltasToAdd)
void	addNonExistingReferencedObject(String oid)
void	addPropertyValue(String key, String value)
void	addPropertyValueIgnoreNull(String key, Object value)
void	addReferenceValue(String key, @NotNull AuditReferenceValue value)
void	addReferenceValue(String key, @NotNull PrismReferenceValue prv)
void	addReferenceValueIgnoreNull(String key, ObjectReferenceType value)
void	addReferenceValues(String key, @NotNull List<ObjectReferenceType> values)
void	addResourceOid(String resourceOid)
static void	adopt(AuditEventRecordType record, PrismContext prismContext)
static void	adopt(ObjectDeltaType delta, PrismContext prismContext)
void	checkConsistence()
void	clearDeltas()
void	clearTimestamp()
AuditEventRecord	clone()
AuditEventRecordType	createAuditEventRecordType(boolean tolerateInconsistencies)
String	debugDump(int indent)
PrismReferenceValue	getAttorneyRef()	Attorney is the (physical) user who have executed the action.
String	getChannel()
Map<String,String>	getCustomColumnProperty()
@NotNull Collection<ObjectDeltaOperation<? extends ObjectType>>	getDeltas()
String	getEventIdentifier()
AuditEventStage	getEventStage()
AuditEventType	getEventType()
String	getHostIdentifier()
PrismReferenceValue	getInitiatorRef()	Initiator is the (legal) entity on behalf of whom is the action executed.
String	getMessage()
String	getNodeIdentifier()
@NotNull Set<String>	getNonExistingReferencedObjects()
OperationResultStatus	getOutcome()
String	getParameter()
Map<String,Set<String>>	getProperties()
Set<String>	getPropertyValues(String name)
Map<String,Set<AuditReferenceValue>>	getReferences()
Set<AuditReferenceValue>	getReferenceValues(String name)
String	getRemoteHostAddress()
Long	getRepoId()
String	getRequestIdentifier()
Set<String>	getResourceOids()
String	getResult()
String	getSessionIdentifier()
PrismReferenceValue	getTargetOwnerRef()
PrismReferenceValue	getTargetRef()
String	getTaskIdentifier()
String	getTaskOid()
Long	getTimestamp()
void	setAttorney(PrismObject<? extends FocusType> attorney, PrismContext prismContext)
void	setAttorneyRef(PrismReferenceValue attorneyRef)	It is assumed the ref has oid, type and description set.
void	setChannel(String channel)
void	setEventIdentifier(String eventIdentifier)
void	setEventStage(AuditEventStage eventStage)
void	setEventType(AuditEventType eventType)
void	setHostIdentifier(String hostIdentifier)
void	setInitiator(PrismObject<? extends FocusType> initiator, PrismContext prismContext)
void	setInitiatorAndLoginParameter(PrismObject<? extends FocusType> initiator, PrismContext prismContext)
void	setInitiatorRef(PrismReferenceValue initiator)	It is assumed the ref has oid, type and description set.
void	setMessage(String message)
void	setNodeIdentifier(String nodeIdentifier)
void	setOutcome(OperationResultStatus outcome)
void	setParameter(String parameter)
void	setRemoteHostAddress(String remoteHostAddress)
void	setRepoId(Long repoId)
void	setRequestIdentifier(String requestIdentifier)
void	setResourceOids(Set<String> resourceOids)
void	setResult(String result)
void	setSessionIdentifier(String sessionIdentifier)
void	setTarget(PrismObject<?> target, PrismContext prismContext)
void	setTargetOwner(PrismObject<? extends FocusType> targetOwner, PrismContext prismContext)
void	setTargetOwnerRef(PrismReferenceValue targetOwnerRef)	It is assumed the ref has oid, type and description set.
void	setTargetRef(PrismReferenceValue target)	It is assumed the ref has oid, type and description set.
void	setTaskIdentifier(String taskIdentifier)
void	setTaskOid(String taskOid)
void	setTimestamp(Long timestamp)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDump, debugDumpLazily, debugDumpLazily

Constructor Detail

AuditEventRecord

public AuditEventRecord()

AuditEventRecord

public AuditEventRecord(AuditEventType eventType)

AuditEventRecord

public AuditEventRecord(AuditEventType eventType,
                        AuditEventStage eventStage)

Method Detail

getTimestamp

public Long getTimestamp()

clearTimestamp

public void clearTimestamp()

setTimestamp

public void setTimestamp(Long timestamp)

getEventIdentifier

public String getEventIdentifier()

setEventIdentifier

public void setEventIdentifier(String eventIdentifier)

getSessionIdentifier

public String getSessionIdentifier()

setSessionIdentifier

public void setSessionIdentifier(String sessionIdentifier)

getRequestIdentifier

public String getRequestIdentifier()

setRequestIdentifier

public void setRequestIdentifier(String requestIdentifier)

getTaskIdentifier

public String getTaskIdentifier()

setTaskIdentifier

public void setTaskIdentifier(String taskIdentifier)

getTaskOid

public String getTaskOid()

setTaskOid

public void setTaskOid(String taskOid)

getHostIdentifier

public String getHostIdentifier()

setHostIdentifier

public void setHostIdentifier(String hostIdentifier)

getNodeIdentifier

public String getNodeIdentifier()

setNodeIdentifier

public void setNodeIdentifier(String nodeIdentifier)

getRemoteHostAddress

public String getRemoteHostAddress()

setRemoteHostAddress

public void setRemoteHostAddress(String remoteHostAddress)

setInitiator

public void setInitiator(PrismObject<? extends FocusType> initiator,
                         PrismContext prismContext)

getInitiatorRef

public PrismReferenceValue getInitiatorRef()

Initiator is the (legal) entity on behalf of whom is the action executed. It is the subject of the operation. Authorizations of the initiator are used to evaluate access to the operation. This is the entity who is formally responsible for the operation. Although initiator is always a user in midPoint 3.7 and earlier, the initiator may be an organization in later midPoint versions.

setInitiatorRef

public void setInitiatorRef(PrismReferenceValue initiator)

It is assumed the ref has oid, type and description set.

setAttorney

public void setAttorney(PrismObject<? extends FocusType> attorney,
                        PrismContext prismContext)

getAttorneyRef

public PrismReferenceValue getAttorneyRef()

Attorney is the (physical) user who have executed the action. This is the user that have logged-in to the user interface. This is the user that pressed the button to execute the action. This is always identity of a user and it will always be a user. It cannot be a company or any other virtual entity.

setAttorneyRef

public void setAttorneyRef(PrismReferenceValue attorneyRef)

It is assumed the ref has oid, type and description set.

getTargetRef

public PrismReferenceValue getTargetRef()

setTargetRef

public void setTargetRef(PrismReferenceValue target)

It is assumed the ref has oid, type and description set.

setTarget

public void setTarget(PrismObject<?> target,
                      PrismContext prismContext)

setTargetOwner

public void setTargetOwner(PrismObject<? extends FocusType> targetOwner,
                           PrismContext prismContext)

getTargetOwnerRef

public PrismReferenceValue getTargetOwnerRef()

setTargetOwnerRef

public void setTargetOwnerRef(PrismReferenceValue targetOwnerRef)

It is assumed the ref has oid, type and description set.

getEventType

public AuditEventType getEventType()

setEventType

public void setEventType(AuditEventType eventType)

getEventStage

public AuditEventStage getEventStage()

setEventStage

public void setEventStage(AuditEventStage eventStage)

getDeltas

@NotNull
public @NotNull Collection<ObjectDeltaOperation<? extends ObjectType>> getDeltas()

addDelta

public void addDelta(ObjectDeltaOperation<? extends ObjectType> delta)

addDeltas

public void addDeltas(Collection<? extends ObjectDeltaOperation<? extends ObjectType>> deltasToAdd)

getChannel

public String getChannel()

setChannel

public void setChannel(String channel)

clearDeltas

public void clearDeltas()

getOutcome

public OperationResultStatus getOutcome()

setOutcome

public void setOutcome(OperationResultStatus outcome)

setResult

public void setResult(String result)

getResult

public String getResult()

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getParameter

public String getParameter()

setParameter

public void setParameter(String parameter)

getRepoId

public Long getRepoId()

setRepoId

public void setRepoId(Long repoId)

getProperties

public Map<String,Set<String>> getProperties()

getPropertyValues

public Set<String> getPropertyValues(String name)

getReferences

public Map<String,Set<AuditReferenceValue>> getReferences()

getReferenceValues

public Set<AuditReferenceValue> getReferenceValues(String name)

getCustomColumnProperty

public Map<String,String> getCustomColumnProperty()

getResourceOids

public Set<String> getResourceOids()

setResourceOids

public void setResourceOids(Set<String> resourceOids)

addResourceOid

public void addResourceOid(String resourceOid)

addPropertyValue

public void addPropertyValue(String key,
                             String value)

addPropertyValueIgnoreNull

public void addPropertyValueIgnoreNull(String key,
                                       Object value)

addReferenceValueIgnoreNull

public void addReferenceValueIgnoreNull(String key,
                                        ObjectReferenceType value)

addReferenceValue

public void addReferenceValue(String key,
                              @NotNull
                              @NotNull AuditReferenceValue value)

addReferenceValue

public void addReferenceValue(String key,
                              @NotNull
                              @NotNull PrismReferenceValue prv)

addReferenceValues

public void addReferenceValues(String key,
                               @NotNull
                               @NotNull List<ObjectReferenceType> values)

checkConsistence

public void checkConsistence()

createAuditEventRecordType

public AuditEventRecordType createAuditEventRecordType(boolean tolerateInconsistencies)

clone

public AuditEventRecord clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

adopt

public static void adopt(AuditEventRecordType record,
                         PrismContext prismContext)
                  throws SchemaException

Throws:

SchemaException

adopt

public static void adopt(ObjectDeltaType delta,
                         PrismContext prismContext)
                  throws SchemaException

Throws:

SchemaException

setInitiatorAndLoginParameter

public void setInitiatorAndLoginParameter(PrismObject<? extends FocusType> initiator,
                                          PrismContext prismContext)

getNonExistingReferencedObjects

@NotNull
public @NotNull Set<String> getNonExistingReferencedObjects()

addNonExistingReferencedObject

public void addNonExistingReferencedObject(String oid)