Confluence Event Listener Plugin

This page describes what is needed to consume events from confluence instance.

Confluence Types Of Content

Confluence handles the following types of content, relevant to the CEQ service, together with a list of available content-related acitivities:

Content Type	Description	Create	View	Update	Remove	Trashed	Restore	Move	Convert	ActivityStrea.ms Base Object Type
Attachment	File attached to a wiki page.	X	X	X	X					File http://activitystrea.ms/schema/1.0/file\\ Documentation
BlogPost	Blog post :)	X	X	X	X	X	X			Blog Entry http://activitystrea.ms/schema/1.0/blog-entry\\ Documentation
Comment	Comment.	X		X	X					Comment Documentation http://activitystrea.ms/schema/1.0/comment\\
Mail	Mail Message - it is possible to send emails from within confluence system. Either automatically, or manually.	X		X	X					TODO
Page	Wiki page.	X	X	X	X	X	X	X		Article Documentation http://activitystrea.ms/schema/1.0/article\\
PersonalInformation	User-related metadata. Similar to the 'profile information' in other social services.	X		X	X					TODO
Group	Group of users, used mainly for ARM.	X			X					Group Documentation http://activitystrea.ms/schema/1.0/group\\
Label	Keyword assigned to a content. Tag.	X			X					TODO
Space	Container for related content. Either personal or non-personal.	X		X	X				X	TODO
User	User of the system.	X			X					Person Documentation http://activitystrea.ms/schema/1.0/person\\

Confluence Events

This chapter lists confluence events which are relevant for the consumption by the CEQ service. The ConfluenceEvent javadoc was used as a base for this list.

Confluence Events naming conventions

In Confluence, the names of concrete event classes are composed of the following components:

<Content_Type> + <Activity_name> + Event

Examples:

AttachmentCreateEvent

BlogPostViewEvent

PageTrashedEvent - this an exception, as the activity name has the '-ed' suffix

GroupRemoveEvent

Notes on Labels

Confluence defines the following 4 subclasses of the LabelEvent class (which in turn is a subclass of the ConfluenceEvent class ):

LabelAddEvent - fired when an existing label is assigned to a content
LabelCreateEvent - fired, when a new, yet unexisting label is created in the system
Label DeleteEvent - fired, when a label is completely removed from the system
LabelRemoveEvent - fired, when an existing label is de-assigned from a content

Confluence Events table

The following table contains a list of confluence events, their targets and their mappings to the appropriate General Activities, as defined in the Activity Streams document .

Confluence Activity Name	Target	Description	General Activity
Create	CO		Create
View	Attachment Blog Post Page		Read, View, Attention
Update	Attachment BlogPost Comment Mail Page PersonalInformation Space		Update
Remove	CO	Given CO was completely removed from the system.	Delete
Trashed	BlogPost Page	The 'Move to trash' operation known from Windows BlogPostTrashedEvent PageTrashedEvent
Restore	BlogPost Page
Move	Page	Move the page from one space to another	Update (spacekey attribute/relation)
Convert	Space	Change of the space type	Update (spacetype attribute)
Add	Label	Assign an existing tag to a content	Tag
Delete	Label	Remove tag completely from the system	Untag
NotificationAdded	Content(Page/Blog) Space	Start watching a page, blog or a space ContentNotificationAddedEvent SpaceNotificationAddedEvent	Follow
NotificationRemoved	Content(Page/Blog) Space	Stop watching a page, blog or a space ContentNotificationRemovedEvent SpaceNotificationRemovedEvent	Unfollow