JBoss.orgCommunity Documentation

SpaceApplicationConfigPlugin

This plugin is used to configure the default applications when creating a new space.

Sample configuration:



      <component-plugin>
        <name>Space Application Configuration</name>
        <set-method>setSpaceApplicationConfigPlugin</set-method>
        <type>org.exoplatform.social.core.space.SpaceApplicationConfigPlugin</type>
        <init-params>
          <object-param>
            <name>spaceHomeApplication</name>
            <description>Space Home Application</description>
            <object type="org.exoplatform.social.core.space.SpaceApplicationConfigPlugin$SpaceApplication">
              <field name="portletApp"><string>social-portlet</string></field>
              <field name="portletName"><string>SpaceActivityStreamPortlet</string></field>
              <field name="appTitle"><string>Home</string></field>
              <!--<field name="icon"><string>SpaceHomeIcon</string></field>-->
            </object>
          </object-param>

          <object-param>
            <name>spaceApplicationListConfig</name>
            <description>space application list configuration</description>
            <object type="org.exoplatform.social.core.space.SpaceApplicationConfigPlugin">
              <field name="spaceApplicationList">
                <collection type="java.util.ArrayList">
                  <value>
                    <object type="org.exoplatform.social.core.space.SpaceApplicationConfigPlugin$SpaceApplication">
                      <field name="portletApp"><string>dashboard</string></field>
                      <field name="portletName"><string>DashboardPortlet</string></field>
                      <field name="appTitle"><string>Dashboard</string></field>
                      <field name="removable"><boolean>true</boolean></field>
                      <field name="order"><int>1</int></field>
                      <field name="uri"><string>dashboard</string></field>
                      <!--<field name="icon"><string>SpaceDashboardIcon</string></field>-->
                    </object>
                  </value>
                  <value>
                    <object type="org.exoplatform.social.core.space.SpaceApplicationConfigPlugin$SpaceApplication">
                      <field name="portletApp"><string>social-portlet</string></field>
                      <field name="portletName"><string>SpaceSettingPortlet</string></field>
                      <field name="appTitle"><string>Space Settings</string></field>
                      <field name="removable"><boolean>false</boolean></field>
                      <field name="order"><int>2</int></field>
                      <field name="uri"><string>settings</string></field>
                      <!--<field name="icon"><string>SpaceSettingsIcon</string></field>-->
                    </object>
                  </value>
                  <value>
                    <object type="org.exoplatform.social.core.space.SpaceApplicationConfigPlugin$SpaceApplication">
                      <field name="portletApp"><string>social-portlet</string></field>
                      <field name="portletName"><string>MembersPortlet</string></field>
                      <field name="appTitle"><string>Members</string></field>
                      <field name="removable"><boolean>true</boolean></field>
                      <field name="order"><int>3</int></field>
                      <field name="uri"><string>members</string></field>
                      <!--<field name="icon"><string>SpaceMembersIcon</string></field>-->
                    </object>
                  </value>
                </collection>
              </field>
            </object>
          </object-param>
        </init-params>
      </component-plugin>

In which:

Object-param Description
spaceHomeApplication Set the Application portlet to be the home page of a space.
spaceApplicationListConfig The list of the applications that are installed by default to a new space.
Field name Possible value Description
portletAp string The .war name file which has the portlet.
portletName string The name of portlet which is registered in the system.
appTitle string The display name of the application.
removable boolean Specify if the application is removed from the space or not.
order integer The order of the application in the space navigation.
uri string The URI of the application in the page node.
icon string The icon of the application.