org.exoplatform.services.organization

Class GroupEventListener

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.services.organization.GroupEventListener

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public class GroupEventListener
extends org.exoplatform.container.component.BaseComponentPlugin

If the other service or a third party want to customize their code to handle a group event, the event can be new , update or remove. They should create a class that extends this class and register the listener to the organization service. There are 2 ways to register a listener to the service. a) To do it programatically: [..] import org.exoplatform.container.PortalContainer ; import org.exoplatform.services.organization.OrganizationService ; [..] GroupEventListener listener = new MyGroupEventListener(..) ; PortalContainer pcontainer = PortalContainer.getInstance() ; OrganizationService service = (OrganizationService) pcontainer.getInstanceOfType(OrganizationService.class) ; service.getGroupHandler().addGroupEventListener(listener) ; b) Register by the xml configuration: You need to create a my.package.MyGroupEventListener that extends this class and add a conf/portal/configuration.xml to the classpath. The configuration.xml can be in a jar file. The file should contain the following configuraiton:

 <configuration>
   [..]
   <external-component-plugins>
     <target-component>org.exoplatform.services.organization.OrganizationService</target-component>
     <component-plugin>
        <name>my.group.listener</name>
        <set-method>addListenerPlugin</set-method>
        <type>my.package.MyGroupEventListener</type>
        <description>your listener description</description>
      </component-plugin>
  </external-component-plugins>
  [...]
 /configuration>
 

Author:

Tuan Nguyen

Level API:

Platform

Field Summary

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor and Description
GroupEventListener()

Method Summary

Methods

Modifier and Type	Method and Description
void	postDelete(Group group) This method should be called after the group has been removed from the database but not commited yet.
void	postSave(Group group, boolean isNew) This method is called after the group has been saved but not commited yet
void	preDelete(Group group) This method is called before a group should be deleted
void	preSave(Group group, boolean isNew) This method is called before the group is persisted to the database.

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupEventListener

public GroupEventListener()

Method Detail

preSave

public void preSave(Group group,
           boolean isNew)
             throws Exception

This method is called before the group is persisted to the database.

Parameters:

group - The group to be saved

isNew - if the group is a new record in the database or not

Throws:

Exception - The developer can decide to throw an exception or not. If the listener throw an exception, the organization service should not save/update the group to the database

postSave

public void postSave(Group group,
            boolean isNew)
              throws Exception

This method is called after the group has been saved but not commited yet

Parameters:

group - The group has been saved.

isNew - if the group is a new record in the database or not

Throws:

Exception - The developer can decide to throw the exception or not. If the method throw an exception. The organization service should role back the data to the state before the method GroupHandler.addChild(..) or GroupHandler.saveGroup(..) is called.

preDelete

public void preDelete(Group group)
               throws Exception

This method is called before a group should be deleted

Parameters:

group - the group to be delete

Throws:

Exception - The developer can decide to throw the exception or not. If the method throw an exception. The organization service should not remove the group record from the database.

postDelete

public void postDelete(Group group)
                throws Exception

This method should be called after the group has been removed from the database but not commited yet.

Parameters:

group - The group has been removed.

Throws:

Exception - The developer can decide to throw the exception or not. If the method throw the exception, the organization service should role back the database to the state before the method GroupHandler.removeGroup(..) is called.