Memory Issues Running Under Tomcat

These steps might solve problems related to the release of memory or to container tag pooling:

enablepooling = false

Java Out of Memory Error

If you encounter a Java out of memory error, try increasing your Java heap size setting. See Setting JVM Options for Application Servers. As a minimum, add -Xms1024m -Xmx2048m to your JAVA_OPTS setting.

This Java option is set within the application server, so you must restart your application server.

Configuration File Locations

You'll find JasperReports Server configuration properties specific to your application server in the following files.

Context.xml on Tomcat: Special Case

If you deploy multiple instances of JasperServer to Tomcat, the context.xml (database connection configuration) can be superseded by a file in this location: <tomcat>/conf/Catalina/localhost/jasperserver.xml. This is the case with some Tomcat versions before Tomcat 7.

When JasperServer is deployed, the context.xml will be copied to <tomcat>/conf/Catalina/localhost/jasperserver.xml (Tomcat does this by default).

Now, if you make changes to your <tomcat>/webapps/jasperserver/META-INF/context.xml, Tomcat will not “see” them. Instead, the jasperserver.xml will be used. This is confusing, but it's the way Tomcat operates.

If you edit your context.xml to fix a database problem:

<tomcat>/webapps/jasperserver/META-INF/context.xml

Remember to delete the jasperserver.xml file:

<tomcat>/conf/Catalina/localhost/jasperserver.xml (delete this file)

Tomcat 6 Installed Using apt-get

Setting CATALINA_HOME

Go to the section of the default_master.properties that looks like this:

and change it to this:

Note that you must set both CATALINA_HOME and CATALINA_BASE.

Database Driver Location

After installing JasperReports Server, make sure there's a copy of the database driver file in the /usr/share/tomcat7/webapps/jasperserver/WEB-INF/lib directory. If it's not there, copy the driver to this location. For example, for PostgreSQL, you can copy the driver from the

<js-install>/buildomatic/conf_source/db/postgresql/jdbc directory.

Installing on tc Server

If you're installing JasperReports Server to an instance of Pivotal tc Server, you can follow the directions for Tomcat installation in Installing the WAR File Using js-install Scripts, with the following modifications:

appServerType = tomcat6[/code]

...[/code]

# Tomcat app server root dirappServerDir = <tc-home>/<js-instance>[/code]                    

In this example, your tc Server instance is installed to <tc-home> and <js-instance> is the subdirectory where you want to install JasperReports Server.

On Windows:

See Setting JVM Options for Application Servers for more information.

GlassFish Modifications

Using a Custom Domain

If GlassFish is your application server and you’re using a custom domain, set up the following authentication information in the default_master.properties:

Using GlassFish 3.1.0

GlassFish 3.1.0 has a known issue where Java JVM options are not properly set. This issue is fixed in GlassFish 3.1.1 and later.

To set the JVM options in GlassFish 3.1.0:

<js-install>/buildomatic/default_master.properties

glassfishPort=4848

Can’t Upload Files on GlassFish 3.1.2

A known issue with file upload on GlassFish 3.1.2 prevents you from uploading files to the JasperReports Server (GLASSFISH 18446). This issue is resolved in the 3.1.2.2 release — a microrelease that resolves this and other critical issues.

Requests to Single Permissions REST2 Service fail on GlassFish

Requests to Single Permissions REST2 service are failing on GlassFish with the following error:

400 Invalid URI: Encoded slashes are not allowed by default. To enable encodedslashes, set the property com.sun.grizzly.util.buf.UDecoder.ALLOW_ENCODED_SLASH to true

To fix this issue, run this command:

./bin/asadmin create-jvm-options -Dcom.sun.grizzly.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true

BufferOverflowException When Working With Input Controls

In some cases, adding a large number of values to an input control causes an overflow error like this:

Request URI is too large.

java.nio.BufferOverflowException

To fix this, increase the allowed URI size in the GlassFish admin console. Go to Configurations > cluster-config > Network Config > Transports > tcp > Buffer Size and increase the value to 131072 or more.

JBoss Modifications

