Caucho Technology
  • resin 4.0
  • index: all configuration tags


    Alphabetical index of all configuration tags.

    <access-log>
    Specifies the access log file.
    access-log
    Specify the access log file.
    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 stderr-log. the format for the archive filename when a rollover occurs, see Rollovers.
    archive-format
    As a child of access-log. format the name of the archive file.
    archive-format
    As a child of log. the format for the archive filename when a rollover occurs, see Rollovers.
    archive-format
    As a child of stdout-log. the format for the archive filename when a rollover occurs, see Rollovers.
    archive-format
    As a child of access-log. the format for the archive filename when a rollover occurs, see Rollovers.
    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.
    <authenticator>
    Configures an authentication resource for the current context.
    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.
    auto-compile
    As a child of jsp. Automatically compile changed JSP files
    backup
    As a child of server. If true, the server is generally used as a backup
    batch
    As a child of compiling-loader. If true, multiple changed *.java files will be compiled in a single batch. Resin 3.0.7
    ca-certificate-file
    As a child of openssl. a file containing a concatenated list of PEM-encoded certificates recognized for client authentication
    ca-revocation-file
    As a child of openssl. a file containing a concatenated list of PEM-encoded certificates which have been revoked and are no longer valid
    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.
    cache-mapping
    Specifies Expires times for cacheable pages.
    case-insensitive
    Specifies whether the environment context is case sensitive or insensitive.
    certificate-chain-file
    As a child of openssl. A file containing an intermediate (untrusted) and root (trusted) certificate. See Certificate Chains.
    certificate-file
    As a child of openssl. the file containing the server's certificate
    certificate-key-file
    As a child of openssl. the file containing the server's certificate key, if separate from certificate-file
    character-encoding
    Specifies the default character encoding for the environment.
    cipher-suite
    As a child of openssl.  
    <class-loader>
    Adds dynamic classloaders to the current environment.
    <cluster>
    Configures a cluster of Resin servers for load balancing and sharing state information.
    cluster-store
    As a child of session-config. Persistent sessions use the cluster for storage. (resin 3.0)
    cookie-version
    As a child of session-config. Version of the cookie spec for sessions. (resin 1.2)
    cookie-domain
    As a child of session-config. Domain for session cookies. (resin 1.2)
    cookie-max-age
    As a child of session-config. Max age for persistent session cookies. (resin 2.0)
    cookie-length
    As a child of session-config. Maximum length of the cookie. (resin 2.1.1)
    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
    connection-pool
    Configures the thread pool shared among all ports.
    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.
    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
    dir
    As a child of fileset. the starting directory
    dispatcher
    As a child of filter-mapping.
    display-name
    distributable
    disk-size
    As a child of cache. max size of the cache saved on disk
    ear-deploy
    Specifies ear expansion.
    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
    ejb-server
    Configures an EJB/CMP server.
    el-ignored
    As a child of jsp. Ignore EL expressions in JSP text
    enable
    As a child of cache. enables/disables the cache
    entries
    As a child of cache. max number of entries allowed in the cache
    env-entry
    Configures a JNDI scalar value for JNDI-based application configuration.
    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
    env-entry
    ejb-ref
    ejb-local-ref
    exclude
    As a child of fileset. an exclude pattern
    expand-path
    As a child of resource-deploy. Configures the directory where Resin will expand rar files
    expand-path
    As a child of host-deploy. path to the expansion directory
    expand-path
    As a child of web-app-deploy. directory where wars should be expanded
    expand-path
    As a child of ear-deploy. directory where ears should be expanded
    expires
    As a child of cache-mapping. A time interval.
    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)
    extension
    As a child of mime-mapping. url extension
    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 error-page. Select the error page based on an HTTP status code
    exception-type
    As a child of error-page. Select the error page based on a Java exception
    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
    fast-jstl
    As a child of jsp. Optimize JSTL JSP compilation
    fileset
    <fileset> provides the ability to match a set of files.
    fileset
    As a child of resin:import. a fileset
    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 javax.servlet.Filter
    filter-mapping
    Maps url patterns to filters.
    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
    filter-name
    As a child of filter. The filter's name (alias)
    foreign-name
    As a child of jndi-link. Sub-context of the foreign JNDI context. Since Resin 1.2
    format
    As a child of access-log. Access log format.
    form-login-config
    As a child of login-config. Configuration for form login, see form-login-config
    form-login-page
    As a child of form-login-config. The page to be used to prompt the user login
    form-error-page
    As a child of form-login-config. The error page for unsuccessful login
    form-login-config
    Configures authentication using forms.
    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.
    format
    As a child of log. a format string to control the output of each log message. Since Resin 3.0.5.
    formatter
    As a child of log. set a custom Formatter, the name of a class that extends java.util.logging.Formatter
    group-name
    Configures the Unix setuid group name used after Resin binds the reserved ports as root.
    handler
    As a child of log. add a custom Handler, the name of a class that extends java.util.logging.Handler
    host
    Configures a virtual host.
    host-alias
    As a child of host. Aliases matching the same host
    host-default
    Defaults for a virtual host.
    host-deploy
    Configures a deploy directory for virtual host.
    host-name
    As a child of host. Canonical host name
    host-default
    As a child of host-deploy. defaults for the expanded host&td> 
    host-name
    As a child of host-deploy. the host name to match
    http
    Configures a HTTP port listening for HTTP requests.
    http-method
    As a child of web-resource-collection. HTTP methods to be restricted.
    init
    As a child of login-config. Initialization for the custom login class
    internal-forward
    As a child of form-login-config. Use an internal redirect on success instead of a sendRedirect
    init
    As a child of access-log. bean-style initialization for the custom class
    init
    Configures Java Bean-style objects.
    id
    As a child of web-app. The url prefix selecting this application.
    id
    As a child of host. primary host name
    id
    As a child of cluster. identifies the cluster for later reference. Since Resin 3.0
    ignore-el-exception
    As a child of jsp. Ignore exceptions generated in EL expressions
    include
    As a child of fileset. an include pattern
    init
    As a child of constraint. initialization parameters, set in the object using Bean-style setters and getters
    init-param
    As a child of filter. Initialization parameters, see javax.servlet.FilterConfig
    init-param
    As a child of servlet. Initialization parameters
    ignore-serialization-errors
    As a child of session-config. When persisting a session, ignore any values which don't implement java.io.Serializable
    invalidate-after-listener
    As a child of session-config. (resin 3.0)
    init
    As a child of resource. Bean-style initialization for the bean
    init
    As a child of reference. Bean-style initialization for the factory
    init
    As a child of connector. Bean-style initialization
    init-param
    As a child of jndi-link. Configuration parameters for the JNDI environment passed to InitialContextFactory. Since Resin 1.2
    is-xml
    As a child of jsp. Default JSP pages to use XML syntax
    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)
    jsp-config
    j_security_check
    As a child of form-login-config. The form's mandatory action
    j_username
    As a child of form-login-config. The user name
    j_password
    As a child of form-login-config. The password
    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.
    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 authenticator. The JNDI name where the authenticator is stored. 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 reference. JNDI name for the reference. Since Resin 3.0
    jndi-name
    As a child of jndi-link. The JNDI name where the foreign context should be linked. Resin 3.0
    jsp
    Configures JSP behavior.
    jsse-ssl
    As a child of srun. configures the port to use JSSE for SSL
    jsse-ssl
    As a child of http. configures the port to use JSSE for SSL
    listener
    load-on-startup
    As a child of servlet. Initializes the servlet when the server starts.
    location
    As a child of error-page. The error page to display
    log
    Configure the amount and destination of debug logging for the JDK java.util.logging.* API.
    level
    As a child of log. The log level
    login-config
    HTTP Authentication is defined in the RFC HTTP Authentication: Basic and Digest .
    locale-encoding-mapping-list
    lazy-init
    As a child of web-app-deploy. true if web-apps should only be initialized when first used
    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
    local-transaction-optimization
    As a child of resource. Enables the local transaction optimization. Resin 3.0.7
    local-transaction-optimization
    As a child of connector. Enables the local transaction optimization. Resin 3.0.7
    log
    Configures JDK 1.4 java.util.logger logging.
    mbean-name
    As a child of resource. JMX name for management registration. Resin 3.0
    memory-size
    As a child of cache. max size of the cache saved in memory
    message-destination-ref
    message-destination
    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
    min-free-memory
    For reliability, Resin periodically checks the amount of free memory available.
    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
    name
    As a child of resin:set. name of the variable to set
    openssl
    Configures SSL.
    openssl
    As a child of http. configures the port to use OpenSSL
    openssl
    As a child of server. configures the port to use OpenSSL
    optional
    As a child of resin:import. if true, no error when file does not exist
    password
    As a child of openssl. the certificate key password
    path
    As a child of compiling-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 access-log. The access log path.
    path
    As a child of cache. filesystem location of the cache
    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 webapp-tagss directory
    path
    As a child of stdout-log. Output path for the stream, see "Log Paths".
    path
    As a child of stderr-log. Output path for the stream, see "Log Paths".
    path
    As a child of access-log. Output path for the log entries, see "Log Paths".
    path
    As a child of log. Output path for the log messages, see "Log Paths"
    path
    As a child of resin:import. a path to a file
    path
    As a child of library-loader. Filesystem path for the class loader. Since Resin 3.0
    path
    As a child of host-deploy. path to the deploy directory
    path
    As a child of tree-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-mapping
    Maps url patterns to real paths.
    persistent-path
    As a child of session-config. (resin 3.0)
    ping
    Starts a thread that periodically makes a request to the server, and restarts Resin if it fails.
    port
    As a child of http. port to listen to
    port
    As a child of srun. port to listen to
    precompile
    As a child of jsp. Try to load precompiled JSP pages
    prefix
    As a child of simple-loader. Class package prefix to only load to a subset of classes. Resin 3.0
    protocol
    As a child of openssl. a combination of +all, -all, +sslv2, -sslv2, +sslv3, -sslv3, +tlsv1, -tlsv1
    protocol
    As a child of server. configures the Srun protocol
    realm-name
    As a child of login-config. The realm name to use in HTTP authentication
    real-path
    As a child of path-mapping. The prefix of the real path. When used with url-regexp, allows substitution variables like $1.
    recompile-on-error
    As a child of jsp. Recompile the JSP file when an Error occurs in loading
    reference
    Configures a JNDI ObjectFactory.
    regexp
    As a child of host. Regular expression based host matching
    require-source
    As a child of compiling-loader. If true, .class files without matching .java files will be deleted. Since Resin 3.0
    require-source
    As a child of jsp. Return 404 when JSP source is deleted
    resin
    Top-level configuration for the resin.xml file.
    resin:choose
    resin:choose implements an if, elsif, else.
    resin:if
    resin:if executes part of the configuration file conditionally.
    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>.
    resin:log
    Logs a message to the given log file.
    resin:set
    resin:set adds an EL variable to the current context.
    resin:otherwise
    resin:type
    As a child of access-log. Class implementing AbstractAccessLog for custom logging.
    resin:type
    As a child of constraint. A class that extends com.caucho.http.security.AbstractConstraint
    resin:when
    As a child of resin:choose.
    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
    resource-ref
    Declares that the application needs a resouce configuration.
    retry-time
    As a child of ping. time between retries
    reuse-session-id
    As a child of session-config. Reuse the session id even if the session has timed out. (resin 2.0.4)
    root-directory
    Specifies the root directory for the <server> and <host> contexts.
    role-name
    As a child of auth-constraint. Roles which are allowed to access the resource.
    rollover-period
    As a child of access-log. how often to rollover the log. Normally in days (15D), weeks (2W) or months (1M).
    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). See Rollovers.
    rollover-size
    As a child of stdout-log. maximum size of the file before a rollover occurs, in bytes (50000), kb (128kb), or megabytes (10mb). See Rollovers.
    rollover-size
    As a child of access-log. max size of the log before a rollover.
    root-directory
    As a child of host. Root directory for host files
    run-at
    As a child of servlet. Times to execute the servlet automatically, A Resin extension.
    save-only-on-shutdown
    As a child of session-config. Only save session when the application shuts down. (resin 1.2.3)
    secure-host-name
    As a child of host. Host to use for a redirect to SSL
    security-constraint
    Specifies protected areas of the web site.
    security-manager
    Enable the use of the security manager for the JVM.
    security-provider
    Add one or more security providers.
    security-role
    server
    As a child of cluster. configures the server port and protocol for a cluster server. Since Resin 3.0
    servlet
    Defines a servlet alias for later mapping using .
    servlet-name
    As a child of servlet. The servlet's name (alias)
    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
    servlet-regexp
    Maps URL by regular expressions to custom servlets.
    servlet-class
    As a child of servlet. The servlet's class (In Resin, defaults to servlet-name)
    servlet-hack
    Use of servlet-hack is discouraged.
    servlet-mapping
    Maps url patterns to servlets.
    servlet-name
    As a child of servlet-mapping. The servlet name
    session
    As a child of jsp. Creates sessions for each JSP page
    session-cache
    As a child of openssl. true or false, enables the SSL session cache
    session-cache-timeout
    As a child of openssl. sets the SSL session cache timeout in seconds
    session-config
    Session configuration parameters.
    session-timeout
    As a child of session-config. The session timeout in minutes, 0 means never timeout.
    session-max
    As a child of session-config. Maximum active sessions
    shutdown-wait-max
    The maximum time Resin will wait for requests to finish before closing the web-app.
    simple-loader
    Configures a simple classes -style class loader.
    sleep-time
    As a child of ping. Time to wait between pings. The first ping is always 15m after the server starts, this is for subsequent pings.
    socket-listen-backlog
    As a child of srun. The socket factory's listen backlog for receiving sockets
    socket-timeout
    As a child of ping. time to wait for server to satrt responding to the tcp connection before giving up
    spare-thread-max
    As a child of connection-pool. maximum number of spare working threads
    spare-thread-min
    As a child of connection-pool. minimum number of spare working threads
    socket-listen-backlog
    As a child of http. The socket factory's listen backlog for receiving sockets
    source
    As a child of compiling-loader. Java source directory. Since Resin 3.0
    stderr-log
    Configures the destination for System.err .
    stdout-log
    Configures 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.
    type
    As a child of login-config. Defines a custom class which extends com.caucho.server.security.AbstractLogin
    timestamp
    As a child of stdout-log. a timestamp format string to use at the beginning of each log line.
    timestamp
    As a child of stderr-log. a timestamp format string to use at the beginning of each log line.
    timestamp
    As a child of log. a timestamp format string to use at the beginning of each log line.
    test
    As a child of resin:if. the test to perform
    test
    As a child of resin:when. the test to perform
    test
    As a child of resin:otherwise. the test to perform
    tcp-no-delay
    As a child of http. sets the NO_DELAY socket parameter
    tcp-no-delay
    As a child of srun. sets the NO_DELAY socket parameter
    temp-dir
    Application temp directory.
    thread-max
    As a child of connection-pool. maximum number of working threads
    timeout
    As a child of srun. time to wait for a request to reply
    transport-guarantee
    As a child of user-data-constraint. Required transport properties. NONE, INTEGRAL, and CONFIDENTIAL are allowed values.
    tree-loader
    Configures a jar library, WEB-INF/lib -style class loader similar to , but will also find .jar and .zip files in subdirectories.
    try-count
    As a child of ping. If a ping fails, number of times to retry before giving up and restarting
    type
    As a child of connector. For connectors with multiple connection-factories, specifies the connection-factory
    url-pattern
    As a child of web-resource-collection. url patterns describing the resource
    user-data-constraint
    Restricts access to secure transports, such as SSL
    upload-max
    As a child of multipart-form. maximum size of an upload request (in kb).
    url-regexp
    As a child of web-app. A regexp to select this application.
    url-pattern
    As a child of servlet-mapping. A pattern matching the url: /foo/*, /foo, or *.foo
    url-regexp
    As a child of servlet-mapping. A regular expression matching the url
    url-prefix
    As a child of web-app-deploy. url-prefix added to all expanded webapp-tagss
    url-pattern
    As a child of cache-mapping. A pattern matching the url: /foo/*, /foo, or *.foo
    url-regexp
    As a child of cache-mapping. A regular expression matching the url
    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-regexp
    As a child of path-mapping. A regular expression matching the url
    url-regexp
    As a child of filter-mapping. A regular expression matching the url
    user-name
    Configures the Unix setuid user name used after Resin binds the reserved ports as root.
    url
    As a child of ping. A url to ping.
    value
    As a child of resin:set. value
    velocity-enabled
    As a child of jsp. Enable Velocity statements
    verify-client
    As a child of openssl. 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 openssl. the maximum number of intermediate signers to accept when verifying client certificates
    virtual-host
    As a child of http. forces all requests to this <http> to use the named virtual host
    web-app
    web-app configures a web application.
    web-app-default
    Establishes the defaults for a .
    web-app-deploy
    Specifies war expansion.
    welcome-file-list
    Sets the files to use as when no filename is present in url.
    work-dir
    Application work directory.

    Copyright © 1998-2009 Caucho Technology, Inc. All rights reserved.
    Resin ® is a registered trademark, and Quercustm, Ambertm, and Hessiantm are trademarks of Caucho Technology.