Skip to Content

Wiki source code of JBoss/WildFly Installation

Version 26.3 by Vincent Massol on 2017/09/06
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = WildFly 10.x =
6
7 The instructions are the same as for JBoss AS 7.x below.
8
9 Some documentation that can be useful:
10
11 * [[how WildFly 10.x Classloader works>>https://docs.jboss.org/author/display/WFLY10/Class+Loading+in+WildFly]]
12
13 == Troubleshooting ==
14
15 === Weld Deployment Error ===
16
17 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. This is [[fixed>>https://jira.xwiki.org/browse/XWIKI-13678]] but if you encounter it, see [[Implicit module dependencies for deployments>>https://docs.jboss.org/author/display/WFLY10/Implicit+module+dependencies+for+deployments]] to prevent it.
18
19 = JBoss AS 7.x =
20
21 * Download and install the [[JBoss Application Server>>http://www.jboss.org/jbossas/]]
22 * Deploy the XWiki WAR either by using the JBoss AS Admin (recommended) or by deploying on the filesystem. Read the [[JBoss AS documentation>>https://docs.jboss.org/author/display/AS71/Documentation]] to learn how to do this.
23 * If you have class loader issues read [[how JBoss AS7 Classloader works>>https://docs.jboss.org/author/display/AS71/Developer+Guide#DeveloperGuide-ClassloadinginJBossAS7]]
24
25 == Example using Standalone Deployment ==
26
27 * Copy the xwiki expanded WAR directory in ##JBOSSHOME/standalone/deployments/xwiki.war##
28 * Do a ##touch JBOSSHOME/standalone/deployments/xwiki.war.dodeploy##
29 * Start JBoss standalone: run ##./standalone.sh## from ##JBOSSHOME/bin/##
30
31 == Troubleshooting ==
32
33 === "More than the maximum number of request parameters" error ===
34
35 If you get the following error in the logs when trying to import a large XAR:
36
37 {{code}}
38 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.
39 {{/code}}
40
41 You'll need to [[configure Tomcat in JBoss to support more than 512 form fields>>https://community.jboss.org/thread/177942]].
42
43 = JBoss AS 4.0.x =
44
45 * 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##
46 * (optional) By default JBoss runs on port 8080. If you want to modify the port on which JBoss is running, edit ##$JBOSS_HOME/server/<mode>/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/<mode>/deploy/http-invoker.sar/META-INF/jboss-service.xml## to the value you like
47 * 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/<server configuration>/deploy## where ##server configuration## is the JBoss configuration you're using
48 * Edit ##$JBOSS_HOME/server/<mode>/deploy/jbossweb-tomcat55.sar/server.xml## to set UTF-8 encoding:(((
49 {{code}}
50 <Connector port="8080" ... URIEncoding="UTF-8"/>
51 <Connector port="8009" ... URIEncoding="UTF-8"/>
52 {{/code}}
53 )))
54
55 == Classloading Isolation ==
56
57 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.
58
59 To solve this please read up on [[JBoss ClassLoading Configuration>>https://community.jboss.org/wiki/ClassLoadingConfiguration]] in order to configure JBoss not to use the unified class loader (set ##UseJBossWebLoader## to ##false## in ##META-INF/jboss-service.xml##).
60
61 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.
62
63 == Log4j Error ==
64
65 {{warning}}
66 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.
67 {{/warning}}
68
69 * Edit ##$JBOSS_HOME/server/<server configuration>/jbossweb-tomcat55.sar/META-INF/jboss-service.xml## file and replace:(((
70 {{code}}
71 <attribute name="Java2ClassLoadingCompliance">false</attribute>
72 <attribute name="UseJBossWebLoader">false</attribute>
73 {{/code}}
74 )))with:(((
75 {{code}}
76 <attribute name="Java2ClassLoadingCompliance">true</attribute>
77 <attribute name="UseJBossWebLoader">true</attribute>
78 {{/code}}
79 )))This is to avoid class loading issues for the Log4J library.
80
81 = Using a JBoss DataSource =
82
83 JBoss links about this topic:
84
85 * [[JBoss AS 7.1 Datasource Configuration>>https://docs.jboss.org/author/display/AS71/DataSource+configuration]]
86 * [[DataSource configuration in AS 7>>https://community.jboss.org/wiki/DataSourceConfigurationInAS7]]
87 * [[JBoss AS 7.1.0.Final "Thunder" released - Java EE 6 Full Profile certified!>>http://planet.jboss.org/post/jboss_as_7_1_0_final_thunder_released_java_ee_6_full_profile_certified]]
88 * [[How do I migrate my application from AS5 or AS6 to AS7>>https://docs.jboss.org/author/display/AS7/How+do+I+migrate+my+application+from+AS5+or+AS6+to+AS7]]
89 * [[Excited about JBoss AS 7.1 Part I: Deployable Datasources>>https://community.jboss.org/en/tools/blog/2012/02/28/excited-about-jboss-as-71-part-i-deployable-datasources]]
90
91 == Tutorial for JBoss AS 7.1 ==
92
93 * Create a JBoss Module for your database driver. For example for HSQLDB, create the directory ##[ASROOT]/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:(((
94 {{code}}
95 <?xml version="1.0" encoding="UTF-8"?>
96 <module xmlns="urn:jboss:module:1.0" name="org.hsqldb">
97 <resources>
98 <resource-root path="hsqldb-2.2.9.jar"/>
99 </resources>
100 <dependencies>
101 <module name="javax.api"/>
102 </dependencies>
103 </module>
104 {{/code}}
105 )))
106 * Create a data source file named ##-ds.xml## (e.g. ##hsqldb-ds.xml##). If you're using a standalone deployment, put it in ##[ASROOT]/standalone/deployments/## (you can also put it in your ##WEB-INF/## dir). Example of content:(((
107 {{code}}
108 <?xml version="1.0" encoding="UTF-8"?>
109 <datasources xmlns="http://www.jboss.org/ironjacamar/schema">
110 <datasource jndi-name="java:jboss/datasources/XWikiDS" pool-name="XWikiDS" enabled="true" use-java-context="true">
111 <connection-url>jdbc:hsqldb:file:[path to your hsqldb db file, e.g. /tmp/xwiki-data/database/xwiki_db];shutdown=true</connection-url>
112 <driver>hsqldb</driver>
113 <security>
114 <user-name>sa</user-name>
115 <password></password>
116 </security>
117 </datasource>
118 </datasources>
119 {{/code}}
120 )))
121
122 == Old Tutorial ==
123
124 * Uncomment the ##resource-ref## section in XWiki's ##web.xml## file. You should have:(((
125 {{code}}
126 <resource-ref>
127 <description>DB Connection</description>
128 <res-ref-name>jdbc/XWikiDS</res-ref-name>
129 <res-type>javax.sql.DataSource</res-type>
130 <res-auth>Container</res-auth>
131 </resource-ref>
132 {{/code}}
133 )))
134 * Create the following ##jboss-web.xml## file in the deployed XWiki's ##WEB-INF/## directory:(((
135 {{code}}
136 <?xml version="1.0" encoding="ISO-8859-1"?>
137 <!DOCTYPE jboss-web PUBLIC "-//JBoss//DTD Web Application 2.3V2//EN" "http://www.jboss.org/j2ee/dtd/jboss-web_3_2.dtd">
138 <jboss-web>
139 <resource-ref>
140 <res-ref-name>jdbc/XWikiDS</res-ref-name>
141 <jndi-name>java:jboss/datasources/XWikiDS</jndi-name>
142 </resource-ref>
143 </jboss-web>
144 {{/code}}
145 )))
146 * Modify XWiki's ##WEB-INF/hibernate.cfg.xml## file to tell Hibernate to use the defined DataSource rather than a direct JDBC connection:(((
147 {{code}}
148 ...
149 <property name="connection.datasource">java:jboss/datasources/XWikiDS</property>
150 ...
151 {{/code}}
152 )))
153
154 = Issues related to JBoss =
155
156 {{jira URL="https://jira.xwiki.org" source="jql"}}
157 labels = jboss
158 {{/jira}}

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected