Package com.evolveum.midpoint.notifications.api.events

Class BaseEvent

java.lang.Object

com.evolveum.midpoint.notifications.api.events.BaseEvent

All Implemented Interfaces:

Event, DebugDumpable, ShortDumpable

Direct Known Subclasses:

AccessCertificationEvent, CustomEvent, ModelEvent, PolicyRuleEvent, ResourceObjectEvent, TaskEvent, WorkflowEvent

public abstract class BaseEvent
extends Object
implements Event, DebugDumpable, ShortDumpable

Author:

mederly

Field Summary

Fields

Modifier and Type	Field	Description
protected EventHandlerType	adHocHandler	If needed, we can prescribe the handler that should process this event.

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
BaseEvent(LightweightIdentifierGenerator lightweightIdentifierGenerator)
BaseEvent(LightweightIdentifierGenerator lightweightIdentifierGenerator, EventHandlerType adHocHandler)

Method Summary

Modifier and Type	Method	Description
<O extends ObjectType> boolean	containsItem(ObjectDelta<O> delta, ItemPath itemPath)
boolean	containsItem(List<ObjectDelta<FocusType>> deltas, ItemPath itemPath)
void	createExpressionVariables(VariablesMap variables, OperationResult result)
protected void	debugDumpCommon(StringBuilder sb, int indent)
EventHandlerType	getAdHocHandler()	If needed, we can prescribe the handler that should process this event.
String	getChannel()
LightweightIdentifier	getId()
NotificationFunctions	getNotificationFunctions()
PrismContext	getPrismContext()
SimpleObjectRef	getRequestee()
PolyStringType	getRequesteeDisplayName()
PolyStringType	getRequesteeName()
ObjectType	getRequesteeObject()
String	getRequesteeOid()
SimpleObjectRef	getRequester()
PolyStringType	getRequesterDisplayName()
PolyStringType	getRequesterName()
ObjectType	getRequesterObject()
String	getRequesterOid()
String	getStatusAsText()
boolean	isAccountRelated()
boolean	isAdd()
boolean	isAlsoSuccess()
abstract boolean	isCategoryType(EventCategoryType eventCategoryType)
boolean	isCertCampaignStageRelated()
boolean	isDelete()
boolean	isFailure()
boolean	isInProgress()
boolean	isModify()
boolean	isOnlyFailure()
abstract boolean	isOperationType(EventOperationType eventOperationType)
boolean	isPolicyRuleRelated()
abstract boolean	isStatusType(EventStatusType eventStatusType)
boolean	isSuccess()
boolean	isUserRelated()
boolean	isWorkflowProcessRelated()
boolean	isWorkflowRelated()
boolean	isWorkItemRelated()
void	setChannel(String channel)
void	setNotificationFunctions(NotificationFunctions notificationFunctions)
void	setPrismContext(PrismContext prismContext)
void	setRequestee(SimpleObjectRef requestee)
void	setRequester(SimpleObjectRef requester)
void	shortDump(StringBuilder sb)	Show the content of the object intended for diagnostics.
String	toString()

Methods inherited from class java.lang.Object

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

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface com.evolveum.midpoint.notifications.api.events.Event

getFocusPassword, isRelatedToItem

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

shortDump, shortDumpLazily

Field Detail

adHocHandler

protected final EventHandlerType adHocHandler

If needed, we can prescribe the handler that should process this event. It is recommended only for ad-hoc situations. A better is to define handlers in system configuration.

Constructor Detail

BaseEvent

public BaseEvent(@NotNull
                 LightweightIdentifierGenerator lightweightIdentifierGenerator)

BaseEvent

public BaseEvent(@NotNull
                 LightweightIdentifierGenerator lightweightIdentifierGenerator,
                 EventHandlerType adHocHandler)

Method Detail

getId

public LightweightIdentifier getId()

Specified by:

getId in interface Event

toString

public String toString()

Overrides:

toString in class Object

isStatusType

public abstract boolean isStatusType(EventStatusType eventStatusType)

Specified by:

isStatusType in interface Event

isOperationType

public abstract boolean isOperationType(EventOperationType eventOperationType)

Specified by:

isOperationType in interface Event

isCategoryType

