Solr with JBoss

Solr runs fine with JBoss, see the instructions in the generic Solr installation page
The latest version of JBoss is recommended

Contents

Solr with JBoss
Optional Configuration
1. URI Charset Config
2. SNMP Monitoring
Configuring Solr Home
1. Solr Home via web.xml
2. Solr Home via properties-service.xml
JBoss Logging
Troubleshooting
JBoss 5
JBoss 6 and Solr 3.3

Optional Configuration

URI Charset Config

If you are going to query Solr using international characters (>127) using HTTP-GET, you must configure JBoss to conform to the URI standard by accepting percent-encoded UTF-8.

Edit JBoss's server/default/deploy/jbossweb-tomcat55.sar/server.xml and add the following attribute to the correct Connector element: URIEncoding="UTF-8". If you're using JBoss v4.0 or above, then the file is located at: server/default/deploy/jboss-web-deployer/server.xml

<Server ...>
 <Service ...>
   <Connector ... URIEncoding="UTF-8"/>
     ...
   </Connector>
 </Service>
</Server>

This is only an issue when sending non-ascii characters in a query request... no configuration is needed for Solr/Tomcat to return non-ascii chars in a response, or accept non-ascii chars in an HTTP-POST body.

SNMP Monitoring

For more information on Using SNMP with Solr in JBoss please see SolrSnmp

Configuring Solr Home

You can configure the Solr home directory globally via -Dsolr.solr.home in the file bin/run.bat. But that is often not desired because you potentially want more than one Solr installation deployed.

Solr Home via web.xml

You can configure the Solr home directory to use per webapp in Solr's web.xml file. Add following snippet to the web.xml:

  <env-entry>
    <env-entry-name>solr/home</env-entry-name>
    <env-entry-type>java.lang.String</env-entry-type>
    <env-entry-value>C:\Projects\solr-trunk\example\solr</env-entry-value>
  </env-entry>

Solr Home via properties-service.xml

You can also configure it (and other Solr variables, such as the Solr-data-dir) in properties-service.xml like so:

<mbean code="org.jboss.varia.property.SystemPropertiesService" name="jboss:type=Service,name=SystemProperties">
  <attribute name="Properties">
    solr.solr.home=C:/jboss-X/server/default/conf/solr
    solr.data.dir=C:/solr/data
  </attribute>
</mbean>

JBoss Logging

By default JBoss uses Log4J for its logging, while the default Solr installation uses the SLF4J binding to log via the JDK1.4 logging system. In order to get Solr to log via Log4J, you must replace the slf4j-jdk*.jar binding with the slf4j-log4j*.jar binding. From that point on, logging can be configured via the log4j.xml configuration file.

For example, this can be used to silence all the INFO messages from Solr:

<category name="org.apache.solr"> 
  <priority value="WARN"/>
</category>

Troubleshooting

If you encounter the error "statements are only available if source level is 5.0" then you have to edit the file server/default/deploy/jbossweb-tomcat55.sar/conf/web.xml.

Comment in the block

<init-param>
   <param-name>compilerSourceVM</param-name>
   <param-value>1.5</param-value>
</init-param>

JBoss 5

Solr (1.3) ( TODO: should test with 1.4 too) works fine in JBoss 5, but you should remove the following jars:

xercesImpl-2.8.1.jar
xml-apis-1.3.03.jar

from the WEB-INF/lib folder of solr.war

Since JBoss ships with its own version, solr will use the lib provided by JBoss 5.

You can even remove all the libs in WEB-INF/lib and put in server/{yourinstance}/lib if you want to deploy multiple instances of solr.

Logging should work without the steps declared in JBoss Logging section.

JBoss 6 and Solr 3.3

In order for the solr.war deployment to work:

The velocity-tools-2.0 should be updated from the beta3 version to the non-beta version from upstream.
The commons-collections and commons-beanutils jars should be removed

SolrJBoss