JBoss 7 Startup Error

JBoss 7 has a default startup time period. If your JBoss 7 takes longer than 60 seconds to start or deploy, you may receive the following error:

“(DeploymentScanner-threads - 1) Did not receive a response to the deployment operation within the allowed timeout period [60 seconds]. Check the server configuration file and the server logs to find more about the status of the deployment”.

To fix this, you need to increase your deployment-timeout setting as follows:

cd <jboss>/standalone/configuration

On server restart, your system will have the specified time to start up.

JBoss 7 ReservedCodeCacheSize Error

If you get a fatal error like this:

"out of space in CodeCache for adapters"

It may be the result of a too-low a memory setting for the ReservedCodeCacheSize flag. This error has been observed when running the Oracle JDK, version 1.6 (no longer supported).

You can set a higher value as shown in the example below:

Linux

export JAVA_OPTS="$JAVA_OPTS -DReservedCodeCacheSize=128m"

Windows

set JAVA_OPTS=%JAVA_OPTS% -DReservedCodeCacheSize=128m

JBoss Large INFO Log Message on Drill-through

JBoss has an internal mechanism to track and log information on unclosed JDBC connections. Jaspersoft OLAP Views leaves a connection open for performance reasons when doing a drill-through. In this case, JBoss puts a large INFO level message in the server.log.

To silence this INFO message:

<jboss>/server/default/conf/jboss-log4j.xml

Using a Non-default JBoss Profile

If JBoss is your application server, and you’re using a profile other than the default, you need to set the jboss.profile property before running the js-install script in Installing the WAR File Using js-install Scripts:

<js-install>/buildomatic/build_conf/default/app.srv.properties

from

# jboss.profile = default

to

jboss.profile = <your_profile>

Using JBoss with Non-Latin Characters

If JBoss is your application server, and your organization is created with non-Latin characters, you will need to edit the standalone.xml configuration file.

......</extensions> <system-properties>  <property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>  <property name="org.apache.catalina.connector.USE_BODY_ENCODING_FOR_QUERY_STRING" value="true"/></system-properties>[/code]

Disabling User Session Persistence in Application Servers

JasperReports Server stores non-serializable data in its user sessions, which can cause errors after restarting your application server:

Exception loading sessions from persistent storage

Cause: java.io.NotSerializableException ...

The errors appear in the JasperReports Server log when users log in after the application server has been restarted. Users don't see the errors, and they have no impact on JasperReports Server operations.

Because JasperReports Server user sessions are not persistent, you can configure your application server to disable persistence and avoid the error. For example, in Apache Tomcat, edit the file <tomcat>/conf/context.xml and locate the following lines.

Remove the comment markers from lines 2 and 4 above, then restart Apache-Tomcat activate the change. For other application servers, refer to the product documentation.

Session Error Using JasperReports Server and Tomcat 7

On some versions of Tomcat 7, a session error might occur while running reports, with the log error “A request has been denied as a potential CSRF attack.” This is due to a known conflict between security settings in Direct Web Remote library (DWR) 2.x and some versions of Tomcat 7.0.x:

To work around this problem, you must modify these safeguards by doing one of the following:

OR

For more information on the security impact and relative risks of these two choices, see, for example, the Cross-site Scripting and Cross-site Request Forgery pages at the Open Web Application Security Project (OWASP).

Disabling httpOnly for Cookies in Tomcat

The application server hosting JasperReports Server handles the session cookie. To prevent malicious scripts on a client from accessing the session cookie and the user connection, Tomcat 7 is set to use httpOnly cookies. This tells the browser that only the server may access the cookie, not scripts running on the client. When enabled, this setting safeguards against XSS attacks.

You can disable this by setting httpOnly in the file <tomcat>/conf/context.xml:

Allowing Requests from Other Domains in DWR

DWR is a server-side component used for Input Controls. By default, DWR uses session ID cookies to prevent cross-site request forgery. You can disable the protection in DWR by setting the crossDomainSessionSecurity parameter for the dwr servlet in the file <tomcat>webappsjasperserverWEB-INFweb.xml: