http-config.xtp

解压在c盘

<s1 title="Servlet and Host Configuration">

<p>HTTP and Srun configuration is identical except for load balancing
(<var/srun/> and <var/srun-backup/>.)</p>

<p>HTTP configuration follows the Servlet 2.2 deployment descriptors.
The nesting depth is important, but order is generally not important.
In the sections that follow, the section
header tells where the attribute belongs.  For example, the
<var/servlet-mapping/> configuration in
<var/caucho.com/http-server/host/web-app/> looks like:</p>

<example>
&lt;caucho.com>
  &lt;http-server>
    &lt;host id=''>
      &lt;web-app id='/'>
        &lt;servlet-mapping url-pattern='/test' .../>
      &lt;/web-app>
    &lt;/host>
  &lt;/http-server>
&lt;/caucho.com>
</example>

<p>Most of the interesting configuration belongs in
<a href="app-config.xtp">web-app</a>.  For example, <var/servlet-mapping/>
belongs in a <var/web-app/> element, but
<var/thread-max/> belongs in the top-level <var/http-server/> element.</p>

<p>The server contains a number of <var/host/> elements and each
<var/host/> contains <var/web-app/> elements.  Each <var/host/>
configures a virtual host and each <var/web-app/> configures an
application.
</p>

<example title='Full Configuration'>
&lt;caucho.com>
&lt;http-server>
  &lt;host id='gryffindor.caucho.com' app-dir='gryffindor'>
    &lt;web-app id='/'>
      &lt;servlet-mapping .../>
      ...
    &lt;/web-app>
    
    &lt;web-app id='/test' app-dir='/usr/local/test'>
      ...
    &lt;/web-app>
  &lt;/host>
  
  &lt;host id='slytherin.caucho.com' app-dir='slytherin'>
    ...
  &lt;/host>

  ...
&lt;/http-server>
&lt;/caucho.com>
</example>

<objsummary/>

<s2 title='http-server'>

<defun name='http-server' title='http-server'>

<p>Configuration for the servlet engine.</p>

<p>Any &lt;resource-ref> resource configured in &lt;http-server> is
shared for all virtual hosts and web-apps in the server.  So a database
or EJB server configured in the &lt;http-server> will be shared
for all virtual hosts.</p>

<p>Default application tags like
&lt;servlet-mapping> may appear in the &lt;http-server> section.  These
tags will be defaults for the contained &lt;web-app> and &lt;host>.

</defun>

<defun title='alternate-session-url-prefix' version="Resin 2.0.5">
<p>Configures an alternate URL prefix to be used for /~J=xxx/test.jsp
style url-rewriting.  There is no default.</p>

<p>If alternate-session-url-prefix is configured, URL rewriting will
add the session to the beginning of the URL as a path prefix instead of the
standard ;jsessionid= suffix.  For clients like mobile devices with limited
memory, this will allow careful web designers to minimize the page size.
</p>

<example>
...
&lt;http-server>
  &lt;alternate-session-url-prefix>/~J=&lt;/alternate-session-url-prefix>
  ...
</example>

</defun>

<defun title='cache' version='Resin 1.1'>
<p>Activates the memory cache with a specified size.  Resin's
cache acts as a proxy cache.  Pages with <var/expires/> headers will
be cached, avoiding expensive Java or Database processing.</p>

<p>To activate caching, you must add a cache directive.  By default,
caching is disabled.</p>

<p>The cache combines memory and file caching.  The most referenced
pages are served out of memory and the rest are served from the
filesystem.</p>

<deftable>
<tr><th>Attribute<th>Meaning<th>Default
<tr><td>dir<td>File directory to store the cached pages<td>resin1.2/cache
<tr><td>entries<td>Number of entries allowed in the memory cache<td>16386
<tr><td>size<td>Size in kilobytes of the memory<td>1024
<tr><td>enable<td>true or false to disable<td>true
</deftable>

<p>For example, a page created by several sophisticated and slow
database queries may only change every 15 minutes.  If that page sets
its expires header, Resin can serve the generated page as fast as a
static page.</p>

<p><b>Default:</b> by default, cache is disabled.</p>

</defun>

<defun title='error-log'>
<p>Specifies the file for error logging.  The log is relative
to $RESIN_HOME.  You can use the special path <var/$app-dir/> to make
the log relative to the host, e.g. <var/$app-dir/WEB-INF/log/access.log/>.
</p>

<example>
&lt;caucho.com&gt;
&lt;http-server error-log='log/error.log'&gt;

&lt;host id='foo.com' error-log='log/foo.log'&gt;
 ...
&lt;/host&gt;

&lt;/http-server&gt;
&lt;/caucho.com&gt;
</example>

<deftable title="error-log attributes">
<tr><th>Attribute<th>Meaning<th>Default
<tr><td>encoding<td>character encoding<td>The JVM's default
<tr><td>href<td>The log's filename<td>required
<tr><td>rollover-period<td>How often the log should be rotated<td>never
<tr><td>rollover-size<td>How large the log can be before rotating<td>infinite
<tr><td>timestamp<td>Format for a timestamp before each entry<td>none
</deftable>

