INDEX: All Configuration Tags
Resin 3.1

Documentation
Examples
Changes

Overview
Quick Start
Installation
Command-Line
Configuration
Admin
Amber
Clustering
Caching
Database
Deployment
EJB 3.0
Embedding
Filters
Hessian
HMTP
IoC
JSP
Logging
Messaging
Performance
Quercus/PHP
Remoting
Scheduled Tasks
Security
Server Push
Servlets
Third-party
Troubleshooting
Virtual Hosting
Watchdog
WebApp
XML and XSLT

<cluster>
<database>
<host>
Ports
<resin>
Resource tags
Rewrite
<server>
session
variables
<web-app>
Index
Relax Schema
<web-app>
Configuration
Relax Schema

Alphabetical index of all configuration tags.

class-loader
Adds dynamic classloaders to the current environment.
compiling-loader
Configures an auto-compiling WEB-INF/classes -style class loader.
args
As a child of . Additional arguments to be passed to the Java compiler. Resin 3.0
batch
As a child of . If true, multiple changed *.java files will be compiled in a single batch. Resin 3.0.7
encoding
As a child of . I18N encoding for the Java compiler. Since Resin 3.0
path
As a child of . Filesystem path for the class loader. Since Resin 3.0
source
As a child of . Java source directory. Since Resin 3.0
require-source
As a child of . If true, .class files without matching .java files will be deleted. Since Resin 3.0
library-loader
Configures a jar library, WEB-INF/lib -style class loader.
path
As a child of . Filesystem path for the class loader. Since Resin 3.0
tree-loader
Configures a jar library, WEB-INF/lib -style class loader similar to , but will also find .jar and .zip files in subdirectories.
path
As a child of . Filesystem path for the class loader. Since Resin 3.0
make-loader
Configures a custom make-style loader.
servlet-hack
Use of servlet-hack is discouraged.
simple-loader
Configures a simple classes -style class loader.
path
As a child of . Filesystem path for the class loader. Since Resin 3.0
prefix
As a child of . Class package prefix to only load to a subset of classes. Resin 3.0
cluster
Configures a cluster of Resin servers for load balancing and sharing state information.
id
As a child of . identifies the cluster for later reference. Since Resin 3.0
srun
As a child of . configures the srun port and protocol for a cluster server. Since Resin 3.0
cluster-group
As a child of . specialized configuration for sub-clusters. Since Resin 3.0
cluster-ref
As a child of . an identifier for a previous cluster-definition to use for the cluster. Since Resin 3.0
cluster-definition
Defines a cluster for later use by cluster-ref.
id
As a child of . identifies the cluster for later reference. Since Resin 3.0
srun
As a child of . configures the srun port and protocol for a cluster server. Since Resin 3.0
cluster-group
As a child of . specialized configuration for sub-clusters. Since Resin 3.0
connector
Configures a JCA resource adapter and its associated connection factories.
connector
As a child of . Configures a connector
connector-name
As a child of . Specifies the rar connector's display-name
resource-adapter
As a child of . Configures the resource-adapter
connection-factory
As a child of . Configures a connection-factory
jndi-name
As a child of . JNDI name for a resource-adapter or connection-factory
type
As a child of . For connectors with multiple connection-factories, specifies the connection-factory
local-transaction-optimization
As a child of . Enables the local transaction optimization. Resin 3.0.7
init
As a child of . Bean-style initialization
database
Defines a database resource.
ejb-server
Configures an EJB/CMP server.
env-entry
Configures a JNDI scalar value for JNDI-based application configuration.
env-entry-name
As a child of . JNDI name to store the value. Since Servlet 2.1
env-entry-type
As a child of . Java type for the value. Since Servlet 2.1
env-entry-value
As a child of . Value to be stored. Since Servlet 2.1
jndi-link
Links a foreign JNDI contexts or JNDI object.
jndi-name
As a child of . The JNDI name where the foreign context should be linked. Resin 3.0
factory
As a child of . Class name of the JNDI InitialContextFactory. Since Resin 1.2
foreign-name
As a child of . Sub-context of the foreign JNDI context. Since Resin 1.2
init-param
As a child of . Configuration parameters for the JNDI environment passed to InitialContextFactory. Since Resin 1.2
reference
Configures a JNDI ObjectFactory.
jndi-name
As a child of . JNDI name for the reference. Since Resin 3.0
factory
As a child of . Class name of the ObjectFactory. Resin 3.0
init
As a child of . Bean-style initialization for the factory
resource
Configures a custom bean resource and stores in JNDI.
jndi-name
As a child of . JNDI name for the resource. Since Resin 3.0
type
As a child of . Bean class implementing the resource. Since Resin 3.0
arg
As a child of . Arguments to the resource's constructor. Since Resin 3.0
mbean-name
As a child of . JMX name for management registration. Resin 3.0
init
As a child of . Bean-style initialization for the bean
listener
As a child of . Registers the bean as a listener for a JMX emitter. Resin 3.0
local-transaction-optimization
As a child of . Enables the local transaction optimization. Resin 3.0.7
resource-deploy
Defines a deployment directory for .rar files.
resource-deploy
As a child of . Configures .rar deployment
path
As a child of . Configures the path where users will place .rar files
expand-path
As a child of . Configures the directory where Resin will expand rar files
resource-ref
Declares that the application needs a resouce configuration.
log
Configures JDK 1.4 java.util.logger logging.
stderr-log
Configures the destination for System.err .
stdout-log
Configures the destination for System.out .
authenticator
Configures an authentication resource for the current context.
jndi-name
As a child of . The JNDI name where the authenticator is stored. Since Resin 3.0
type
As a child of . The implementing class for the authenticator. Since Resin 3.0
init
As a child of . A bean-style configuration section. Since Resin 3.0
system-property
Sets a Java system property.
javac
Configures the Java compiler for automatically compiled files.
compiler
As a child of . Configures the Java compiler to use. Since Resin 3.0
args
As a child of . Any additional arguments for the compiler. Since Resin 3.0
encoding
As a child of . Any encoding valued for the compiler. Since Resin 3.0
dependency
Configures a path as a file which should force a reload when changed, like web.xml and resin.xml.
path
As a child of . Filesystem path to the dependent file. Since Resin 3.0
dependency-check-interval
Configures how often the environment context should be checked for changes.
character-encoding
Specifies the default character encoding for the environment.
case-insensitive
Specifies whether the environment context is case sensitive or insensitive.
temp-dir
Application temp directory.
work-dir
Application work directory.
access-log
Specifies the access log file.
path
As a child of . The access log path.
format
As a child of . Access log format.
resin:type
As a child of . Class implementing AbstractAccessLog for custom logging.
rollover-period
As a child of . how often to rollover the log. Normally in days (15D), weeks (2W) or months (1M).
rollover-size
As a child of . max size of the log before a rollover.
archive-format
As a child of . format the name of the archive file.
cache
Configures Resin's internal HTTP proxy cache. Resin's cache can dramatically improve performance by avoiding re-evaluation of slowly changing database-backed changes.
path
As a child of . filesystem location of the cache
enable
As a child of . enables/disables the cache
entries
As a child of . max number of entries allowed in the cache
memory-size
As a child of . max size of the cache saved in memory
disk-size
As a child of . max size of the cache saved on disk
cluster
Defines the cluster of Resin JVMs used for load-balancing and for sharing distributed sessions.
connection-pool
Configures the thread pool shared among all ports.
thread-max
As a child of . maximum number of working threads
spare-thread-max
As a child of . maximum number of spare working threads
spare-thread-min
As a child of . minimum number of spare working threads
document-directory
Configures the directory where web pages will be placed when using webserver-style deployment instead of war-based deployment.
group-name
Configures the Unix setuid group name used after Resin binds the reserved ports as root.
host
Configures a virtual host.
id
As a child of . primary host name
regexp
As a child of . Regular expression based host matching
host-name
As a child of . Canonical host name
host-alias
As a child of . Aliases matching the same host
secure-host-name
As a child of . Host to use for a redirect to SSL
root-directory
As a child of . Root directory for host files
document-directory
As a child of . Document directory root
host-default
Defaults for a virtual host.
host-deploy
Configures a deploy directory for virtual host.
path
As a child of . path to the deploy directory
expand-path
As a child of . path to the expansion directory
host-default
As a child of . defaults for the expanded host&td> 
host-name
As a child of . the host name to match
http
Configures a HTTP port listening for HTTP requests.
server-id
As a child of . server id matching the -server command line
host
As a child of . hostname of the interface to listen to
port
As a child of . port to listen to
tcp-no-delay
As a child of . sets the NO_DELAY socket parameter
socket-listen-backlog
As a child of . The socket factory's listen backlog for receiving sockets
virtual-host
As a child of . forces all requests to this <http> to use the named virtual host
openssl
As a child of . configures the port to use OpenSSL
jsse-ssl
As a child of . configures the port to use JSSE for SSL
min-free-memory
For reliability, Resin periodically checks the amount of free memory available.
openssl
Configures SSL.
certificate-file
As a child of . the file containing the server's certificate
certificate-key-file
As a child of . the file containing the server's certificate key, if separate from certificate-file
password
As a child of . the certificate key password
certificate-chain-file
As a child of . A file containing an intermediate (untrusted) and root (trusted) certificate. See Certificate Chains.
session-cache
As a child of . true or false, enables the SSL session cache
session-cache-timeout
As a child of . sets the SSL session cache timeout in seconds
verify-client
As a child of . Verify the client, value is one of `require' (the client has to present a valid certificate), `optional' (the client may present a valid certificate), `optional-no-ca' (the client may present a certificate, it may be unverifiable)
verify-depth
As a child of . the maximum number of intermediate signers to accept when verifying client certificates
ca-certificate-file
As a child of . a file containing a concatenated list of PEM-encoded certificates recognized for client authentication
ca-revocation-file
As a child of . a file containing a concatenated list of PEM-encoded certificates which have been revoked and are no longer valid
protocol
As a child of . a combination of +all, -all, +sslv2, -sslv2, +sslv3, -sslv3, +tlsv1, -tlsv1
cipher-suite
As a child of .  
ping
Starts a thread that periodically makes a request to the server, and restarts Resin if it fails.
url
As a child of . A url to ping.
sleep-time
As a child of . Time to wait between pings. The first ping is always 15m after the server starts, this is for subsequent pings.
try-count
As a child of . If a ping fails, number of times to retry before giving up and restarting
retry-time
As a child of . time between retries
socket-timeout
As a child of . time to wait for server to satrt responding to the tcp connection before giving up
security-manager
Enable the use of the security manager for the JVM.
security-provider
Add one or more security providers.
resin
Top-level configuration for the resin.conf file.
root-directory
Specifies the root directory for the <server> and <host> contexts.
server
Main configuration for the server, configuring ports, threads and virtual hosts.
srun
Configures a clustered HMUX listener.
backup
As a child of . If true, the server is generally used as a backup
dead-time
As a child of . time to treat a connection-failed connection as dead
host
As a child of . hostname of the interface to listen to
index
As a child of . Session index of the srun
jsse-ssl
As a child of . configures the port to use JSSE for SSL
live-time
As a child of . time to keepalive a connection to the srun
openssl
As a child of . configures the port to use OpenSSL
port
As a child of . port to listen to
protocol
As a child of . configures the Srun protocol
server-id
As a child of . server id matching the -server command line
socket-listen-backlog
As a child of . The socket factory's listen backlog for receiving sockets
tcp-no-delay
As a child of . sets the NO_DELAY socket parameter
timeout
As a child of . time to wait for a request to reply
user-name
Configures the Unix setuid user name used after Resin binds the reserved ports as root.
fileset
<fileset> provides the ability to match a set of files.
dir
As a child of . the starting directory
include
As a child of . an include pattern
exclude
As a child of . an exclude pattern
cache-mapping
Specifies Expires times for cacheable pages.
url-pattern
As a child of . A pattern matching the url: /foo/*, /foo, or *.foo
url-regexp
As a child of . A regular expression matching the url
expires
As a child of . A time interval.
config-file
Specifies configuration files for the web-app.
ear-deploy
Specifies ear expansion.
path
As a child of . The path to the deploy directory
expand-path
As a child of . directory where ears should be expanded
jsp
Configures JSP behavior.
auto-compile
As a child of . Automatically compile changed JSP files
el-ignored
As a child of . Ignore EL expressions in JSP text
fast-jstl
As a child of . Optimize JSTL JSP compilation
ignore-el-exception
As a child of . Ignore exceptions generated in EL expressions
is-xml
As a child of . Default JSP pages to use XML syntax
precompile
As a child of . Try to load precompiled JSP pages
recompile-on-error
As a child of . Recompile the JSP file when an Error occurs in loading
require-source
As a child of . Return 404 when JSP source is deleted
session
As a child of . Creates sessions for each JSP page
velocity-enabled
As a child of . Enable Velocity statements
path-mapping
Maps url patterns to real paths.
url-pattern
As a child of . A pattern matching the url: /foo/*, /foo, or *.foo
url-regexp
As a child of . A regular expression matching the url
real-path
As a child of . The prefix of the real path. When used with url-regexp, allows substitution variables like $1.
shutdown-wait-max
The maximum time Resin will wait for requests to finish before closing the web-app.
strict-mapping
Forces servlet-mapping to follow strict Servlet 2.2, disallowing PATH_INFO.
web-app-default
Establishes the defaults for a .
web-app
web-app configures a web application.
id
As a child of . The url prefix selecting this application.
url-regexp
As a child of . A regexp to select this application.
document-directory
As a child of . The document directory for the application, corresponding to a url of /id/. Can use regexp replacement variables.
web-app-deploy
Specifies war expansion.
path
As a child of . The path to the webapps directory
url-prefix
As a child of . url-prefix added to all expanded webapps
expand-path
As a child of . directory where wars should be expanded
lazy-init
As a child of . true if web-apps should only be initialized when first used
multipart-form
Enables multipart-mime for forms and file uploads.
upload-max
As a child of . maximum size of an upload request (in kb).
description
display-name
distributable
context-param
Initializes application (ServletContext) variables.
filter
Defines a filter alias for later mapping.
filter-name
As a child of . The filter's name (alias)
filter-class
As a child of . The filter's class (defaults to filter-name), which extends
init-param
As a child of . Initialization parameters, see
filter-mapping
Maps url patterns to filters.
filter-name
As a child of . The filter name
url-pattern
As a child of . A pattern matching the url: /foo/*, /foo, or *.foo
dispatcher
As a child of .
url-regexp
As a child of . A regular expression matching the url
filter-name
As a child of . The filter name can use replacement vars from url-regexp like $1. It can also specify a class name directly like test.HelloWorld
listener
servlet
Defines a servlet alias for later mapping using .
servlet-name
As a child of . The servlet's name (alias)
servlet-class
As a child of . The servlet's class (In Resin, defaults to servlet-name)
init-param
As a child of . Initialization parameters
load-on-startup
As a child of . Initializes the servlet when the server starts.
run-at
As a child of . Times to execute the servlet automatically, A Resin extension.
servlet-mapping
Maps url patterns to servlets.
servlet-name
As a child of . The servlet name
url-pattern
As a child of . A pattern matching the url: /foo/*, /foo, or *.foo
url-regexp
As a child of . A regular expression matching the url
servlet-name
As a child of . The servlet name can use replacement vars from url-regexp like $1. It can also specify a class name directly like test.HelloWorld
servlet-regexp
Maps URL by regular expressions to custom servlets.
session-config
Session configuration parameters.
session-timeout
As a child of . The session timeout in minutes, 0 means never timeout.
session-max
As a child of . Maximum active sessions
enable-cookies
As a child of . Enable cookies for sessions. (resin 1.1)
enable-url-rewriting
As a child of . Enable URL rewriting for sessions. (resin 1.1)
cookie-version
As a child of . Version of the cookie spec for sessions. (resin 1.2)
cookie-domain
As a child of . Domain for session cookies. (resin 1.2)
cookie-max-age
As a child of . Max age for persistent session cookies. (resin 2.0)
cookie-length
As a child of . Maximum length of the cookie. (resin 2.1.1)
file-store
As a child of . Persistent sessions using a file store. (resin 1.2)
persistent-path
As a child of . (resin 3.0)
jdbc-store
As a child of . Persistent sessions using a JDBC store. (resin 1.2)
cluster-store
As a child of . Persistent sessions use the cluster for storage. (resin 3.0)
always-load-session
As a child of . Reload data from the store on every request. (resin 1.2)
always-save-session
As a child of . Save session data to the store on every request. (resin 1.2)
save-only-on-shutdown
As a child of . Only save session when the application shuts down. (resin 1.2.3)
reuse-session-id
As a child of . Reuse the session id even if the session has timed out. (resin 2.0.4)
ignore-serialization-errors
As a child of . When persisting a session, ignore any values which don't implement java.io.Serializable
invalidate-after-listener
As a child of . (resin 3.0)
mime-mapping
Maps url patterns to mime-types.
extension
As a child of . url extension
mime-type
As a child of . the mime-type
welcome-file-list
Sets the files to use as when no filename is present in url.
error-page
By default, Resin returns a 500 Servlet Error and a stack trace for exceptions and a simple 404 File Not Found for error pages.
error-code
As a child of . Select the error page based on an HTTP status code
exception-type
As a child of . Select the error page based on a Java exception
location
As a child of . The error page to display
jsp-config
resource-env-ref
message-destination-ref
resource-ref
security-constraint
Specifies protected areas of the web site.
display-name
web-resource-collection
Specifies a collection of areas of the web site.
web-resource-name
As a child of . a name for a web resource collection
description
As a child of .
url-pattern
As a child of . url patterns describing the resource
http-method
As a child of . HTTP methods to be restricted.
method
As a child of .
auth-constraint
Requires that authenticated users fill the specified role. In Resin's JdbcAuthenticator, normal users are in the "user" role. Think of a role as a group of users.
role-name
As a child of . Roles which are allowed to access the resource.
user-data-constraint
Restricts access to secure transports, such as SSL
transport-guarantee
As a child of . Required transport properties. NONE, INTEGRAL, and CONFIDENTIAL are allowed values.
constraint
resin:type
As a child of . A class that extends
init
As a child of . initialization parameters, set in the object using Bean-style setters and getters
login-config
HTTP Authentication is defined in the RFC HTTP Authentication: Basic and Digest .
auth-method
As a child of . Authentication method, either BASIC for HTTP Basic Authentication, FORM for form based authentication, or DIGEST for HTTP Digest Authentication.
realm-name
As a child of . The realm name to use in HTTP authentication
form-login-config
As a child of . Configuration for form login, see
type
As a child of . Defines a custom class which extends com.caucho.server.security.AbstractLogin
init
As a child of . Initialization for the custom login class
form-login-config
Configures authentication using forms.
form-login-page
As a child of . The page to be used to prompt the user login
form-error-page
As a child of . The error page for unsuccessful login
internal-forward
As a child of . Use an internal redirect on success instead of a sendRedirect
form-uri-priority
As a child of . If true, the form's j_uri will override a stored URI
j_security_check
As a child of . The form's mandatory action
j_username
As a child of . The user name
j_password
As a child of . The password
j_uri
As a child of . Optional Resin extension for the successful display page.
j_use_cookie_auth
As a child of . Optional Resin extension to allow cookie login.
security-role
env-entry
ejb-ref
ejb-local-ref
message-destination
locale-encoding-mapping-list
stdout-log
Configure the destination for System.out .
path
As a child of . Output path for the stream, see "Log Paths".
timestamp
As a child of . a timestamp format string to use at the beginning of each log line.
rollover-period
As a child of . how often to rollover the log. Specify in days (15D), weeks (2W), months (1M), or hours (1h). See Rollovers.
rollover-size
As a child of . maximum size of the file before a rollover occurs, in bytes (50000), kb (128kb), or megabytes (10mb). See Rollovers.
archive-format
As a child of . the format for the archive filename when a rollover occurs, see Rollovers.
stderr-log
Configure the destination for System.err .
path
As a child of . Output path for the stream, see "Log Paths".
timestamp
As a child of . a timestamp format string to use at the beginning of each log line.
rollover-period
As a child of . how often to rollover the log. Specify in days (15D), weeks (2W), months (1M), or hours (1h). See Rollovers.
rollover-size
As a child of . maximum size of the file before a rollover occurs, in bytes (50000), kb (128kb), or megabytes (10mb). See Rollovers.
archive-format
As a child of . the format for the archive filename when a rollover occurs, see Rollovers.
access-log
Specify the access log file.
path
As a child of . Output path for the log entries, see "Log Paths".
format
As a child of . Access log format.
rollover-period
As a child of . how often to rollover the log. Specify in days (15D), weeks (2W), months (1M), or hours (1h). See Rollovers.
rollover-size
As a child of . maximum size of the file before a rollover occurs, in bytes (50000), kb (128kb), or megabytes (10mb). See Rollovers.
archive-format
As a child of . the format for the archive filename when a rollover occurs, see Rollovers.
resin:type
As a child of . a class extending for custom logging
init
As a child of . bean-style initialization for the custom class
log
Configure the amount and destination of debug logging for the JDK java.util.logging.* API.
name
As a child of . A hierarchical name, typically aligned with the Java packaging names
level
As a child of . The log level
path
As a child of . Output path for the log messages, see "Log Paths"
timestamp
As a child of . a timestamp format string to use at the beginning of each log line.
format
As a child of . a format string to control the output of each log message. Since Resin 3.0.5.
rollover-period
As a child of . how often to rollover the log. Specify in days (15D), weeks (2W), months (1M), or hours (1h). See Rollovers.
rollover-size
As a child of . maximum size of the file before a rollover occurs, in bytes (50000), kb (128kb), or megabytes (10mb). See Rollovers.
archive-format
As a child of . the format for the archive filename when a rollover occurs, see Rollovers.
handler
As a child of . add a custom Handler, the name of a class that extends
formatter
As a child of . set a custom Formatter, the name of a class that extends
init
Configures Java Bean-style objects.
resin:type
This special attribute can be used with all sub-beans to instantiate a different bean class than the one defined in the parent bean.
resin:set
resin:set adds an EL variable to the current context.
name
As a child of . name of the variable to set
value
As a child of . value
resin:if
resin:if executes part of the configuration file conditionally.
test
As a child of . the test to perform
resin:choose
resin:choose implements an if, elsif, else.
resin:when
As a child of .
resin:choose
As a child of .
resin:when
test
As a child of . the test to perform
resin:otherwise
test
As a child of . the test to perform
resin:log
Logs a message to the given log file.
resin:import
resin:import is used to read configuration information from another file. The target file is validated by a schema where the schema depends on the location of the resin:import. A resin:import in <server> will have a target with a top-level of <server>.
path
As a child of . a path to a file
fileset
As a child of . a
optional
As a child of . if true, no error when file does not exist
resin:env
resin:env creates a new environment for a section of the configuration file.
jndi:lookup
The configuration EL supports a the static function jndi:lookup. jndi:lookup can be used to lookup a JNDI value for the configuration.
fmt.timestamp()
Format a timestamp string.
fmt.sprintf()
Format a string using a sprintf-like format string.

<web-app>
Configuration
Relax Schema
Copyright © 1998-2006 Caucho Technology, Inc. All rights reserved.
Resin ® is a registered trademark, and Quercustm, Ambertm, and Hessiantm are trademarks of Caucho Technology.