com.xpn.xwiki.plugin.activitystream.impl
Class ActivityStreamImpl

java.lang.Object
  com.xpn.xwiki.plugin.activitystream.impl.ActivityStreamImpl

All Implemented Interfaces:

com.xpn.xwiki.notify.XWikiDocChangeNotificationInterface, ActivityStream

public class ActivityStreamImpl
extends java.lang.Object
implements ActivityStream, com.xpn.xwiki.notify.XWikiDocChangeNotificationInterface

Version:

$Id: $

Field Summary

Fields inherited from interface com.xpn.xwiki.notify.XWikiDocChangeNotificationInterface

EVENT_CHANGE, EVENT_DELETE, EVENT_NEW, EVENT_UPDATE_CLASS, EVENT_UPDATE_CONTENT, EVENT_UPDATE_OBJECT

Constructor Summary

ActivityStreamImpl()

Method Summary

void	addActivityEvent(ActivityEvent event, com.xpn.xwiki.XWikiContext context) Adding and activity event.
void	addActivityEvent(ActivityEvent event, com.xpn.xwiki.doc.XWikiDocument doc, com.xpn.xwiki.XWikiContext context)
void	addActivityEvent(java.lang.String streamName, java.lang.String type, java.lang.String title, java.util.List<java.lang.String> params, com.xpn.xwiki.XWikiContext context)
void	addActivityEvent(java.lang.String streamName, java.lang.String type, java.lang.String title, com.xpn.xwiki.XWikiContext context)
void	addDocumentActivityEvent(java.lang.String streamName, com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String type, int priority, java.lang.String title, java.util.List<java.lang.String> params, com.xpn.xwiki.XWikiContext context)
void	addDocumentActivityEvent(java.lang.String streamName, com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String type, int priority, java.lang.String title, com.xpn.xwiki.XWikiContext context)
void	addDocumentActivityEvent(java.lang.String streamName, com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String type, java.lang.String title, java.util.List<java.lang.String> params, com.xpn.xwiki.XWikiContext context)
void	addDocumentActivityEvent(java.lang.String streamName, com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String type, java.lang.String title, com.xpn.xwiki.XWikiContext context)
void	deleteActivityEvent(ActivityEvent event, com.xpn.xwiki.XWikiContext context)
protected java.lang.String	generateEventId(ActivityEvent event, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEvents(boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEvents(java.lang.String stream, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEventsForSpace(java.lang.String space, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEventsForSpace(java.lang.String stream, java.lang.String space, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEventsForUser(java.lang.String user, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEventsForUser(java.lang.String stream, java.lang.String user, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(java.util.List<ActivityEvent> events, java.lang.String author, java.lang.String title, java.lang.String description, java.lang.String copyright, java.lang.String encoding, java.lang.String url, java.lang.String suffix, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(java.util.List<ActivityEvent> events, java.lang.String author, java.lang.String title, java.lang.String description, java.lang.String copyright, java.lang.String encoding, java.lang.String url, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(java.util.List<ActivityEvent> events, java.lang.String suffix, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(java.util.List<ActivityEvent> events, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndEntry	getFeedEntry(ActivityEvent event, java.lang.String suffix, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndEntry	getFeedEntry(ActivityEvent event, com.xpn.xwiki.XWikiContext context)
java.lang.String	getFeedOutput(java.util.List<ActivityEvent> events, java.lang.String author, java.lang.String title, java.lang.String description, java.lang.String copyright, java.lang.String encoding, java.lang.String url, java.lang.String type, java.lang.String suffix, com.xpn.xwiki.XWikiContext context)
java.lang.String	getFeedOutput(java.util.List<ActivityEvent> events, java.lang.String author, java.lang.String title, java.lang.String description, java.lang.String copyright, java.lang.String encoding, java.lang.String url, java.lang.String type, com.xpn.xwiki.XWikiContext context)
java.lang.String	getFeedOutput(com.sun.syndication.feed.synd.SyndFeed feed, java.lang.String type)
java.lang.String	getStreamName(java.lang.String space, com.xpn.xwiki.XWikiContext context) Tranforms space name into stream name
void	initClasses(com.xpn.xwiki.XWikiContext context) Creates the classes used by the activity stream when necessary
protected ActivityEvent	newActivityEvent()
void	notify(com.xpn.xwiki.notify.XWikiNotificationRule rule, com.xpn.xwiki.doc.XWikiDocument newdoc, com.xpn.xwiki.doc.XWikiDocument olddoc, int event, com.xpn.xwiki.XWikiContext context)
protected void	prepareEvent(ActivityEvent event, com.xpn.xwiki.doc.XWikiDocument doc, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	searchEvents(java.lang.String hql, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	searchEvents(java.lang.String fromHql, java.lang.String hql, boolean filter, int nb, int start, java.util.List<java.lang.Object> parameterValues, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	searchEvents(java.lang.String fromHql, java.lang.String hql, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context) Alternate searchEvents function for the Activiy Stream

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityStreamImpl

public ActivityStreamImpl()

Method Detail

initClasses

public void initClasses(com.xpn.xwiki.XWikiContext context)
                 throws com.xpn.xwiki.XWikiException

Description copied from interface: ActivityStream

Creates the classes used by the activity stream when necessary

Specified by:

initClasses in interface ActivityStream

Throws:

com.xpn.xwiki.XWikiException

prepareEvent

protected void prepareEvent(ActivityEvent event,
                            com.xpn.xwiki.doc.XWikiDocument doc,
                            com.xpn.xwiki.XWikiContext context)

getStreamName

public java.lang.String getStreamName(java.lang.String space,
                                      com.xpn.xwiki.XWikiContext context)

Description copied from interface: ActivityStream

Tranforms space name into stream name

Specified by:

getStreamName in interface ActivityStream

Returns:

generateEventId

protected java.lang.String generateEventId(ActivityEvent event,
                                           com.xpn.xwiki.XWikiContext context)

addActivityEvent

public void addActivityEvent(ActivityEvent event,
                             com.xpn.xwiki.XWikiContext context)
                      throws ActivityStreamException

Description copied from interface: ActivityStream

Adding and activity event. The Id does not need to be filled as it will be created. Date and Wiki are optional

Specified by:

addActivityEvent in interface ActivityStream

Throws:

ActivityStreamException

addActivityEvent

public void addActivityEvent(ActivityEvent event,
                             com.xpn.xwiki.doc.XWikiDocument doc,
                             com.xpn.xwiki.XWikiContext context)
                      throws ActivityStreamException

Throws:

ActivityStreamException

addActivityEvent

public void addActivityEvent(java.lang.String streamName,
                             java.lang.String type,
                             java.lang.String title,
                             com.xpn.xwiki.XWikiContext context)
                      throws ActivityStreamException

Specified by:

addActivityEvent in interface ActivityStream

Throws:

ActivityStreamException

addActivityEvent

public void addActivityEvent(java.lang.String streamName,
                             java.lang.String type,
                             java.lang.String title,
                             java.util.List<java.lang.String> params,
                             com.xpn.xwiki.XWikiContext context)
                      throws ActivityStreamException

Specified by:

addActivityEvent in interface ActivityStream

Throws:

ActivityStreamException

addDocumentActivityEvent

public void addDocumentActivityEvent(java.lang.String streamName,
                                     com.xpn.xwiki.doc.XWikiDocument doc,
                                     java.lang.String type,
                                     java.lang.String title,
                                     com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException

Specified by:

addDocumentActivityEvent in interface ActivityStream

Throws:

ActivityStreamException

addDocumentActivityEvent

public void addDocumentActivityEvent(java.lang.String streamName,
                                     com.xpn.xwiki.doc.XWikiDocument doc,
                                     java.lang.String type,
                                     int priority,
                                     java.lang.String title,
                                     com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException

Specified by:

addDocumentActivityEvent in interface ActivityStream

Throws:

ActivityStreamException

addDocumentActivityEvent

public void addDocumentActivityEvent(java.lang.String streamName,
                                     com.xpn.xwiki.doc.XWikiDocument doc,
                                     java.lang.String type,
                                     java.lang.String title,
                                     java.util.List<java.lang.String> params,
                                     com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException

Specified by:

addDocumentActivityEvent in interface ActivityStream

Throws:

ActivityStreamException

addDocumentActivityEvent

public void addDocumentActivityEvent(java.lang.String streamName,
                                     com.xpn.xwiki.doc.XWikiDocument doc,
                                     java.lang.String type,
                                     int priority,
                                     java.lang.String title,
                                     java.util.List<java.lang.String> params,
                                     com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException

Specified by:

addDocumentActivityEvent in interface ActivityStream

Throws:

ActivityStreamException

deleteActivityEvent

public void deleteActivityEvent(ActivityEvent event,
                                com.xpn.xwiki.XWikiContext context)
                         throws ActivityStreamException

Specified by:

deleteActivityEvent in interface ActivityStream

Throws:

ActivityStreamException

searchEvents

public java.util.List<ActivityEvent> searchEvents(java.lang.String hql,
                                                  boolean filter,
                                                  int nb,
                                                  int start,
                                                  com.xpn.xwiki.XWikiContext context)
                                           throws ActivityStreamException

Specified by:

searchEvents in interface ActivityStream

Throws:

ActivityStreamException

searchEvents

public java.util.List<ActivityEvent> searchEvents(java.lang.String fromHql,
                                                  java.lang.String hql,
                                                  boolean filter,
                                                  int nb,
                                                  int start,
                                                  com.xpn.xwiki.XWikiContext context)
                                           throws ActivityStreamException

Alternate searchEvents function for the Activiy Stream

Specified by:

searchEvents in interface ActivityStream

Parameters:

fromHql -

hql -

filter -

nb -

start -

context -

Returns:

Throws:

ActivityStreamException

searchEvents

public java.util.List<ActivityEvent> searchEvents(java.lang.String fromHql,
                                                  java.lang.String hql,
                                                  boolean filter,
                                                  int nb,
                                                  int start,
                                                  java.util.List<java.lang.Object> parameterValues,
                                                  com.xpn.xwiki.XWikiContext context)
                                           throws ActivityStreamException

Specified by:

searchEvents in interface ActivityStream

Throws:

ActivityStreamException

getEvents

public java.util.List<ActivityEvent> getEvents(boolean filter,
                                               int nb,
                                               int start,
                                               com.xpn.xwiki.XWikiContext context)
                                        throws ActivityStreamException

Specified by:

getEvents in interface ActivityStream

Throws:

ActivityStreamException

getEventsForSpace

public java.util.List<ActivityEvent> getEventsForSpace(java.lang.String space,
                                                       boolean filter,
                                                       int nb,
                                                       int start,
                                                       com.xpn.xwiki.XWikiContext context)
                                                throws ActivityStreamException

Specified by:

getEventsForSpace in interface ActivityStream

Throws:

ActivityStreamException

getEventsForUser

public java.util.List<ActivityEvent> getEventsForUser(java.lang.String user,
                                                      boolean filter,
                                                      int nb,
                                                      int start,
                                                      com.xpn.xwiki.XWikiContext context)
                                               throws ActivityStreamException

Specified by:

getEventsForUser in interface ActivityStream

Throws:

ActivityStreamException

getEvents

public java.util.List<ActivityEvent> getEvents(java.lang.String stream,
                                               boolean filter,
                                               int nb,
                                               int start,
                                               com.xpn.xwiki.XWikiContext context)
                                        throws ActivityStreamException

Specified by:

getEvents in interface ActivityStream

Throws:

ActivityStreamException

getEventsForSpace

public java.util.List<ActivityEvent> getEventsForSpace(java.lang.String stream,
                                                       java.lang.String space,
                                                       boolean filter,
                                                       int nb,
                                                       int start,
                                                       com.xpn.xwiki.XWikiContext context)
                                                throws ActivityStreamException

Specified by:

getEventsForSpace in interface ActivityStream

Throws:

ActivityStreamException

getEventsForUser

public java.util.List<ActivityEvent> getEventsForUser(java.lang.String stream,
                                                      java.lang.String user,
                                                      boolean filter,
                                                      int nb,
                                                      int start,
                                                      com.xpn.xwiki.XWikiContext context)
                                               throws ActivityStreamException

Specified by:

getEventsForUser in interface ActivityStream

Throws:

ActivityStreamException

newActivityEvent

protected ActivityEvent newActivityEvent()

notify

public void notify(com.xpn.xwiki.notify.XWikiNotificationRule rule,
                   com.xpn.xwiki.doc.XWikiDocument newdoc,
                   com.xpn.xwiki.doc.XWikiDocument olddoc,
                   int event,
                   com.xpn.xwiki.XWikiContext context)

Specified by:

notify in interface com.xpn.xwiki.notify.XWikiDocChangeNotificationInterface

getFeedEntry

public com.sun.syndication.feed.synd.SyndEntry getFeedEntry(ActivityEvent event,
                                                            com.xpn.xwiki.XWikiContext context)

Specified by:

getFeedEntry in interface ActivityStream

getFeedEntry

public com.sun.syndication.feed.synd.SyndEntry getFeedEntry(ActivityEvent event,
                                                            java.lang.String suffix,
                                                            com.xpn.xwiki.XWikiContext context)

Specified by:

getFeedEntry in interface ActivityStream

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(java.util.List<ActivityEvent> events,
                                                      com.xpn.xwiki.XWikiContext context)

Specified by:

getFeed in interface ActivityStream

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(java.util.List<ActivityEvent> events,
                                                      java.lang.String suffix,
                                                      com.xpn.xwiki.XWikiContext context)

Specified by:

getFeed in interface ActivityStream

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(java.util.List<ActivityEvent> events,
                                                      java.lang.String author,
                                                      java.lang.String title,
                                                      java.lang.String description,
                                                      java.lang.String copyright,
                                                      java.lang.String encoding,
                                                      java.lang.String url,
                                                      com.xpn.xwiki.XWikiContext context)

Specified by:

getFeed in interface ActivityStream

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(java.util.List<ActivityEvent> events,
                                                      java.lang.String author,
                                                      java.lang.String title,
                                                      java.lang.String description,
                                                      java.lang.String copyright,
                                                      java.lang.String encoding,
                                                      java.lang.String url,
                                                      java.lang.String suffix,
                                                      com.xpn.xwiki.XWikiContext context)

Specified by:

getFeed in interface ActivityStream

getFeedOutput

public java.lang.String getFeedOutput(java.util.List<ActivityEvent> events,
                                      java.lang.String author,
                                      java.lang.String title,
                                      java.lang.String description,
                                      java.lang.String copyright,
                                      java.lang.String encoding,
                                      java.lang.String url,
                                      java.lang.String type,
                                      com.xpn.xwiki.XWikiContext context)

Specified by:

getFeedOutput in interface ActivityStream

getFeedOutput

public java.lang.String getFeedOutput(java.util.List<ActivityEvent> events,
                                      java.lang.String author,
                                      java.lang.String title,
                                      java.lang.String description,
                                      java.lang.String copyright,
                                      java.lang.String encoding,
                                      java.lang.String url,
                                      java.lang.String type,
                                      java.lang.String suffix,
                                      com.xpn.xwiki.XWikiContext context)

Specified by:

getFeedOutput in interface ActivityStream

getFeedOutput

public java.lang.String getFeedOutput(com.sun.syndication.feed.synd.SyndFeed feed,
                                      java.lang.String type)

Specified by:

getFeedOutput in interface ActivityStream