From version < 28.1 >
edited by Vincent Massol
on 2019/09/09
To version < 30.1
edited by Vincent Massol
on 2020/01/28
<
Change comment: Migrated property [author] from class [XWiki.XWikiComments]

Summary

Details

Page properties
Content
... ... @@ -205,7 +205,7 @@
205 205  )))
206 206  * Modify XWiki's ##WEB-INF/hibernate.cfg.xml## file to tell Hibernate to use the defined DataSource rather than a direct JDBC connection:(((
207 207  {{code}}
208 -<!-- This needs to be commented out since we're not going to use XWiki's Data Source -->
208 +<!-- This needs to be commented out since we're not going to use the DBCP connection pool (we're going to use the Data Source connection pool) -->
209 209  <!--property name="hibernate.connection.provider_class">com.xpn.xwiki.store.DBCPConnectionProvider</property-->
210 210  ...
211 211  <!-- Tells Hibernate to use the defined data source -->
XWiki.XWikiComments[0]
Comment
XWiki.XWikiComments[2]
Comment
XWiki.XWikiComments[4]
Comment
XWiki.XWikiComments[6]
Comment
XWiki.XWikiComments[7]
Comment
XWiki.XWikiComments[8]
Comment

WildFly 17.x

The instructions are the same as for Wildly 14.x below.

WildFly 14.x

The instructions are the same as for Wildly 10.x below.

WildFly 10.x

The instructions are the same as for JBoss AS 7.x below.

Some documentation that can be useful:

Troubleshooting

Weld Deployment Error

WildFly does automatic implicit CDI deployment when it finds some CDI beans in JARs. We need to prevent this since XWiki doesn't use CDI and there can be some third-party deps we use that have some CDI annotations.

Note that we fixed this by providing a META-INF/jboss-all.xml file telling WildFly to not do CDI bean scanning in XWiki 8.3M2+. However we found a problem with it and removed it in XWiki 10.8RC1+. In the end, it was found that this file was needed after all and put back in XWiki 10.11.9/11.3.2/11.6RC1+...

If you're using a version of XWiki that doesn't provide this jboss-all.xml then create one in the META-INF directory inside the XWiki WAR, with the following content:






xmlns="urn:jboss:1.0">
  xmlns="urn:jboss:weld:1.0" require-bean-descriptor="true"/>

JBoss AS 7.x

Example using Standalone Deployment

  • Copy the xwiki expanded WAR directory in JBOSSHOME/standalone/deployments/xwiki.war
  • Do a touch JBOSSHOME/standalone/deployments/xwiki.war.dodeploy
  • Start JBoss standalone: run ./standalone.sh from JBOSSHOME/bin/

Troubleshooting

"More than the maximum number of request parameters" error

If you get the following error in the logs when trying to import a large XAR:

Servlet.service() for servlet action threw exception: java.lang.IllegalStateException: More than the maximum number of request parameters (GET plus POST) for a single request ([512]) were detected. Any parameters beyond this limit have been ignored. To change this limit, set the maxParameterCount attribute on the Connector.

You'll need to configure Tomcat in JBoss to support more than 512 form fields.

JBoss AS 4.0.x

  • Download and install the "JBoss Application Server". It's usually as simple as unzipping it in a directory. Let's call this directory $JBOSS_HOME
  • (optional) By default JBoss runs on port 8080. If you want to modify the port on which JBoss is running, edit $JBOSS_HOME/server//deploy/jbossweb-tomcat55.sar/server.xml. Search for 8080 and replace it with the port value you wish to use. Similarly change the port in $JBOSS_HOME/server//deploy/http-invoker.sar/META-INF/jboss-service.xml to the value you like
  • Copy and expand the XWiki WAR into a directory named xwiki.war/ (note that unlike most servlet containers JBoss wants the directory name to end with .war) in $JBOSS_HOME/server//deploy where server configuration is the JBoss configuration you're using
  • Edit $JBOSS_HOME/server//deploy/jbossweb-tomcat55.sar/server.xml to set UTF-8 encoding:
    <Connector port="8080" ... URIEncoding="UTF-8"/>
    <Connector port="8009" ... URIEncoding="UTF-8"/>

Classloading Isolation

The default JBoss behavior is that classes inside of the WEB-INF/classes and WEB-INF/lib directories of the WAR file are incorporated into the default shared class loader repository. This allows classes and resources to be shared between web applications. However this means that JARs provided by XWiki in WEB-INF/lib will get mixed with JARs provided by JBoss and if both application provide the same JAR but in a different version, class incompatibilities will occur. 

