Introduction

Clearspace contains an event system which can be used to add custom functionality. This document describes how to register custom event listeners for the various event types in the system.

Registering Event Listeners

To register event listeners with the system make sure that the custom event class is in the classpath of the application. Then add a Jive Property in Admin Console > System > Management > System Properties with a name of the format

eventListeners.[OBJECT_LISTENER_PREFIX].[CUSTOM_CLASS_NAME]

where OBJECT_LISTENER_PREFIX is one of the strings described below. CUSTOM_CLASS_NAME is the name of the class implementing the custom event listener and should be unique. The value for the Jive Property is the full class name of the custom class, including the package specification.

Available Events

The following event listeners are available in Clearspace 1.10:

(see javadocs for more information on a given listener)

• GroupListener

• JivePropertyListener

• LogListener

• UserListener

• AnnouncementListener

• AttachmentListener

• BlogListener

• BlogPostListener

• CommentListener

• CommunityListener

• DocumentListener

• EmailListener

• ImageListener

• MessageListener

• PollListener

• PrivateMessageListener

• ProfileListener

• ProfileSearchIndexListener

• QuestionListener

• SearchIndexListener

• StorageManagerListener

• TagListener

• TagSetListener

• ThreadListener

• TrackbackListener

The following additional event listeners are available in Clearspace 2.0:

(see javadocs for more information on a given listener)

• PermissionsListener

• ProjectListener

• TaskListener

Example

Custom User Event:

User event listeners implement the UserListener interface. The Jive Property prefix for this object type is eventListeners.UserListener. For example, given a custom listener class of com.example.SpecialUserListener the Jive Property name is eventListeners.UserListener.SpecialUserListener and the value of the Jive Property is com.example.SpecialUserListener.