This page last changed on Feb 02, 2010 by mmcgarry.
The features described on this page are available in tc Server and tc Server Standard Edition.
Feedback is welcome. Click Add Comment at the bottom of the page.
tc Server Configuration Reference
This page defines the fields on the Views > Server Configuration > Configuration tab - the page where an authorized user can configure a tc Server instance.
General Configuration
Server Properties
Field Name |
Description |
Shutdown Port |
The TCP/IP port where the tc Server instance listens for a shutdown command. The connection must be initiated from the same server computer that is running this instance of tc Server.
Valid values are -1, 1, 2, ... up to 65535.
With the default setting, "-1", no shutdown port is enabled, so that the only way the server instance can be shut down is by a local "kill" statement to the server process. |
Shutdown Command |
The command to issue via a TCP/IP connection to the Shutdown Port to shut down tc Server. |
JMX Listener
The JMX Listener section configures the component of the tc Server instance that listens for Java Management Extensions (JMX) connections from management tools, such as the HQ Agent. By default, tc Server enables JMX connectivity.
Field Name |
Description |
Enabled |
Specifies whether the tc Server instance's pre-configured JMX listener is enabled.
Important: The HQ Agent uses JMX to connect to tc Server, so if you disable the JMX listener then you will not be able to use configure tc Server instances or groups from the HQ user interface, unless you configure JMX for tc Server through some other mechanism. |
Port |
Specifies the port upon which tc Server listens for JMX/RMI connections. Specify a port number that is not in use by another process. |
IP Address |
Specifies the IP address upon which tc Server listens for JMX/RMI connections. If the IP address is on the same as the tc Server instance, you can enter 127.0.0.1. |
Protocols |
Specifies a comma-separated list of enabled SSL/TLS protocols. If you do not enter a value for this property, the default protocols are enabled. |
Authenticate |
Specifies whether tc Server authenticates users that connect to the server using the JMX port.
If you enable this field, tc Server looks up the user and password in the files specifies by the Access File and Password File fields, respectively; if tc Server finds the username and password in the files, then the user is authenticated and allowed JMX access. If you disable this property, all users may access tc Server via JMX.
You configure the JMX user and password in HQ on server instances the Inventory > Configuration Properties page. The default JMX user and password is configured by default when you install tc Server; if, however, you change the name or password of the user in the access and password files, you must also change the configured user/password in the HQ user interface. |
Access File |
Specifies the full pathname of the tc Server file that contains the list of users allowed to access tc Server using JMX. Note that this file is on the computer that hosts the tc Server instance, not the computer that hosts the HQ Server.
The access file contains one line per user; each line contains a username and permission level:
- "readonly" - user can only view tc Server configuration
- "readwrite" - user can view and modify tc Server configuration.
The default name for the access file is jmxremote.access; the default location is the CATALINA_BASE/conf directory of the tc Server instance. Each tc Server is configured by default with an "admin" user with readwrite permission.
|
Password File |
Specifies the full pathname of the tc Server file that contains passwords for the users listed in the Access File. Note that this file is on the computer that hosts the tc Server instance, not the computer that hosts the HQ Server.
The password file contains one line for each user listed in the access file; each line contains a username and password.
The default name for the password file is jmxremote.password; the default location is the CATALINA_BASE/conf directory of the tc Server instance. The password for the pre-configured "admin" user is "springsource". |
Use SSL |
Specifies whether to use secure sockets layer (SSL) for users' JMX connections to tc Server.
To use SSL, you must first set up a digital certificate on the computer that hosts the tc Server instance and then configure the SSL setings on this page. You can use the command-line utility [keytool |
http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/keytool.html} to manage digital certificates. |
Client Authentication |
Specifies whether client authentication is required when using SSL.
If you enable this property, tc Server authenticates JMX/SSL clients using certificate authentication rather than file-based authentication; this means that tc Server must find the client's certificate in its truststore or it will deny the client JMX access. This implies that only clients with known SSL certificates are allowed access to tc Server. |
Use JDK Client Factory |
Specifies whether or not the HQ Agent uses the required client libraries from the JDK. The required libraries are used to pass SSL-specific properties (such as the trust store and password) to the tc Server instance. If you disable this property, you must manually set up the HQ Agent's CLASSPATH to find these client libraries. |
Cipher Suites |
Specifies a comma-separated list of enabled SSL/TLS cipher suites. A cipher suite is a combination of cryptographic parameters that define the security algorithms and key sizes used for authentication, key agreement, encryption, and integrity protection.
If you do not enter a value for this property, the default cipher suites are enabled. |
Truststore File |
Specifies the full pathname of the truststore file used by SSL.
A truststore is a special kind of keystore file that is used when making decisions about what to trust. If you receive some data from an entity that you already trust, and if you can verify that the entity is the one it claims to be, then you can assume that the data came from that entity. This means that the key of a truststore file typically contains an entity's identity and a public key, as opposed to a private key contained in a more restricted keystore file. |
Truststore Pass |
Specifies the password used to access the truststore file. |
Keystore File |
Specifies the full pathname of the keystore file.
A keystore is a database of key material. Key material is used for a variety of purposes, including authentication and data integrity. There are various types of keystores available, including "PKCS12" and Sun's "JKS." Typically, the key of a keystore consists of an entity's identity and its private key. |
Keystore Pass |
Specifies the password used to access the keystore file. |
Server Start Configuration
NOTE: HQ populates these fields with information contained in the CATALINA_HOME/bin/setenv.sh file of the tc Server instance you are configuring, specifically argument values defined in the JVM_OPTS environment variable.
If for some reason setenv.sh does not exist, or does not define JVM_OPTS, the Server Start fields will be blank.
Edits you make to Server Start fields in the HQ user interface are written back to setenv.sh.
General
Field Name |
Description |
Java Home |
Specifies the full pathname to the JDK or JRE used by the tc Server instance. |
Use Server HotSpot VM |
Check to use the Java HotSpot Virtual Machine. |
Min Heap Size |
Specifies the initial size, in MB, of the memory allocation pool. |
Max Heap Size |
Specifies the maximum size, in MB, of the memory allocation pool. |
Thread Stack Size |
Specifies the amount of memory, in KB, allocated to a single JVM thread. |
Sun Specific JVM Options
The options in the following table are specific to Sun JVMs. Modify the option values with caution. If you use a non-Sun VM, altering the values might have unintended side effects.
Memory
Field Name |
Description |
Min Young Generation Size |
Specifies the default size, in MB, of new generation. |
Max Young Generation Size |
Specifies the maximum size, in MB, of new generation. |
Min Perm Gen Size |
Specifies the initial size, in MB, of the permanent generation. |
Max Perm Gen Size |
Specifies the maximum size, in MB, of the permanent generation. |
Garbage Collection
Field Name |
Description |
Max GC Pause |
Sends a hint to the virtual machine that pause times of the specified milliseconds or less are desired. The VM will adjust the Java heap size and other GC-related parameters in an attempt to keep GC-induced pauses shorter than the specified value.
Note that this may cause the VM to reduce overall throughput, and in some cases the VM will not be able to meet the desired pause time goal. |
Max GC Minor Pause |
Similar to Max GC Pause, but for minor pauses. |
Debug
Field Name |
Description |
Heap Dump on Out of Memory Error |
Directs the JVM to generate a heap dump when an allocation from the Java heap or the permanent generation cannot be satisfied. |
Print Message at GC |
Specifies whether the JVM should print messages to the GC log file every time it performs a garbage collection. |
Print Heap at GC |
Specifies whether the JVM should print detailed information, including heap occupancy before and after a garbage collection, to the GC log file. |
Print GC Application Stopped Time |
Specifies whether the JVM should print the amount of time an application is stopped during a garbage collection to the GC log file. |
Print GC Timestamps |
Specifies whether the JVM should print timestamps relating to garbage collection to the GC log file. |
Print GC Details |
Specifies whether the JVM should print detailed information relating to garbage collection to the GC log file. |
GC Log File |
Specifies the name of the GC log file to which all garbage collection information is printed. Default value is CATALINA_BASE/logs/gc.log. |
Advanced
Field Name |
Description |
Command Line Arguments |
Enter additional options to the CATALINA_OPTS environment variables if they are not available as text fields on this configuration page. Use one of these forms:
-X:OptionValue
or
-XX:Option=Value
with a space between options.
For example:
-Xms512M -Xmx512M -XX:NewSize=128M |
Context Container
The fields described in the following table configure the context for every Web application deployed to this tc Server instance. HQ loads and updates the values from the CATALINA_BASE/conf/context.xml file for this tc Server.
Static Resource Cache
Field Name |
Description |
Allow Caching |
If checked, specifies that tc Server uses the cache for static resources. |
Max Cache Size |
Maximum size, in KB, of the static resource cache. Default value is 10240 (10 megabytes). |
Cache TTL |
Amount of time, in milliseconds, between cache entries revalidation. Default value is 5000 (5 seconds). |
Web Application Logger
Field Name |
Description |
Swallow Output |
If checked, specifies that tc Server will redirect the bytes outputted by the Web application to System.out and System.err to the Web application logger. |
Server Defaults: JSP
The fields described in the following table configure JSP-related init params for every Web application deployed to this tc Server instance. HQ loads and updates the values from the CATALINA_BASE/conf/web.xml file for this tc Server.
Field Name |
Description |
Recompile Check Interval (s) |
Specifies the interval, in seconds, at which tc Server checks to see if a JSP and its dependent file need to be recompiled. Default value is 0.
If you set this field to a value greater than zero, and Development Mode is unchecked, then tc Server performs the compilation in the background. |
Development Mode |
Specifies that tc Server is working in development mode. When this value is checked, you can specify the frequency at which JSPs are checked for modification using the Modification Test Interval field. |
Modification Test Interval (s) |
Specifies the interval, in seconds, that tc Server should wait before checking JSPs and their dependent files for modifications. If you set this field to 0, then tc Server checks the JSPs every time they are accessed. Default value is 4 seconds.
This feature is enabled only when Development Mode is checked. |
Compiler |
Specifies the JSPs compiler used by tc Server. If not set, then tc Server uses the default Eclipse JDT Java compiler. |
Compiler Target VM |
Specifies the JDK version with which the generated files are compatible. Default value is JDK 1.4. |
Compiler Source VM |
Specifies the JDK version with which the source files are compatible. Default value is JDK 1.4 |
Compile Class With Debug Information |
Specifies whether the JSP class should be compiled with debug information. |
Classpath |
Specifies the CLASSPATH that tc Server should use when compiling the generated servlets. tc Server creates the default CLASSPATH dynamically based on the current Web application. |
Fork JSP Page Compile to Separate JVM |
Specifies whether tc Server should fork the compilation of JSPs so they are performed in a separate JVM than tc Server. |
Enable Tag Handler Pooling |
Enables tag handler pooling. |
Internet Explorer class-id for <jsp:plugin> Tags |
Specifies the class-id value that tc Server sends to Internet Explorer when using the tags.
Default value is clsid:8AD9C840-044E-11D1-B3E9-00805F499D93. |
Java File Encoding |
Specifies the Java file encoding to use for generating Java source files. Default value is UTF8. |
Keep Generated Source Code |
Specifies whether tc Server should keep the generated source code for each page rather than deleting it. |
Generate One Print Statement Per Input Line |
Specifies whether tc Server should generate static content with one print statement per input line, to ease debugging. |
Trim Spaces In Template Text |
Specifies whether tc Server should trim white spaces in template text between actions or directives. |
Suppress SMAP Information |
Specifies whether tc Server should suppress the generation of SMAP information for JSR-45 debugging. |
Dump SMAP Information |
Specifies whether tc Server should dump SMAP information for JSR-45 debugging to a file. If you want to set this field to true (checked), then be sure to also uncheck Suppress SMAP Information. |
Generate Strings as Char Arrays |
Specifies whether strings should be generated as character arrays. Checking this field will sometimes increase the performance of JSPs. |
Issue Error For Invalid useBean Class Attribute |
Specifies whether tc Server should issue an error when the value of the class attribute in a useBean action is not a valid bean class. |
Scratch Directory |
Specifies the scratch directory that tc Server should use when compiling JSP pages. Default value is the work directory for the current Web application. |
Add X-Powered-By Response Header |
Specifies whether generated servlet adds the the X-Powered-By response header. |
Server Defaults: Static Content
The fields described in the following table configure static content-related init params for every Web application deployed to this tc Server instance. HQ loads and updates the values from the CATALINA_BASE/conf/web.xml file for this tc Server.
Field Name |
Description |
Debug Level |
Specifies the level of detail contained in the debugging messages from the current servlet. Default value is 0 (no debugging.) |
File Encoding |
Specifies the encoding that tc Server uses when reading static resources. The default value is the same as the file encoding of the platform on which tc Server is running. |
Input Buffer Size |
Specifies the size, in bytes, of the input buffer that tc Server users when reading resources to be served. Default value is 2048. |
Output Buffer Size |
Specifies the size, in bytes, of the output buffer that tc Server users when writing resources to be served. Default value is 2048. |
Min Sendfile Size |
Specifies the minimal file size, in KB, that tc Server uses with "sendfile". This field only works if the connector supports sendfile. Default value is 48. |
Show Directory Listings |
Specifies whether tc Server should produce a directory listing if there is no welcome file in the directory. WARNING: Directory listings that include many entries can be slow and consume significant proportion of the tc Server resources. |
Readme File Name |
File name to display with the directory contents. No default value. |
Read Only |
Specifies whether the current context is read-only, which means that it rejects HTTP commands such as PUT and DELETE. |
|