To solve this please read up on JBoss ClassLoading Configuration in order to configure JBoss not to use the unified class loader (set UseJBossWebLoader to false in META-INF/jboss-service.xml).

Alternatively you may try to remove the clashing JARs from XWiki's WEB-INF/lib hoping that the version provided by JBoss is compatible with XWiki's needs.

Log4j Error

It was reported that with XWiki 1.6 and JBoss 4.0.4, using these settings would generate an error with hibernate. Everything seems to work fine without these settings including classloading of log4j.

  • Edit $JBOSS_HOME/server//jbossweb-tomcat55.sar/META-INF/jboss-service.xml file and replace:
    name="Java2ClassLoadingCompliance">false
    name="UseJBossWebLoader">false
    with:
    name="Java2ClassLoadingCompliance">true
    name="UseJBossWebLoader">true
    This is to avoid class loading issues for the Log4J library.

Using a WildFly/JBoss DataSource

Tutorial for JBoss AS 7.1+

  • Create a JBoss Module for your database driver.
    • HSQLDB: create the directory [ROOT]/modules/org/hsqldb/main and put the HSQLDB Driver JAR (e.g. hsqldb-2.2.9.jar) in it and also create a module.xml in it and write the following code inside:

      xmlns="urn:jboss:module:1.0" name="org.hsqldb">
       
          path="hsqldb-2.2.9.jar"/>
       
       
          name="javax.api"/>
       
    • MySQL: create the directory [ROOT]/modules/com/mysql/main and put the MySQL Driver JAR (e.g. mysql-connector-java-5.1.48.jar) in it and also create a module.xml in it and write the following code inside:


      xmlns="urn:jboss:module:1.1" name="com.mysql">
       
          path="mysql-connector-java-5.1.48.jar"/>
       
       
          name="javax.api"/>
          name="javax.transaction.api"/>
          name="javax.servlet.api" optional="true"/>
       
  • Edit the [ASROOT]/standalone/configuration/standalone.xml file to add a new and a new sections (adjust the properties as needed):
    • MySQL. Example:

        jta="true" jndi-name="java:jboss/datasources/XWikiDS" pool-name="XWikiDS" enabled="true" use-java-context="true" use-ccm="true">
         jdbc:mysql://localhost:3306/xwiki?useSSL=false
         mysql
         TRANSACTION_READ_COMMITTED
         
           10
           100
           true
         
         
           xwiki
           xwiki
         
         
           32
           true
         
       
      ...

        name="mysql" module="com.mysql">
         com.mysql.jdbc.jdbc2.optional.MysqlXADataSource
       
      ...
    • Note that it's also possible to create a data source file named -ds.xml (e.g. hsqldb-ds.xml) in [ASROOT]/standalone/deployments/ (you can also put it in your WEB-INF/ dir). Example of content for HSQLDB:

      xmlns="http://www.jboss.org/ironjacamar/schema">
        jndi-name="java:jboss/datasources/XWikiDS" pool-name="XWikiDS" enabled="true" use-java-context="true">
         jdbc:hsqldb:file:[path to your hsqldb db file, e.g. /tmp/xwiki-data/database/xwiki_db];shutdown=true
         hsqldb
         
           sa
           
         
       

      However it's not recommended because the deployment datasource feature should only be used in development environments, as the deployable datasources are considered as unmanaged datasource. Those are not recommended for production environments, because those can not be managed by the JBoss Management console or the management utilities like jboss-cli.sh. Hence such datasource cannot be managed like the managed dataSources which are configured inside the domain.xml or standalone*.xml files.

  • Modify XWiki's WEB-INF/hibernate.cfg.xml file to tell Hibernate to use the defined DataSource rather than a direct JDBC connection:


    ...

    name="connection.datasource">java:jboss/datasources/XWikiDS
     


    ...


    ...

    name="connection.datasource">java:jboss/datasources/XWikiDS
     


    ...

Tutorial for older versions

  • Uncomment the resource-ref section in XWiki's web.xml file. You should have:

     DB Connection
     jdbc/XWikiDS
     javax.sql.DataSource
     Container
  • Create the following jboss-web.xml file in the deployed XWiki's WEB-INF/ directory:



     
           jdbc/XWikiDS
           java:jboss/datasources/XWikiDS
      
  • Modify XWiki's WEB-INF/hibernate.cfg.xml file to tell Hibernate to use the defined DataSource rather than a direct JDBC connection:


    ...

    name="connection.datasource">java:jboss/datasources/XWikiDS
     


    ...

Issues related to JBoss

Get Connected