public abstract boolean isCategoryType(EventCategoryType eventCategoryType)

Specified by:

isCategoryType in interface Event

isAccountRelated

public boolean isAccountRelated()

Specified by:

isAccountRelated in interface Event

isUserRelated

public boolean isUserRelated()

Specified by:

isUserRelated in interface Event

isWorkItemRelated

public boolean isWorkItemRelated()

Specified by:

isWorkItemRelated in interface Event

isWorkflowProcessRelated

public boolean isWorkflowProcessRelated()

Specified by:

isWorkflowProcessRelated in interface Event

isWorkflowRelated

public boolean isWorkflowRelated()

Specified by:

isWorkflowRelated in interface Event

isPolicyRuleRelated

public boolean isPolicyRuleRelated()

Specified by:

isPolicyRuleRelated in interface Event

isCertCampaignStageRelated

public boolean isCertCampaignStageRelated()

isAdd

public boolean isAdd()

Specified by:

isAdd in interface Event

isModify

public boolean isModify()

Specified by:

isModify in interface Event

isDelete

public boolean isDelete()

Specified by:

isDelete in interface Event

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface Event

isAlsoSuccess

public boolean isAlsoSuccess()

Specified by:

isAlsoSuccess in interface Event

isFailure

public boolean isFailure()

Specified by:

isFailure in interface Event

isOnlyFailure

public boolean isOnlyFailure()

Specified by:

isOnlyFailure in interface Event

isInProgress

public boolean isInProgress()

Specified by:

isInProgress in interface Event

getRequester

public SimpleObjectRef getRequester()

Specified by:

getRequester in interface Event

getRequesterOid

public String getRequesterOid()

Specified by:

getRequesterOid in interface Event

setRequester

public void setRequester(SimpleObjectRef requester)

Specified by:

setRequester in interface Event

getRequestee

public SimpleObjectRef getRequestee()

Specified by:

getRequestee in interface Event

getRequesteeOid

public String getRequesteeOid()

Specified by:

getRequesteeOid in interface Event

getRequesteeObject

public ObjectType getRequesteeObject()

getRequesterObject

public ObjectType getRequesterObject()

getRequesteeDisplayName

public PolyStringType getRequesteeDisplayName()

getRequesterDisplayName

public PolyStringType getRequesterDisplayName()

getRequesteeName

public PolyStringType getRequesteeName()

getRequesterName

public PolyStringType getRequesterName()

setRequestee

public void setRequestee(SimpleObjectRef requestee)

Specified by:

setRequestee in interface Event

createExpressionVariables

public void createExpressionVariables(VariablesMap variables,
                                      OperationResult result)

Specified by:

createExpressionVariables in interface Event

containsItem

public <O extends ObjectType> boolean containsItem(ObjectDelta<O> delta,
                                                   ItemPath itemPath)

containsItem

public boolean containsItem(List<ObjectDelta<FocusType>> deltas,
                            ItemPath itemPath)

getChannel

public String getChannel()

Specified by:

getChannel in interface Event

setChannel

public void setChannel(String channel)

getNotificationFunctions

public NotificationFunctions getNotificationFunctions()

setNotificationFunctions

public void setNotificationFunctions(NotificationFunctions notificationFunctions)

getPrismContext

public PrismContext getPrismContext()

setPrismContext

public void setPrismContext(PrismContext prismContext)

getStatusAsText

public String getStatusAsText()

getAdHocHandler

public EventHandlerType getAdHocHandler()

Description copied from interface: Event

If needed, we can prescribe the handler that should process this event. It is recommended only for ad-hoc situations. A better is to define handlers in system configuration.

Specified by:

getAdHocHandler in interface Event

debugDumpCommon

protected void debugDumpCommon(StringBuilder sb,
                               int indent)

shortDump

public void shortDump(StringBuilder sb)

Description copied from interface: ShortDumpable

Show the content of the object intended for diagnostics. This method is supposed to append a compact, human-readable output in a single line. Unlike toString() method, there is no requirement to identify the actual class or type of the object. It is assumed that the class/type will be obvious from the context in which the output is used.

Specified by:

shortDump in interface ShortDumpable

Parameters:

sb - StringBuilder to which to a compact one-line content of the object intended for diagnostics by system administrator should be appended.