org.ametys.plugins.workspaces.events.documents

Class DocumentsEventType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.repository.events.DefaultEventType

org.ametys.plugins.workspaces.events.WorkspacesEventType

org.ametys.plugins.workspaces.events.documents.DocumentsEventType

All Implemented Interfaces:

EventType, LogEnabled, PluginAware, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

ResourceCreatedOrUpdatedEventType, ResourceRenamedEventType

public class DocumentsEventType
extends WorkspacesEventType
implements Contextualizable

EventType implementation for documents-related events

Field Summary

Fields

Modifier and Type	Field and Description
protected AmetysObjectResolver	_ametysObjectResolver Resolver for Ametys objects
private Context	_context
private DocumentWorkspaceModule	_documentModule
private I18nUtils	_i18nUtils
static String	EVENT_CATEGORY_DOCUMENTS Constant for event's category
static String	EVENT_PARENT_FOLDER_ID_PROPERTY Constant for parent folder's event property
static String	EVENT_PARENT_FOLDER_PROPERTY Constant for parent folder's event property

Fields inherited from class org.ametys.plugins.workspaces.events.WorkspacesEventType

_projectManager, EVENT_PROJECT_CATEGORY_PROPERTY, EVENT_PROJECT_NAME_PROPERTY, EVENT_PROJECT_TITLE_PROPERTY

Fields inherited from class org.ametys.plugins.repository.events.DefaultEventType

_currentUserProvider, _userHelper

Fields inherited from interface org.ametys.plugins.repository.events.EventType

EVENT_AUTHOR, EVENT_DATE, EVENT_TYPE

Constructor Summary

Constructors

Constructor and Description
DocumentsEventType()

Method Summary

Modifier and Type	Method and Description
void	contextualize(Context context)
Map<String,Object>	event2JSON(Node eventNode) Format an event node to JSON
boolean	isMergeable(Map<String,Object> event1, Map<String,Object> event2) Determines if two events can be merged
Map<String,Object>	mergeEvents(List<Map<String,Object>> events) Merge events into one event.
void	service(ServiceManager serviceManager)
protected void	storeAdditionalEventData(Node eventNode, Map<String,Object> parameters) Store additional data on event

Methods inherited from class org.ametys.plugins.repository.events.DefaultEventType

_getAuthor, configure, getSupportedTypes, setPluginInfo, storeEvent

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_CATEGORY_DOCUMENTS

public static final String EVENT_CATEGORY_DOCUMENTS

Constant for event's category

See Also:

Constant Field Values

EVENT_PARENT_FOLDER_PROPERTY

public static final String EVENT_PARENT_FOLDER_PROPERTY

Constant for parent folder's event property

See Also:

Constant Field Values

EVENT_PARENT_FOLDER_ID_PROPERTY

public static final String EVENT_PARENT_FOLDER_ID_PROPERTY

Constant for parent folder's event property

See Also:

Constant Field Values

_ametysObjectResolver

protected AmetysObjectResolver _ametysObjectResolver

Resolver for Ametys objects

_i18nUtils

private I18nUtils _i18nUtils

_documentModule

private DocumentWorkspaceModule _documentModule

_context

private Context _context

Constructor Detail

DocumentsEventType

public DocumentsEventType()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class WorkspacesEventType

Throws:

ServiceException

storeAdditionalEventData

protected void storeAdditionalEventData(Node eventNode,
                                        Map<String,Object> parameters)
                                 throws RepositoryException

Description copied from class: DefaultEventType

Store additional data on event

Overrides:

storeAdditionalEventData in class WorkspacesEventType

Parameters:

eventNode - The event node

parameters - The event's parameters

Throws:

RepositoryException - if an error occurred

event2JSON

public Map<String,Object> event2JSON(Node eventNode)
                              throws RepositoryException

Description copied from interface: EventType

Format an event node to JSON

Specified by:

event2JSON in interface EventType

Overrides:

event2JSON in class WorkspacesEventType

Parameters:

eventNode - the node of an event

Returns:

the JSON for the node

Throws:

RepositoryException - if an error occurs while manipulating the repository

isMergeable

public boolean isMergeable(Map<String,Object> event1,
                           Map<String,Object> event2)

Description copied from interface: EventType

Determines if two events can be merged

Specified by:

isMergeable in interface EventType

Overrides:

isMergeable in class WorkspacesEventType

Parameters:

event1 - The first event

event2 - The second event

Returns:

true if the events can be merged

mergeEvents

public Map<String,Object> mergeEvents(List<Map<String,Object>> events)

Description copied from interface: EventType

Merge events into one event. Be careful : be sure that the events can be merged calling isMergeable method before

Specified by:

mergeEvents in interface EventType

Overrides:

mergeEvents in class DefaultEventType

Parameters:

events - The events to merge

Returns:

Merged event