Extend EventHandler60 for your TeamForge event handler classes

All event handlers (synchronous and asynchronous) have to extend com.vasoftware.sf.events.EventHandler60.

package com.vasoftware.sf.plugin;
...
public class AsynchronousRelationshipEventListener extends EventHandler60 {
...
}

• EventHandler60 has one abstract method you have to override:

  @Override
  public void processEvent() throws Exception {
  ...
  }

• This method does not take any parameters, so how do we access the relevant information?

  There are some interesting methods of the base class (EventHandler60) you can call:

  • getSessionKey: Returns a session id of the user who is going to (synchronous handler) / has triggered (asynchronous handler) the event we just intercepted. If you used the user element in event.xml, it will contain a session id for the user you specified there.
  • getEventContext: Returns a data structure containing the event type, operation, project, comment and user name
  • getOriginalData: In case of a synchronous event handler, this will return a representation of the object the event is going to change. In case of an asynchronous event handler, this will return the representation of the object before it was changed by the event. The data structure used to represent the object is the same that would have been used in CollabNet’s SOAP API.
  • getUpdatedData: In case of a synchronous event handler, this will return a representation of the object how it will look after the event has happened (you can still block it). In case of an asynchronous event handler, this will return the representation of the object after it was changed by the event.
  Let’s assume a user wants to change the priority of a tracker item from 3 to 4. If you have registered a synchronous event handler, this one is triggered before the change can actually be performed. getOriginalData returns an ArtifactSoapDO object of the tracker item with the priority field set to 3. getUpdatedData contains an ArtifactSoapDO object of the tracker item with the priority field set to 4.
  • If you block the event (by throwing an exception), the change does not happen and the user is presented with an error message. (See next section for how to influence this error message.)
  • If you do not block the event (by just returning from the processEvent method), all registered asynchronous handlers are called. getOriginalData and getUpdatedData contain exactly the same objects as in the synchronous case. However, the semantic is different: They are no longer representing the current and anticipated state, but the previous and current state of the object in question.
• The following code snippet (taken from our "Hook script" event handler example) shows how to retrieve all information available to an event handler.

  String type = getEventContext().getType();
  String operation = getEventContext().getOperation();
  String projectId = getEventContext().getProjectId();
  String comment = getEventContext().getComment();
  String userName = getEventContext().getUsername();
  String originalDataClassName = getOriginalData().getClass().toString();
  String updatedDataClassName = getUpdatedData().getClass().toString();
  Object originalData = getOriginalData();
  Object updatedData = getUpdatedData();