org.ametys.plugins.workspaces.events.activitystream

Class ActivityStreamClientInteraction

java.lang.Object

org.ametys.plugins.workspaces.events.activitystream.ActivityStreamClientInteraction

All Implemented Interfaces:

PluginAware, Component, Serviceable

public class ActivityStreamClientInteraction
extends Object
implements Component, Serviceable, PluginAware

Component gathering methods for the activity stream service

Field Summary

Fields

Modifier and Type	Field and Description
private CurrentUserProvider	_currentUserProvider
private EventTypeExtensionPoint	_eventTypeExtensionPoint
private String	_pluginName
private ProjectManager	_projectManager
private Repository	_repository
private RightManager	_rightManager
static String	ROLE The Avalon role

Constructor Summary

Constructors

Constructor and Description
ActivityStreamClientInteraction()

Method Summary

Modifier and Type	Method and Description
private void	_classifyEventType(Map<String,Map<String,Object>> allowedEventTypes, String eventTypeId, I18nizableText eventTypeLabel)
private Set<String>	_getAllowedEventTypesByProject(Project project)
private String	_getXPathQuery(Expression expr, SortCriteria sortCriteria)
private NodeIterator	_query(String jcrQuery)
Set<String>	getAllowedEventTypes(List<Project> projects) Get the list of allowed event types for the given projects
Map<String,Map<String,Object>>	getAllowedEventTypes(String projectName) Get the allowed event types classified by categories
List<Map<String,Object>>	getEvents(List<String> projectNames, List<String> filterEventTypes, int limit) Get the events of the given projects and of the given event types
List<Map<String,Object>>	getProjectEvents(String projectName, List<String> filterEventTypes, int limit) Get the events of the given project and of the given event types
void	service(ServiceManager serviceManager)
void	setPluginInfo(String pluginName, String featureName, String id) Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

_projectManager

private ProjectManager _projectManager

_eventTypeExtensionPoint

private EventTypeExtensionPoint _eventTypeExtensionPoint

_currentUserProvider

private CurrentUserProvider _currentUserProvider

_rightManager

private RightManager _rightManager

_repository

private Repository _repository

_pluginName

private String _pluginName

Constructor Detail

ActivityStreamClientInteraction

public ActivityStreamClientInteraction()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getProjectEvents

public List<Map<String,Object>> getProjectEvents(String projectName,
                                                 List<String> filterEventTypes,
                                                 int limit)
                                          throws RepositoryException

Get the events of the given project and of the given event types

Parameters:

projectName - the project's name

filterEventTypes - the type of events to retain

limit - The max number of events

Returns:

the retained events

Throws:

RepositoryException - if an error occurs while manipulating the repository

getEvents

public List<Map<String,Object>> getEvents(List<String> projectNames,
                                          List<String> filterEventTypes,
                                          int limit)
                                   throws RepositoryException

Get the events of the given projects and of the given event types

Parameters:

projectNames - the names of the projects. Can not be null.

filterEventTypes - the type of events to retain. Can be empty to get all events.

limit - The max number of events

Returns:

the retained events

Throws:

RepositoryException - if an error occurs while manipulating the repository

_getXPathQuery

private String _getXPathQuery(Expression expr,
                              SortCriteria sortCriteria)

_query

private NodeIterator _query(String jcrQuery)

getAllowedEventTypes

public Map<String,Map<String,Object>> getAllowedEventTypes(String projectName)

Get the allowed event types classified by categories

Parameters:

projectName - The project's name

Returns:

The allowed event types

_classifyEventType

private void _classifyEventType(Map<String,Map<String,Object>> allowedEventTypes,
                                String eventTypeId,
                                I18nizableText eventTypeLabel)

getAllowedEventTypes

public Set<String> getAllowedEventTypes(List<Project> projects)

Get the list of allowed event types for the given projects

Parameters:

projects - The projects

Returns:

The allowed event types

_getAllowedEventTypesByProject

private Set<String> _getAllowedEventTypesByProject(Project project)