All Configuration Tags
Resin

Change Log
Documentation

Orientation
Features
Installation
Configuration
Web Applications
JSP
Servlets and Filters
Databases
Admin (JMX)
Security
XML and XSLT
XTP
Resources (JNDI)
Performance
Protocols
Third-party
Troubleshooting

env
web-app
resin.conf
log
el vars
init
index
Common Tasks
Relax Schema
Config FAQ
Scrapbook
init
Configuration
Common Tasks

Alphabetical index of all configuration tags.

access-log
Specify the access log file.
always-load-session
As a child of <session-config> . Reload data from the store on every request. (resin 1.2)
always-save-session
As a child of <session-config> . Save session data to the store on every request. (resin 1.2)
archive-format
As a child of <access-log> . Configures the name used to archive old log files. Since Resin 2.1
arg
As a child of <resource> . Arguments to the resource's constructor. Since Resin 3.0
args
As a child of <compiling-loader> . Additional arguments to be passed to the Java compiler. Resin 3.0
args
As a child of <javac> . Any additional arguments for the compiler. Since Resin 3.0
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.
auth-method
As a child of <login-config> . Authentication method, either BASIC for HTTP Basic Authentication, FORM for form based authentication, or DIGEST for HTTP Digest Authentication .
authenticator
Configures an authentication resource for the current context.
authenticator
As a child of <login-config> . Select authenticator class
bean-class
As a child of <access-log> . An class extending class com.caucho.server.log.AccessLog for custom logging. Since Resin 3.0
cache-mapping
Specifies Expires times for cacheable pages.
case-insensitive
Specifies whether the environment context is case sensitive or insensitive.
character-encoding
Specifies the default character encoding for the environment.
class-loader
Adds dynamic classloaders to the current environment.
class-name
As a child of <constraint> . A class that extends class com.caucho.http.security.AbstractConstraint
cluster
Configures a cluster of Resin servers for load balancing and sharing state information.
cluster-definition
Defines a cluster for later use by cluster-ref.
cluster-group
As a child of <cluster> . specialized configuration for sub-clusters. Since Resin 3.0
cluster-group
As a child of <cluster-definition> . specialized configuration for sub-clusters. Since Resin 3.0
cluster-ref
As a child of <cluster> . an identifier for a previous cluster-definition to use for the cluster. Since Resin 3.0
cluster-store
As a child of <session-config> . Persistent sessions use the cluster for storage. (resin 3.0)
compiler
As a child of <javac> . Configures the Java compiler to use. Since Resin 3.0
compiling-loader
Configures an auto-compiling WEB-INF/classes -style class loader.
config-file
Specifies configuration files for the web-app.
connection-factory
As a child of <connector> . Configures a connection-factory
connector
Configures a JCA resource adapter and its associated connection factories.
connector
As a child of <connector> . Configures a connector
connector-name
As a child of <connector> . Specifies the rar connector's display-name
constraint
context-param
Initializes application (ServletContext) variables.
cookie-domain
As a child of <session-config> . Domain for session cookies. (resin 1.2)
cookie-length
As a child of <session-config> . Maximum length of the cookie. (resin 2.1.1)
cookie-max-age
As a child of <session-config> . Max age for persistent session cookies. (resin 2.0)
cookie-version
As a child of <session-config> . Version of the cookie spec for sessions. (resin 1.2)
database
Defines a database resource.
dependency
Configures a path as a file which should force a reload when changed, like web.xml and resin.xml.
dependency-check-interval
Configures how often the environment context should be checked for changes.
description
description
As a child of <web-resource-collection> .
dispatcher
As a child of <filter-mapping> .
display-name
display-name
distributable
document-directory
As a child of <web-app> . The document directory for the application, corresponding to a url of /id/. . Can use regexp replacement variables.
ear-deploy
Specifies ear expansion.
ejb-local-ref
ejb-ref
ejb-server
Configures an EJB/CMP server.
enable-cookies
As a child of <session-config> . Enable cookies for sessions. (resin 1.1)
enable-url-rewriting
As a child of <session-config> . Enable URL rewriting for sessions. (resin 1.1)
encoding
As a child of <compiling-loader> . I18N encoding for the Java compiler. Since Resin 3.0
encoding
As a child of <javac> . Any encoding valued for the compiler. Since Resin 3.0
env-entry
Configures a JNDI scalar value for JNDI-based application configuration.
env-entry
env-entry-name
As a child of <env-entry> . JNDI name to store the value. Since Servlet 2.1
env-entry-type
As a child of <env-entry> . Java type for the value. Since Servlet 2.1
env-entry-value
As a child of <env-entry> . Value to be stored. Since Servlet 2.1
error-code
As a child of <error-page> . Select the error page based on an HTTP status code
error-page
A page to display if the current request fails.
exception-type
As a child of <error-page> . Select the error page based on a Java exception
expand-path
As a child of <resource-deploy> . Configures the directory where Resin will expand rar files
expand-path
As a child of <ear-deploy> . directory where ears should be expanded
expand-path
As a child of <web-app-deploy> . directory where wars should be expanded
expires
As a child of <cache-mapping> . A time interval.
extension
As a child of <mime-mapping> . url extension
factory
As a child of <jndi-link> . Class name of the JNDI InitialContextFactory. Since Resin 1.2
factory
As a child of <reference> . Class name of the ObjectFactory. Resin 3.0
file-store
As a child of <session-config> . Persistent sessions using a file store. (resin 1.2)
filter
Defines a filter alias for later mapping.
filter-class
As a child of <filter> . The filter's class (defaults to filter-name), which extends class javax.servlet.Filter
filter-mapping
Maps url patterns to filters.
filter-name
As a child of <filter> . The filter's name (alias)
filter-name
As a child of <filter-mapping> . The filter name
filter-name
As a child of <filter-mapping> . The filter name can use replacement vars from url-regexp like $1. It can also specify a class name directly like test.HelloWorld
foreign-name
As a child of <jndi-link> . Sub-context of the foreign JNDI context. Since Resin 1.2
form-error-page
As a child of <form-login-config> . The error page for unsuccessful login
form-login-config
As a child of <login-config> . Configuration for form login, see <form-login-config>
form-login-config
Configures authentication using forms.
form-login-page
As a child of <form-login-config> . The page to be used to prompt the user login
form-uri-priority
As a child of <form-login-config> . If true, the form's j_uri will override a stored URI
format
As a child of <access-log> . Access log format.
http-method
As a child of <web-resource-collection> . HTTP methods to be restricted.
id
As a child of <cluster> . identifies the cluster for later reference. Since Resin 3.0
id
As a child of <cluster-definition> . identifies the cluster for later reference. Since Resin 3.0
id
As a child of <web-app> . The url prefix selecting this application.
ignore-serialization-errors
As a child of <session-config> . When persisting a session, ignore any values which don't implement java.io.Serializable
init
As a child of <connector> . Bean-style initialization
init
As a child of <reference> . Bean-style initialization for the factory
init
As a child of <resource> . Bean-style initialization for the bean
init
As a child of <authenticator> . A bean-style configuration section. Since Resin 3.0
init
As a child of <login-config> . Initialization for the custom login class
init
As a child of <access-log> . Bean-style initialization for the custom class. Resin 3.0
init
Configures Java Bean-style objects.
init-param
As a child of <jndi-link> . Configuration parameters for the JNDI environment passed to InitialContextFactory. Since Resin 1.2
init-param
As a child of <filter> . Initialization parameters, see method FilterConfig.getInitParameter(String)
init-param
As a child of <servlet> . Initialization parameters
init-param
As a child of <constraint> . initialization parameters, set in the object using Bean-style setters and getters
internal-forward
As a child of <form-login-config> . Use an internal redirect on success instead of a sendRedirect
invalidate-after-listener
As a child of <session-config> . . (resin 3.0)
j_password
As a child of <form-login-config> . The password
j_security_check
As a child of <form-login-config> . The form's mandatory action
j_uri
As a child of <form-login-config> . Optional Resin extension for the successful display page.
j_use_cookie_auth
As a child of <form-login-config> . Optional Resin extension to allow cookie login.
j_username
As a child of <form-login-config> . The user name
javac
Configures the Java compiler for automatically compiled files.
jdbc-store
As a child of <session-config> . Persistent sessions using a JDBC store. (resin 1.2)
jndi-link
Links a foreign JNDI contexts or JNDI object.
jndi-name
As a child of <connector> . JNDI name for a resource-adapter or connection-factory
jndi-name
As a child of <jndi-link> . The JNDI name where the foreign context should be linked. Resin 3.0
jndi-name
As a child of <reference> . JNDI name for the reference. Since Resin 3.0
jndi-name
As a child of <resource> . JNDI name for the resource. Since Resin 3.0
jndi-name
As a child of <authenticator> . The JNDI name where the authenticator will be saved. Since Resin 3.0
jsp-config
lazy-init
As a child of <web-app-deploy> . true if web-apps should only be initialized when first used
level
As a child of <stderr-log> . The log level. Since Resin 3.0
level
As a child of <access-log> . The log level. Since Resin 3.0
level
As a child of <log> . The log level. Since Resin 3.0
library-loader
Configures a jar library, WEB-INF/lib -style class loader.
listener
As a child of <resource> . Registers the bean as a listener for a JMX emitter. Resin 3.0
listener
load-on-startup
As a child of <servlet> . Initializes the servlet when the server starts.
locale-encoding-mapping-list
location
As a child of <error-page> . The error page to display
log
Configures JDK 1.4 java.util.logger logging.
log
Configure the amount and destination of debug logging for the JDK 1.4 java.util.logging.* API.
login-config
HTTP Authentication is defined in the RFC HTTP Authentication: Basic and Digest .
make-loader
Configures a custom make-style loader.
mbean-name
As a child of <resource> . JMX name for management registration. Resin 3.0
message-destination
message-destination-ref
method
As a child of <web-resource-collection> .
mime-mapping
Maps url patterns to mime-types.
mime-type
As a child of <mime-mapping> . the mime-type
multipart-form
Enables multipart-mime for forms and file uploads.
name
As a child of <log> . A hierarchical name, typically aligned with the Java packaging names. Since Resin 3.0
path
As a child of <compiling-loader> . Filesystem path for the class loader. Since Resin 3.0
path
As a child of <library-loader> . Filesystem path for the class loader. Since Resin 3.0
path
As a child of <simple-loader> . Filesystem path for the class loader. Since Resin 3.0
path
As a child of <resource-deploy> . Configures the path where users will place .rar files
path
As a child of <dependency> . Filesystem path to the dependent file. Since Resin 3.0
path
As a child of <ear-deploy> . The path to the deploy directory
path
As a child of <web-app-deploy> . The path to the webapps directory
path
As a child of <stdout-log> . Filesystem path for the stream, see "Log Paths". Since Resin 3.0
path
As a child of <stderr-log> . Filesystem path for the stream, see "Log Paths". Since Resin 3.0
path
As a child of <access-log> . Filesystem path for the stream, see "Log Paths". Since Resin 3.0
path
As a child of <log> . Filesystem path for the stream, see "Log Paths". Since Resin 3.0
path-mapping
Maps url patterns to real paths.
persistent-path
As a child of <session-config> . . (resin 3.0)
prefix
As a child of <simple-loader> . Class package prefix to only load to a subset of classes. Resin 3.0
real-path
As a child of <path-mapping> . The prefix of the real path. When used with url-regexp, allows substitution variables like $1.
realm-name
As a child of <login-config> . The realm name to use in HTTP authentication
reference
Configures a JNDI ObjectFactory.
require-source
As a child of <compiling-loader> . If true, .class files without matching .java files will be deleted. Since Resin 3.0
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.
resource
Configures a custom bean resource and stores in JNDI.
resource-adapter
As a child of <connector> . Configures the resource-adapter
resource-deploy
Defines a deployment directory for .rar files.
resource-deploy
As a child of <resource-deploy> . Configures .rar deployment
resource-env-ref
resource-ref
Declares that the application needs a resouce configuration.
resource-ref
reuse-session-id
As a child of <session-config> . Reuse the session id even if the session has timed out. (resin 2.0.4)
role-name
As a child of <auth-constraint> . Roles which are allowed to access the resource.
rollover-period
As a child of <stdout-log> . how often to rollover the log. Specify in days (15D), weeks (2W), months (1M), or hours (1h)
rollover-period
As a child of <stderr-log> . how often to rollover the log. Specify in days (15D), weeks (2W), months (1M), or hours (1h)
rollover-period
As a child of <access-log> . how often to rollover the log. Specify in days (15D), weeks (2W), months (1M), or hours (1h)
rollover-period
As a child of <log> . how often to rollover the log. Normally in days (15D), weeks (2W) or months (1M), see "Rollover Periods" for others.
rollover-size
As a child of <stdout-log> . max size of the log before a rollover in, bytes.
rollover-size
As a child of <stderr-log> . max size of the log before a rollover, in bytes.
rollover-size
As a child of <access-log> . max size of the log before a rollover, in bytes.
rollover-size
As a child of <log> . max size of the log before a rollover, in bytes.
run-at
As a child of <servlet> . Times to execute the servlet automatically, . A Resin extension.
save-on-shutdown
As a child of <session-config> . Only save session when the application shuts down. (resin 1.2.3)
security-constraint
Specifies protected areas of the web site.
security-role
servlet
Defines a servlet alias for later mapping using .
servlet-class
As a child of <servlet> . The servlet's class (In Resin, defaults to servlet-name)
servlet-mapping
Maps url patterns to servlets.
servlet-name
As a child of <servlet> . The servlet's name (alias)
servlet-name
As a child of <servlet-mapping> . The servlet name
servlet-name
As a child of <servlet-mapping> . The servlet name can use replacement vars from url-regexp like $1. It can also specify a class name directly like test.HelloWorld
session-config
Session configuration parameters.
session-max
As a child of <session-config> . Maximum active sessions
session-timeout
As a child of <session-config> . The session timeout in minutes, 0 means never timeout.
simple-loader
Configures a simple classes -style class loader.
source
As a child of <compiling-loader> . Java source directory. Since Resin 3.0
srun
As a child of <cluster> . configures the srun port and protocol for a cluster server. Since Resin 3.0
srun
As a child of <cluster-definition> . configures the srun port and protocol for a cluster server. Since Resin 3.0
stderr-log
Configures the destination for System.err .
stderr-log
Configure the destination for System.err .
stdout-log
Configures the destination for System.out .
stdout-log
Configure the destination for System.out .
strict-mapping
Forces servlet-mapping to follow strict Servlet 2.2, disallowing PATH_INFO.
system-property
Sets a Java system property.
temp-dir
Application temp directory.
timestamp
As a child of <stdout-log> . a timestamp format string to use at the beginning of each log line. Since Resin 3.0
timestamp
As a child of <stderr-log> . a timestamp format string to use at the beginning of each log line. Since Resin 3.0
timestamp
As a child of <log> . a timestamp format string to use at the beginning of each log line. Since Resin 3.0
transport-guarantee
As a child of <user-data-constraint> . Required transport properties. NONE, INTEGRAL, and CONFIDENTIAL are allowed values.
type
As a child of <connector> . For connectors with multiple connection-factories, specifies the connection-factory
type
As a child of <resource> . Bean class implementing the resource. Since Resin 3.0
type
As a child of <authenticator> . The implementing class for the authenticator. Since Resin 3.0
type
As a child of <login-config> . Defines a custom class which extends com.caucho.server.security.AbstractLogin
upload-max
As a child of <multipart-form> . maximum size of an upload request (in kb).
url-pattern
As a child of <cache-mapping> . A pattern matching the url: /foo/*, /foo, or *.foo
url-pattern
As a child of <path-mapping> . A pattern matching the url: /foo/*, /foo, or *.foo
url-pattern
As a child of <filter-mapping> . A pattern matching the url: /foo/*, /foo, or *.foo
url-pattern
As a child of <servlet-mapping> . A pattern matching the url: /foo/*, /foo, or *.foo
url-pattern
As a child of <web-resource-collection> . url patterns describing the resource
url-prefix
As a child of <web-app-deploy> . url-prefix added to all expanded webapps
url-regexp
As a child of <cache-mapping> . A regular expression matching the url
url-regexp
As a child of <path-mapping> . A regular expression matching the url
url-regexp
As a child of <web-app> . A regexp to select this application.
url-regexp
As a child of <filter-mapping> . A regular expression matching the url
url-regexp
As a child of <servlet-mapping> . A regular expression matching the url
user-data-constraint
Restricts access to secure transports, such as SSL
web-app
web-app configures a web application.
web-app-default
Establishes the defaults for a .
web-app-deploy
Specifies war expansion.
web-resource-collection
Specifies a collection of areas of the web site.
web-resource-name
As a child of <web-resource-collection> . a name for a web resource collection
welcome-file-list
Sets the files to use as when no filename is present in url.
work-dir
Application work directory.

init
Configuration
Common Tasks
Copyright © 1998-2003 Caucho Technology, Inc. All rights reserved.
Resin® is a registered trademark, and HardCoretm and Quercustm are trademarks of Caucho Technology, Inc.