Package org.ametys.plugins.workspaces.activities.activitystream

Class ActivityStreamClientInteraction

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.activities.activitystream.ActivityStreamClientInteraction

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ActivityStreamClientInteraction
extends AbstractLogEnabled
implements Component, Serviceable

Component gathering methods for the activity stream service

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTIVITY_STREAM_USER_PREF_CONTEXT	the user preferences context for activity stream
static final String	ACTIVITY_STREAM_USER_PREF_LAST_UPDATE	the id of user preferences for the last update of activity stream
static final String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
ActivityStreamClientInteraction()

Method Summary

Modifier and Type	Method	Description
List<Map<String,Object>>	getActivities(List<String> projectNames, List<String> filterEventTypes, int limit)	Get the activities of the given projects and of the given event types
List<Map<String,Object>>	getActivitiesForCurrentUser(int limit)	Get the activities for the current user with the allowed event types get from the user projects.
List<Map<String,Object>>	getActivitiesForCurrentUser(Set<Project> projects, int limit)	Get the activities for the current user with the allowed event types get from the given projects.
Set<String>	getAllowedEventTypes(Set<Project> projects)	Get the list of allowed event types for the given projects
ZonedDateTime	getDateOfLastActivity(String projectName, List<String> excludeActivityTypes)	Get the date of last activity regardless the current user's rights
ZonedDateTime	getDateOfLastActivityByActivityType(String projectName, Collection<String> includeActivityTypes)	Get the date of last activity regardless the current user's rights
long	getNumberOfUnreadActivitiesForCurrentUser()	Get the number of unread events for the current user
void	service(ServiceManager serviceManager)

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 Details

ROLE

public static final String ROLE

The Avalon role

ACTIVITY_STREAM_USER_PREF_CONTEXT

public static final String ACTIVITY_STREAM_USER_PREF_CONTEXT

the user preferences context for activity stream

See Also:

• Constant Field Values

ACTIVITY_STREAM_USER_PREF_LAST_UPDATE

public static final String ACTIVITY_STREAM_USER_PREF_LAST_UPDATE

the id of user preferences for the last update of activity stream

See Also:

• Constant Field Values

Constructor Details

ActivityStreamClientInteraction

public ActivityStreamClientInteraction()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getActivities

public List<Map<String,Object>> getActivities(List<String> projectNames,
 List<String> filterEventTypes,
 int limit)

Get the activities 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 activities.

limit - The max number of activities

Returns:

the retained activities

getDateOfLastActivity

public ZonedDateTime getDateOfLastActivity(String projectName,
 List<String> excludeActivityTypes)

Get the date of last activity regardless the current user's rights

Parameters:

projectName - The project's name

excludeActivityTypes - the types of activity to ignore from this search

Returns:

the date of last activity or null if no activity found or an error occurred

getDateOfLastActivityByActivityType

public ZonedDateTime getDateOfLastActivityByActivityType(String projectName,
 Collection<String> includeActivityTypes)

Get the date of last activity regardless the current user's rights

Parameters:

projectName - The project's name

includeActivityTypes - the types of activity to ignore from this search

Returns:

the date of last activity or null if no activity found or an error occurred

getAllowedEventTypes

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

Get the list of allowed event types for the given projects

Parameters:

projects - The projects

Returns:

The allowed event types

getNumberOfUnreadActivitiesForCurrentUser

public long getNumberOfUnreadActivitiesForCurrentUser()

Get the number of unread events for the current user

Returns:

the number of unread events or -1 if user never read events

getActivitiesForCurrentUser

public List<Map<String,Object>> getActivitiesForCurrentUser(int limit)

Get the activities for the current user with the allowed event types get from the user projects.

Parameters:

limit - The max number of results

Returns:

The activities for the user projects

getActivitiesForCurrentUser

public List<Map<String,Object>> getActivitiesForCurrentUser(Set<Project> projects,
 int limit)

Get the activities for the current user with the allowed event types get from the given projects.

Parameters:

projects - the projects

limit - The max number of results

Returns:

The activities for the user projects