config-env.xtp

RESIN 3.2 最新源码

  
<s2 title="jndi-link" occur="*" version="Resin 1.2" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>
  <!-- com.caucho.naming.LinkProxy -->

<p>Links a foreign JNDI contexts or JNDI object.</p>

<p>Resin's JNDI can link to foreign JNDI contexts.  For example, third-party
EJB servers will often expose their EJB beans through a JNDI context.
jndi-link will create the appropriate InitialContextFactory, configure it,
and lookup the foreign JNDI objects.</p>

<deftable-childtags>
<tr><td>jndi-name</td><td>The JNDI name where the foreign context should be linked.  Resin 3.0</td><td>required
</td></tr><tr><td>factory</td><td>Class name of the JNDI InitialContextFactory.  Since Resin 1.2</td><td>optional
</td></tr><tr><td>foreign-name</td><td>Sub-context of the foreign JNDI context.  Since Resin 1.2</td><td>none
</td></tr><tr><td>init-param</td><td>Configuration parameters for the JNDI environment passed to InitialContextFactory.  Since Resin 1.2</td><td>none
</td></tr></deftable-childtags>

<example title="Linking a WebLogic EJB client bean">
&lt;jndi-link&gt;
  &lt;jndi-name&gt;java:comp/env/ejb/traderHome&lt;/jndi-name&gt;
  &lt;factory&gt;weblogic.jndi.WLInitialContextFactory&lt;/factory&gt;
  &lt;init-param java.naming.provider.url="t3://localhost:7001"/&gt;
  &lt;foreign-name&gt;statelessSession/TraderHome&lt;/foreign-name&gt;
&lt;/jndi-link&gt;
</example>

<example title="A JNDI symbolic link EJB client bean">
&lt;jndi-link&gt;
  &lt;jndi-name&gt;java:comp/env/ejb/MyBean&lt;/jndi-name&gt;
  &lt;foreign-name&gt;/SampleBean&lt;/foreign-name&gt;
&lt;/jndi-link&gt;
</example>

</s2>

<s2 title="reference" occur="*" version="Resin 3.0" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>
  <!-- com.caucho.config.types.ReferenceConfig -->

<p>Configures a JNDI ObjectFactory.</p>

<p>JNDI ObjectFactories are used to create objects from JNDI references.
The &lt;reference&gt; tag configures the ObjectFactory and stores it in JNDI.</p>

<deftable-childtags>
<tr><td>jndi-name</td><td>JNDI name for the reference.  Since Resin 3.0</td><td>required
</td></tr><tr><td>factory</td><td>Class name of the ObjectFactory. Resin 3.0</td><td>required
</td></tr><tr><td>init</td><td>Bean-style initialization for the factory</td><td>none
</td></tr></deftable-childtags>

<example>
&lt;reference&gt;
  &lt;jndi-name&gt;hessian/hello&lt;/jndi-name&gt;
  &lt;factory&gt;com.caucho.hessian.client.HessianProxyFactory&lt;/factory&gt;
  &lt;init url="http://localhost:8080/ejb/hello"/&gt;
        type="test.HelloHome"/&gt;
&lt;/reference&gt;
</example>

</s2>

<s2 title="resource" occur="*" version="Resin 3.0" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>
  <!-- com.caucho.config.types.Resource -->

<p>Configures a custom bean resource and stores in JNDI.</p>

<p>Resources are beans stored in JNDI.  The resources can be
created from any Java class that conforms to the bean conventions.
Configuration of the resource is in the &lt;init&gt; section.  Field values may
use JSP-EL expressions as well as constant strings or even complex
sub-beans.</p>

<deftable-childtags>
<tr><td>jndi-name</td><td>JNDI name for the resource.  Since Resin 3.0</td><td>required
</td></tr><tr><td>type</td><td>Bean class implementing the resource. Since Resin 3.0</td><td>required
</td></tr><tr><td>arg</td><td>Arguments to the resource's constructor.  Since Resin 3.0</td><td>optional
</td></tr><tr><td>mbean-name</td><td>JMX name for management registration. Resin 3.0</td><td>optional
</td></tr><tr><td>init</td><td>Bean-style initialization for the bean</td><td>optional
</td></tr><tr><td>listener</td><td>Registers the bean as a listener for a JMX emitter. Resin 3.0</td><td>optional
</td></tr><tr><td>local-transaction-optimization</td><td>Enables the local transaction optimization. Resin 3.0.7</td><td>true
</td></tr></deftable-childtags>

