org.exoplatform.services.organization

Interface OrganizationServiceInitializer

public interface OrganizationServiceInitializer

Created by The eXo Platform SAS
If the other service or a third party want to customize the initialization phase of the organization service. they should make a customize class that implements this interface and register their plugin code via xml configuration. An example of the customization code is we have an organization service database intializer that create the predifined the user , group and membership if the database is empty. To Register the plugin code by the xml configuration: You need to create a my.package.MyMembershipEventListener that implements this interface 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.customize.initializer.plugin</name>
        <set-method>addListenerPlugin</set-method>
        <type>my.package.MyInitializerPlugin</type>
        <description>your listener description</description>
      </component-plugin>
  </external-component-plugins>
  [...]
 /configuration>
 

Author:

Tuan Nguyen

Level API:

Platform

Method Summary

Methods

Modifier and Type	Method and Description
void	init(org.exoplatform.services.organization.OrganizationService service) The Organization Service Initializer to create users, groups and membership types.

Method Detail

init

void init(org.exoplatform.services.organization.OrganizationService service)
          throws Exception

The Organization Service Initializer to create users, groups and membership types.

Parameters:

service - OrganizationService is the service that allows to access the Organization model.

Throws:

Exception