Appendix C: Java VM Options

Top  Previous 

JVM options can be configured in .vmoptions files installed in the same directory as any of the Code Collaborator Java applications.  The name of the file must correspond to the name of the executable file, e.g., ccollab-server.vmoptions for the server, ccollab.vmoptions for the command line client, or ccollabgui.vmoptions for the GUI client.  This chapter summarizes some of the more common options used.

Note: The last line in a .vmoptions file must be followed by a new line.

To specify Java system properties that will be available to the application, use this syntax:

       -Dvariablename=value

Code Collaborator Server Properties

The following Java system properties are specific to the Code Collaborator server.

Property Name

Purpose and Usage

smartbear.userauth.class

This property specifies the authentication adapter used to authenticate users. Under normal circumstances, this property need not be set. Do not set this property unless directed by Smart Bear technical support.

smartbear.rpc.session.timeout

The timeout, in seconds, for XML-RPC sessions. The value must be a positive integer. Default is 30.

com.smartbear.ccollab.binary.converter.threads

The maximum number of threads allocated to convert binary documents into images for review. This value must be a positive integer. Default is 4.

com.smartbear.ccollab.license.noperiodicupdate

If set to a non-blank value, this property prevents the Code Collaborator server from checking for license updates.

smartbear.appstate.period

The delay, in milliseconds, between runs of the application state recorder. The state recorder periodically writes information about the state of the application into the database for future trend analysis. Default is 15 minutes.

smartbear.appstate.startup.delay

The delay, in milliseconds, before the application state recorder starts. Delaying the application state recorder allows the application initialization process to complete before anything is written to the database. Default is 5 minutes.

smartbear.chat.request.limit

The maximum number of chat update requests allowed per minute. This value will be used for active reviews and the clients and servers will automatically scale back the request rate as activity on the review declines.

com.smartbear.database.longquerythreshold

The time in milliseconds to allow database queries to run before logging a warning message. This is used to help debug bottlenecks and characterize the behavior of complex queries such as those used by the custom reports system. Default is 333 milliseconds.

Command Line Client Properties

The following properties are specific to the Command Line Client.

Property Name

Purpose and Usage

smartbear.ccollab.upload.truncate.size

The size, in bytes, to truncate uploaded files. This threshold prevents clients from inadvertently overloading the server with files too large to process. The default value is 4MB.

Java Heap Size

The default maximum heap size available for Code Collaborator client applications is 64MB.  Code Collaborator Server maximum heap size is set to 1GB by default.  The maximum heap size can be increased with the -Xmx switch.  For example, to set the maximum heap to 256MB, use the following line:

       -Xmx256M

 

G, M or K can be used to represent gigabytes, megabytes or kilobytes.  Note that not all JVM's support -X options.

Network Proxy Settings

Server proxies can be configured in the ccollab-server.vmoptions file.  See Network Configuration for the settings.

Network Connection Debugging

For debugging LDAP or SSL connection problems, or other network related issues, an additional server log file with trace information, output.log, will be created at restart with the following line in ccollab-server.vmoptions:

       -Djavax.net.debug=all