<example>
&lt;resource jndi-name="env/test"&gt;
  &lt;type&gt;test.MyBean&lt;/type&gt;
  &lt;init&gt;
    &lt;greeting&gt;Hello&lt;/greeting&gt;
    &lt;server&gt;${'${'}serverId}&lt;/server&gt;
    &lt;sub-bean&gt;
      &lt;value&gt;${'${2'} + 2}&lt;/value&gt;
    &lt;/sub-bean&gt;
  &lt;/init&gt;
&lt;/resource&gt;
</example>

<def title="schema">
r_listener-Resource = element listener {
  r_mbean-name,

  r_handback*
}

r_resource = element resource {
  (r_jndi-name?

  &amp; r_mbean-name?

  &amp; r_mbean-interface?),

  (r_type,

  r_arg*)?,

  (r_init*

  &amp; r_listener-Resource*)
}
</def>

</s2> 

<s2 title="resource-deploy" occur="*" version="Resin 3.0" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>
  <!-- com.caucho.jca.ResourceDeploy -->

<p>Defines a deployment directory for .rar files.</p>

<p>Connectors and resources defined in .rar files must be deployed
before they can be configured by <a href="#connector">connector</a>.
The &lt;resource-deploy&gt; tag specifies the directory for that deployment.
</p>

<example title="example resource-deploy">
&lt;host&gt;
  &lt;resource-deploy path="deploy"/&gt;

  ...
&lt;/host&gt;
</example>

<deftable-childtags>
<tr><td>resource-deploy</td><td>Configures .rar deployment</td><td>required
</td></tr><tr><td>path</td><td>Configures the path where users will place .rar files</td><td>required
</td></tr><tr><td>expand-path</td><td>Configures the directory where Resin will expand rar files</td><td>the path value
</td></tr></deftable-childtags>

<def title="schema">
element resource-deploy {
  (attribute path { string } | element path { string })

  &amp; (attribute expand-path { string } | 
         element expand-path { string })?
}
</def>

</s2>

<s2 title="resource-ref" occur="*" version="Servlet 2.2" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>
  <!-- com.caucho.config.types.ResourceRef -->

<p>Declares that the application needs a resouce configuration.</p>

<p>resource-ref is not directly used by Resin.  It's a servlet configuration
item intended to tell GUI tools which resources need configuration.
Resource configuration in Resin uses the resource, reference,
database, and ejb-server tags.</p>

<p>For backwards compatibility, Resin 2.1-style configuration files
may still use resource-ref to configure resources, but it's recommended to
convert the configuration.</p>

</s2>
</s1>

<s1 title="Logging">
<s2 title="log" occur="*" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>

<p>Configures JDK 1.4 java.util.logger logging.</p>

<p>The <a href="config-log.xtp">log configuration</a> describes
log in detail.</p>

</s2>

<s2 title="stderr-log" occur="?" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>

<p>Configures the destination for <code>System.err</code>.</p>

<p>The <a href="config-log.xtp">log configuration</a> describes
stderr-log in detail.</p>

</s2>

<s2 title="stdout-log" occur="?" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>

<p>Configures the destination for <code>System.out</code>.</p>

<p>The <a href="config-log.xtp">log configuration</a> describes
stderr-log in detail.</p>
</s2>
</s1>

<s1 title="Authenticator">
<s2 title="authenticator" occur="*" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app, login-config</parents>
  <!-- com.caucho.config.types.Authenticator -->

<p>Configures an authentication resource for the current context.</p>

<p>Resin's servlet authentication uses an authentication resource to
validate user login and to provide single-signon capability.
The authenticator is configured in the environment context
where it is shared.  So an authenticator configured in the web-app
only applies to the web-app, but an authenticator configured in
the host will apply to all hosts.</p>

<p>The authenticator class is selected with the <var>type</var> attribute.  It
can be any custom class
extending <code>com.caucho.server.security.AbstractAuthenticator</code>.
Configuration of the authenticator uses bean-style configuration in the
&lt;init&gt; tag.</p>