<p><b>Default:</b> By default, a host's error log will use an
error-log defined in http-server.</p>
</defun>

<defun name=error-page title='error-page' index='error-page'>
<p>The url to display if the web server can't connect to Resin.
This is a special case of <a href='app-config.xtp#error-page'>error-page</a>
in the web-app configuration.</p>

<p>The Apache and IIS plugins use this special error-page directive to
display a custom error page when the web server can't connect to Resin.
The location must be an absolute path understandable to the web server.
</p>

<example>
&lt;caucho.com&gt;
  &lt;http-server&gt;
    &lt;error-page exception-type='connection'
                location='/connection_error.html'/&lt;>
  &lt;/http-server&gt;
&lt;/caucho.com&gt;
</example>

</defun>

<defun title='forbid-host' version='Resin 2.0.3'>
<p>Selects a list of IPs that are forbidden.</p>

<example>
&lt;http-server>
  &lt;forbid-host>192.168.0.1&lt;/forbid-host>
  &lt;forbid-host>192.168.0.2&lt;/forbid-host>
  ...
&lt;/http-server>
</example>

<p>forbid-host is implemented by com.caucho.http.security.ForbidHost.  It is
stored in JNDI as java:comp/env/caucho/forbid-host.  An intelligent
log might detect a denial of service attack and dynamically forbid the host.
</p>
</defun>

<defun name=ignore title='ignore-client-disconnect' version='Resin 1.2.3'>
<p>Ignores ClientDisconnectionExceptions thrown when the browser
disconnects.</p>

<example>
&lt;caucho.com&gt;
  &lt;http-server&gt;
    &lt;ignore-client-disconnect>false&lt;/ignore-client-disconnect>

    ...
  &lt;/http-server&gt;
&lt;/caucho.com&gt;
</example>

<p>False by default, throws exceptions on disconnects.</p>
</defun>

<defun title='global-system-properties' version="Resin 2.0.5">
<p>Determines if system-properties are classloader specific or global.</p>

<p>By default, Resin's web-apps and hosts have isolated system properties.
So System.getProperty("test") in host foo.com might return a different value
from System.getProperty("test") in host bar.com.  Usually, this is the
correct solution to prevents hosts and web-apps from affecting each other.
Specialized applications may want to disable this feature however.</p>

<example>
...
&lt;http-server>
  &lt;global-system-properties>true&lt;/global-system-properties>
  ...
&lt;/http-server>
</example>

<p><b>Default:</b> The default value is false.</p>
</defun>

<defun title='host'>
<p>Defines a virtual host.  If no hosts are specified, or if a
request doesn't match a host, configuration in http-server will be
used instead.</p>

<p>The id may contain a list of hosts.  Any host in the list will
match.</p>

<p>See <a href='app-config.xtp'>application configuration</a> for
servlet configuration.</p>

<p>Hosts can use <var/regexp/> instead of <var/id/> to dynamically create
new hosts.</p>

<deftable>
<tr><th>Attribute<th>Meaning<th>Default
<tr><td>id<td>The host name<td>required
<tr><td>regexp<td>A regular expression matching hosts.<td>none
<tr><td>app-dir<td>The root directory of the host (can use replacement vars)
<td>use http-server app-dir
</deftable>

<p>Any &lt;resource-ref> resource configured in &lt;http-server> is
shared for all virtual hosts and web-apps in the server.  So a database
or EJB server configured in the &lt;http-server> will be shared
for all virtual hosts.</p>

<p>Default application tags like
&lt;servlet-mapping> may appear in the &lt;http-server> section.  These
tags will be defaults for the contained &lt;web-app> and &lt;host>.

<example>
&lt;caucho.com&gt;
&lt;http-server&gt;

&lt;host id='www.foobar.com, foobar.com'
      app-dir='foobar/docs'&gt;
  &lt;web-app id='/'>
    &lt;servlet-mapping url-pattern='/servlets/*'
                     servlet-name='invoker'/&gt; 
  &lt;/web-app>
&lt;/host&gt;

&lt;host regexp='([^.]*).users.com'
      app-dir='/home/$1/public_html'&gt;
  ...
&lt;/host&gt;


&lt;/http-server&gt;
&lt;/caucho.com&gt;
</example>

<note>Only the Resin Java process understands regexps.  Because mod_caucho,
isapi_srun and the other web server plugins don't understand the regexps,
you may need to do additional work to make the web server send the request
to Resin.</note>

<p><b>Default:</b> If the <var/id/> attribute is null or '*', the &lt;host>
will be used as the default configuration for any virtual host that doesn't
match a specific &lt;host> block.</p>

</defun>

<defun title='http' version="Resin 1.2">
<p>Defines a HTTP or SSL port for the standalone server.</p>

