JBoss.orgCommunity Documentation

Register Extension

The webapps are loaded in the order defined in the list of dependencies of the PortalContainerDefinition. You then need to deploy the starter.war; otherwise, the webapps will be loaded in the default application server's order, such as the loading order of the Application Server.

If you need to customize your portal by adding a new extension and/or a new portal, you need to define the related PortalContainerDefinitions and to deploy the starter. Otherwise, you do not need to define any PortalContainerDefinition.

First, you need to tell eXo Platform to load WEB-INF/conf/configuration.xml of your extension, you need to declare it as a PortalContainerConfigOwner. Next, open the file WEB-INF/web.xml of your extension and add a listener:




<web-app>

  <display-name>my-portal</display-name>

    <listener>

      <listener-class>org.exoplatform.container.web.PortalContainerConfigOwner</listener-class>

    </listener>

  <!-- ... -->

</web-app>

You need to register your extension in the portal container. This is done by the .xml configuration file like this: 




<external-component-plugins>

  <target-component>org.exoplatform.container.definition.PortalContainerConfig</target-component>

  <component-plugin>

    <name>Change PortalContainer Definitions</name>

    <set-method>registerChangePlugin</set-method>

    <type>org.exoplatform.container.definition.PortalContainerDefinitionChangePlugin</type>

    <init-params>

      <object-param>

        <name>change</name>

        <object type="org.exoplatform.container.definition.PortalContainerDefinitionChange$AddDependencies">

        <field name="dependencies">

          <collection type="java.util.ArrayList">

            <value>

              <string>my-portal</string>

            </value>

            <value>

              <string>my-portal-resources</string>

            </value>              

          </collection>

        </field>

        </object>

      </object-param> 

      <value-param>

        <name>apply.default</name>

        <value>true</value>

      </value-param>       

    </init-params>

  </component-plugin>

</external-component-plugins>

A PortalContainerDefinitionChangePlugin plugin is defined to the PortalContainerConfig. The plugin declares a list of dependencies that are webapps. The apply.default=true indicates that your extension is actually extending portal.war. You need to package your extension into a .war file and put it to the tomcat webapps folder, then restart the server.

In your portal, if you want to add your own property file to support localization for your keys, you can do as follows:




<external-component-plugins>

  <!-- The full qualified name of the ResourceBundleService -->

  <target-component>org.exoplatform.services.resources.ResourceBundleService</target-component>

  <component-plugin>

    <!-- The name of the plugin -->

    <name>Sample ResourceBundle Plugin</name>

    <!-- The name of the method to call on the ResourceBundleService in order to register the ResourceBundles -->

    <set-method>addResourceBundle</set-method>

    <!-- The full qualified name of the BaseResourceBundlePlugin -->

    <type>org.exoplatform.services.resources.impl.BaseResourceBundlePlugin</type>

    <init-params>

      <!--values-param>

        <name>classpath.resources</name>

        <description>The resources that start with the following package name should be load from file system</description>

        <value>locale.portlet</value>

      </values-param-->

      <values-param>

        <name>init.resources</name>

        <description>Store the following resources into the db for the first launch </description>

        <value>locale.portal.sample</value>

      </values-param>

      <values-param>

        <name>portal.resource.names</name>

        <description>The properties files of the portal , those file will be merged

        into one ResoruceBundle properties </description>

        <value>locale.portal.sample</value>

      </values-param>

    </init-params>

  </component-plugin>

</external-component-plugins>