A PortalContainerDefinition allows you to indicate the platform how it must initialize and manage your portal. In a PortalContainerDefinition, you can define a set of properties, such as:

You can define and register a PortalContainerDefinition thanks to an external plugin that has to be treated at the RootContainer level. In other words, your configuration file must be a file conf/configuration.xml packaged into a jar file or $AS_HOME/exo-conf/configuration.xml (for more details, please have a look to the article Container Configuration).

See below an example of configuration file that define and register a PortalContainerDefinition:

<?xml version="1.0" encoding="UTF-8"?>

<configuration

  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

  xsi:schemaLocation="http://www.exoplatform.org/xml/ns/kernel_1_2.xsd http://www.exoplatform.org/xml/ns/kernel_1_2.xsd"

  xmlns="http://www.exoplatform.org/xml/ns/kernel_1_2.xsd">

  <external-component-plugins>

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

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

    <component-plugin>

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

      <name>Add PortalContainer Definitions</name>

      <!-- The name of the method to call on the PortalContainerConfig in order to register the PortalContainerDefinitions -->

      <set-method>registerPlugin</set-method>

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

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

      <init-params>

        <object-param>

          <name>portal</name>

          <object type="org.exoplatform.container.definition.PortalContainerDefinition">

            <!-- The name of the portal container -->

            <field name="name"><string>portal</string></field>

            <!-- The name of the context name of the rest web application -->

            <field name="restContextName"><string>rest</string></field>

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

            <field name="realmName"><string>exo-domain</string></field>

            <!-- All the dependencies of the portal container ordered by loading priority -->

            <field name="dependencies">

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

                <value>

                  <string>eXoResources</string>

                </value>

                <value>

                  <string>portal</string>

                </value>

                <value>

                  <string>dashboard</string>

                </value>

                <value>

                  <string>exoadmin</string>

                </value>

                <value>

                  <string>eXoGadgets</string>

                </value>

                <value>

                  <string>eXoGadgetServer</string>

                </value>

                <value>

                  <string>rest</string>

                </value>

                <value>

                  <string>web</string>

                </value>

                <value>

                  <string>wsrp-producer</string>

                </value>

                <value>

                  <string>sample-ext</string>

                </value>

              </collection>

            </field>

          </object>

        </object-param>

      </init-params>

    </component-plugin>

  </external-component-plugins>

</configuration>

In the previous example, we define a portal container called "portal", which rest context name is "rest", which realm name is "exo-domain" and which dependencies are the web applications "eXoResources", "portal"... The platform will load first "eXoResources", then "portal" and so on.