<deftable>
<tr><th>Attribute<th>Meaning
<tr><td>id<td>http identifier name
<tr><td>host<td>The listening host
<tr><td>port<td>The listening port
<tr><td>virtual-host<td>Virtual host to select a <a href="#host">host</a> block.
<tr><td>ssl<td>enable ssl
<tr><td>key-store-type<td>JSSE Type of the key store (default jks)
<tr><td>key-store-file<td>JSSE File containing the certificates
<tr><td>key-store-password<td>JSSE Password to read the certificates
<tr><td>key-manager-factory<td>JSSE key manager factory type
<tr><td>ssl-context<td>JSSE ssl context type
<tr><td>certificate-file<td>OpenSSL certificate (Resin 2.0.5)
<tr><td>certificate-key-file<td>OpenSSL key certificate (Resin 2.0.5)
<tr><td>certificate-key-password<td>OpenSSL key password (Resin 2.1.1)
<tr><td>crypto-device<td>OpenSSL engine (Resin 2.0.5)

<tr><td>thread-max<td>Maximum number of live threads.<td>200
<tr><td>thread-min<td>Minimum number of live threads.<td>5
<tr><td>thread-keepalive<td>Number of keepalive threads<td>100
<tr><td>request-timeout<td>Max time for a request, after this the request
will be interrupted.<td>30 sec
<tr><td>listen<td>Value of the socket listen parameter<td>5
<tr><td>accept-buffer-size<td>Number of sockets in the accept buffer.<td>256
<tr><td>shutdown-wait-time<td>How long to wait for connections to
finish before exiting.<td>10 sec.
</deftable>

<example title='Basic HTTP configuration'>
&lt;caucho.com&gt;
  &lt;http-server&gt;
    &lt;http port='8080'&gt;
    ...
  &lt;/http-server&gt;
&lt;/caucho.com&gt;
</example>

<example title='JSSE configuration'>
&lt;caucho.com&gt;
  &lt;http-server&gt;
    &lt;http port='8443'&gt;
      &lt;ssl>true&lt;/ssl>
      &lt;key-store-type>pkcs12&lt;/key-store-type>
      &lt;key-store-file>keys/server.p12&lt;/key-store-file>
      &lt;key-store-password>changeit&lt;/key-store-password>
    &lt;/http>
    ...
  &lt;/http-server&gt;
&lt;/caucho.com&gt;
</example>

</defun>

<defun name=ping title='ping' index='ping'>
<p>Specifies a list of URLs to test to check the webserver's uptime.
Ping adds reliability to a web site.  It launches a separate thread to
check if a list of URLs return valid results, i.e. HTTP status 200.  If the
URLs fail after repeated attempts, Resin will exit.  The parent process,
either wrapper.pl or the NT service, will automatically restart Resin.
</p>

<p>Because the ping thread is in the same JVM as the web server,
ping cannot detect all failure types.  In particular, if the JDK itself
freezes, ping can do nothing.  It can detect problems like deadlocks
or database connection overflows or memory leaks.
</p>

<p>The URLs listed in the &lt;ping> should exercise the important operations
in the application.  For example, it should at least access the database.
</p>

<deftable>
<tr><th>Attribute<th>Meaning<th>Default
<tr><td>url<td>URL to test for failure<td>required
<tr><td>sleep-time<td>time to sleep between pings.<td>15 min
<tr><td>retry-count<td>how many times to retry failures before restarting.<td>3
<tr><td>retry-time<td>how long to sleep between failures.<td>1 sec
<tr><td>class-name<td>specify a custom ping class (Resin 2.0.3)<td>com.caucho.http.admin.PingThread 
<tr><td>socket-timeout<td>how long the socket should wait for a response before timing out.<td>10s
</deftable>

<example>
&lt;caucho.com>
&lt;http-server>
  &lt;ping>
    &lt;sleep-time>1m&lt;/sleep-time>
    &lt;retry-count>3&lt;/retry-count>
    &lt;retry-time>1s&lt;/retry-time>
    &lt;url>http://localhost:8080/test.jsp&lt;/url>
  &lt;/ping>

  ...
&lt;/http-server>
&lt;/caucho.com>
</example>

<p>Custom ping classes must extend com.caucho.http.admin.PingThread.
For example, the PingMailer will mail when the PingThread fails.
</p>

<deftable title='PingMailer additional Attributes'>
<tr><td>Attribute<th>Meaning<th>Default
<tr><td>mail-to<td>Recipient of the warning mail<td>required
<tr><td>mail-from<td>Sender of the mail<td>the user of the Resin process
<tr><td>mail-subject<td>The subject of the mail<td>"Resin ping has failed"
</deftable>

<example>
&lt;ping>
  &lt;class-name>com.caucho.http.admin.PingMailer&lt;/class-name>
  &lt;sleep-time>1m&lt;/sleep-time>
  &lt;retry-count>3&lt;/retry-count>
  &lt;retry-time>1s&lt;/retry-time>
  &lt;url>http://localhost:8080/test.jsp&lt;/url>

  &lt;mail-to>webmaster@localhost&lt;/mail-to>
&lt;/ping>
</example>

<p>No default.</p>
</defun>