Package org.mycore.common.events

Class MCREvent

java.lang.Object

org.mycore.common.events.MCREvent

public class MCREvent
extends Object

Represents an event that occured in the MyCoRe system. Events are of a predefined event type like create, update, delete and an object type like object or file. They can be handled by MCREventHandler implementations. Events are automatically created by some MyCoRe components and are forwarded to the handlers by MCREventManager.

Author:

Frank Lützenkirchen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MCREvent.EventType	Pre-defined event types *
static enum	MCREvent.ObjectType	Pre-defined event objects *

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLASS_KEY
static final String	CLASS_OLD_KEY
static final String	DERIVATE_KEY
static final String	DERIVATE_OLD_KEY
static final String	FILEATTR_KEY
static final String	OBJECT_KEY
static final String	OBJECT_OLD_KEY
static final String	PATH_KEY
static final String	USER_KEY
static final String	USER_OLD_KEY

Constructor Summary

Constructors

Constructor	Description
MCREvent(MCREvent.ObjectType objType, MCREvent.EventType evtType)	Creates a new event object of the given object type (object, file) and event type (create, update, delete)

Method Summary

Modifier and Type	Method	Description
Set<Map.Entry<String,Object>>	entrySet()	return the entries of the event data (1x called in wfc.mail.MCRMailEventhandler)
Object	get(String key)	returns an object from event data
MCREvent.EventType	getEventType()	Returns the event type of this event
MCREvent.ObjectType	getObjectType()	Returns the object type of this event
void	put(String key, Object value)	adds an object to the event data

Methods inherited from class java.lang.Object

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

Field Details

PATH_KEY

public static final String PATH_KEY

See Also:

• Constant Field Values

FILEATTR_KEY

public static final String FILEATTR_KEY

See Also:

• Constant Field Values

OBJECT_KEY

public static final String OBJECT_KEY

See Also:

• Constant Field Values

OBJECT_OLD_KEY

public static final String OBJECT_OLD_KEY

See Also:

• Constant Field Values

DERIVATE_KEY

public static final String DERIVATE_KEY

See Also:

• Constant Field Values

DERIVATE_OLD_KEY

public static final String DERIVATE_OLD_KEY

See Also:

• Constant Field Values

USER_KEY

public static final String USER_KEY

See Also:

• Constant Field Values

USER_OLD_KEY

public static final String USER_OLD_KEY

See Also:

• Constant Field Values

CLASS_KEY

public static final String CLASS_KEY

See Also:

• Constant Field Values

CLASS_OLD_KEY

public static final String CLASS_OLD_KEY

See Also:

• Constant Field Values

Constructor Details

MCREvent

public MCREvent(MCREvent.ObjectType objType,
 MCREvent.EventType evtType)

Creates a new event object of the given object type (object, file) and event type (create, update, delete)

Method Details

getObjectType

public MCREvent.ObjectType getObjectType()

Returns the object type of this event

Returns:

the object type of this event

getEventType

public MCREvent.EventType getEventType()

Returns the event type of this event

Returns:

the event type of this event

get

public Object get(String key)

returns an object from event data

Parameters:

key - - the object key

Returns:

an object from event data

put

public void put(String key,
 Object value)

adds an object to the event data

Parameters:

key - - the key for the object

value - - the object itself

entrySet

public Set<Map.Entry<String,Object>> entrySet()

return the entries of the event data (1x called in wfc.mail.MCRMailEventhandler)

Returns:

the entrySet of the the data of the event