<deftable-childtags>
<tr><td>jndi-name</td><td>The JNDI name where the authenticator is stored.  Since Resin 3.0</td><td>java:comp/env/caucho/auth
</td></tr><tr><td>type</td><td>The implementing class for the authenticator.  Since Resin 3.0</td><td>required
</td></tr><tr><td>init</td><td>A bean-style configuration section.  Since Resin 3.0</td><td>none
</td></tr></deftable-childtags>

</s2>
</s1>

<s1 title="Miscellaneous">
<s2 title="system-property" occur="*" version="Resin 2.0" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>

<p>Sets a Java system property.  The effect is the same as if you
had called <a href="javadoc|java.lang.System|setProperty(String,String)"/> before starting Resin.</p>

<example>
&lt;resin&gt;
  &lt;system-property foo="bar"/&gt;
&lt;/resin&gt;
</example>
</s2>

<s2 title="javac" occur="?" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>
  <!-- com.caucho.java.JavacConfig -->

<p>Configures the Java compiler for automatically compiled files.</p>

<p>The javac configuration is used for JSP, XSL, EJB and
compiling-loader configuration.</p>

<deftable-childtags>
<tr><td>compiler</td><td>Configures the Java compiler to use.  Since Resin 3.0</td><td>internal
</td></tr><tr><td>args</td><td>Any additional arguments for the compiler.  Since Resin 3.0</td><td>none
</td></tr><tr><td>encoding</td><td>Any encoding valued for the compiler.  Since Resin 3.0</td><td>none
</td></tr></deftable-childtags>

</s2>

<s2 title="dependency" occur="?" version="Resin 3.0.1" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>

<p>Configures a path as a file which should force a reload when changed,
like web.xml and resin.xml.</p>

<deftable-childtags>
<tr><td>path</td><td>Filesystem path to the dependent file.  Since Resin 3.0</td><td>required
</td></tr></deftable-childtags>

<example title="web.xml">
&lt;web-app xmlns="http://caucho.com/ns/resin"&gt;
  &lt;dependency path="WEB-INF/struts-config.xml"/&gt;
  ...
&lt;/web-app&gt;
</example>

</s2>

<s2 title="dependency-check-interval" occur="?" version="Resin 3.0" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>
<default>2s</default>

<p>Configures how often the environment context
should be checked for changes.</p>

<p>Resin automatically checks each environment for updates, generally
class or configuration updates.  Because these checks can take a considerable
amount of time, deployment servers should use high values like 60s or more while development machines will want low values like 2s.</p>

<p>The interval defaults to the parent's interval.  So the web-app will
default to the host's value.</p>
</s2>

<s2 title="character-encoding" occur="?" version="Resin 1.1" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>
<default>The default value is ISO-8859-1.</default>

<p>Specifies the default character encoding for the environment.</p>


<example>
&lt;web-app id='/'&gt;
  &lt;character-encoding&gt;shift_jis&lt;/character-encoding&gt;
  ...

&lt;/web-app&gt;
</example>
</s2>

<s2 title="case-insensitive" occur="?" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>
<default>true on Windows, false on Unix.</default>

<p>Specifies whether the environment context is case sensitive or insensitive.</p>

<p>Because some operating systems are case-insensitive, it is important
for security reasons for Resin to behave differently for case-sensitive
and case-insensitive directories.  For example, when case-insensitive
is true, url-patterns will match in a case-insensitive manner, so TEST.JSP
will work like test.jsp.</p>

</s2>
<s2 title="temp-dir" occur="?" version="Resin 1.1" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>
<default>Defaults to <var>WEB-INF/tmp</var></default>

<p>Application temp directory.  This is the path used in
<var>javax.servlet.context.tempdir</var>.</p>
</s2>

<s2 title="work-dir" occur="?" version="Resin 2.0.0" type="defun">
<parents>resin, server, host-default, host, web-app-default, web-app</parents>
<default>Defaults to <var>WEB-INF/work</var></default>

<p>Application work directory.  This is the directory used for
generated code like JSP, XSL and EJB classes.</p>
</s2>
</s1>

</body>
</document>