env-tags.xtp

RESIN 3.2 最新源码

information.</p>

<deftable title="jms-connection-factory URIs">
<tr>
  <th>Scheme</th>
  <th>Description</th>
</tr>
<tr>
  <td>resin:</td>
  <td>Resin's ConnectionFactory implementation</td>
</tr>
</deftable>

<deftable title="&lt;jms-connection-factory> Attributes">
<tr>
  <th>Attribute</th>
  <th>Description</th>
  <th>Default</th>
</tr>
<tr>
  <td>class</td>
  <td>class name of the ConnectionFactory implementation</td>
  <td>required (or <var>uri</var>)</td>
</tr>
<tr>
  <td>init</td>
  <td>IoC initialization configuration for the factory</td>
  <td></td>
</tr>
<tr>
  <td>jndi-name</td>
  <td>Name for registering in JNDI, relative to java:comp/env</td>
  <td></td>
</tr>
<tr>
  <td>name</td>
  <td><a href="resin-ioc.xtp#@Named">@Named</a> binding in Resin-IoC</td>
  <td></td>
</tr>
<tr>
  <td>uri</td>
  <td>URI alias for the ConnectionFactory class</td>
  <td></td>
</tr>
</deftable>

<def title="&lt;jms-connection-factory> schema">
element jms-connection-factory {
  (class | uri)
  &amp; init?
  &amp; jndi-name?
  &amp; name?
}
</def>

</defun>

<defun title="&lt;jms-queue>" occur="*" version="Resin 3.1.5">
<parents>resin, cluster, host, web-app</parents>

<p>&lt;jms-queue> configures a JMS <code>Queue</code>
and registers it with Resin-IoC/WebBeans.  Resin's JMS Queues implement
the <code>BlockingQueue</code> interface and can be used directly or
with the JMS <code>ConnectionFactory</code>.</p>

<p>See <a href="resin-messaging.xtp">Resin messaging</a> for more
information.</p>

<p>The Queue can either be identified by the implementing class name
or with a URI alias.   Third-party queues using JCA will use
the <a href="#resource-adapter">&lt;resource-adapter></a> and either
<a href="#connection-factory">&lt;connection-factory></a> or
<a href="#activation-spec">&lt;activation-spec></a>.</p>

<p>Code sending messages to a Queue will typically use either
the <code>BlockingQueue</code> API or JMS.  Code receiving from a queue
will generally use an <a href="#ejb-message-bean">EJB message bean</a>.</p>

<deftable title="&lt;jms-queue> Attributes">
<tr>
  <th>Attribute</th>
  <th>Description</th>
  <th>Default</th>
</tr>
<tr>
  <td>class</td>
  <td>class name of the Queue implementation</td>
  <td>required (or <var>uri</var>)</td>
</tr>
<tr>
  <td>init</td>
  <td>IoC initialization for the Queue</td>
  <td></td>
</tr>
<tr>
  <td>jndi-name</td>
  <td>JNDI name for storing the Queue</td>
  <td></td>
</tr>
<tr>
  <td>name</td>
  <td><a href="resin-ioc.xtp#@Named">@Named</a> binding for Resin-IoC</td>
  <td></td>
</tr>
</deftable>

<deftable title="Queue URI aliases">
<tr>
  <th>URI</th>
  <th>Description</th>
</tr>
<tr>
  <td>file:</td>
  <td>Persistent, file-backed Queue</td>
</tr>
<tr>
  <td>memory:</td>
  <td>Simple, memory-based Queue</td>
</tr>
<tr>
  <td>server:</td>
  <td>Server side of a clustered Queue</td>
</tr>
<tr>
  <td>client:</td>
  <td>Client side of a clustered Queue</td>
</tr>
</deftable>

<def title="&lt;jms-queue> schema">
element jms-queue {
  (class | uri)
  &amp; init
  &amp; jndi-name
  &amp; name
}
</def>

</defun>

<defun title="&lt;jms-topic>" occur="*" version="Resin 3.1.5">
<parents>resin, cluster, host, web-app</parents>

<p>&lt;jms-topic> configures a JMS <code>Topic</code>
and registers it with Resin-IoC/WebBeans.  Resin's JMS Topics implement
the <code>BlockingTopic</code> interface and can be used directly or
with the JMS <code>ConnectionFactory</code>.</p>

<p>See <a href="resin-messaging.xtp">Resin messaging</a> for more
information.</p>

<p>The Topic can either be identified by the implementing class name
or with a URI alias.   Third-party topics using JCA will use
the <a href="#resource-adapter">&lt;resource-adapter></a> and either
<a href="#connection-factory">&lt;connection-factory></a> or
<a href="#activation-spec">&lt;activation-spec></a>.</p>

<p>Code sending messages to a Topic will typically use either
the <code>BlockingTopic</code> API or JMS.  Code receiving from a topic
will generally use an <a href="#ejb-message-bean">EJB message bean</a>.</p>

<deftable title="&lt;jms-topic> Attributes">
<tr>
  <th>Attribute</th>
  <th>Description</th>
  <th>Default</th>
</tr>
<tr>
  <td>class</td>
  <td>class name of the Topic implementation</td>
  <td>required (or <var>uri</var>)</td>
</tr>
<tr>
  <td>init</td>
  <td>IoC initialization for the Topic</td>
  <td></td>
</tr>
<tr>
  <td>jndi-name</td>
  <td>JNDI name for storing the Topic</td>
  <td></td>
</tr>
<tr>
  <td>name</td>
  <td><a href="resin-ioc.xtp#@Named">@Named</a> binding for Resin-IoC</td>
  <td></td>
</tr>
</deftable>

<deftable title="Topic URI aliases">
<tr>
  <th>URI</th>
  <th>Description</th>
</tr>
<tr>
  <td>file:</td>
  <td>Persistent, file-backed Topic</td>
</tr>
<tr>
  <td>memory:</td>
  <td>Simple, memory-based Topic</td>
</tr>
<tr>
  <td>server:</td>
  <td>Server side of a clustered Topic</td>
</tr>
<tr>
  <td>client:</td>
  <td>Client side of a clustered Topic</td>
</tr>
</deftable>

<def title="&lt;jms-topic> schema">
element jms-topic {
  (class | uri)
  &amp; init
  &amp; jndi-name
  &amp; name
}
</def>

</defun>

<defun title="&lt;jndi-link>" occur="*" version="Resin 1.2">
<parents>resin, cluster, host, web-app</parents>
  <!-- com.caucho.naming.LinkProxy -->

<p>&lt;jndi-link> creates a symbolic link from one jndi name to another, or links to a foreign JNDI context.</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 title="&lt;jndi-link> Attributes">
<tr>
  <th>Attribute</th>
  <th>Description</th>
  <th>Default</th>
</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>The target name of the symbolic link, or the 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>
<tr><td>jndi-name</td>
    <td>The JNDI name to use for the link.  Resin 3.0</td>
    <td>required</td></tr>
</deftable>

<def title="&lt;jndi-link> schema">
element jndi-link {
  jndi-name
  &amp; factory?
  &amp; foreign-name?
  &amp; init-param*
}
</def>

<example title="Example: A JNDI symbolic link for a DataSource">
&lt;web-app xmlns="http://caucho.com/ns/resin"dd&gt;
  &lt;database jndi-name="jdbc/oracle"&gt;
    ...
  &lt;/database&gt;

  &lt;jndi-link jndi-name="java:comp/env/jdbc/gryffindor"&gt;
    &lt;foreign-name&gt;java:comp/env/jdbc/oracle&lt;/foreign-name&gt;
  &lt;/jndi-link&gt;

  &lt;jndi-link jndi-name="java:comp/env/jdbc/slytherin"&gt;
    &lt;foreign-name&gt;java:comp/env/jdbc/oracle&lt;/foreign-name&gt;
  &lt;/jndi-link&gt;
&lt;/web-app&gt;
</example>

<example title="Example: A JNDI foreign context for all EJB">
&lt;web-app xmlns="http://caucho.com/ns/resin"&gt;
  &lt;jndi-link jndi-name='java:comp/env/ejb'&gt;
    &lt;factory&gt;com.caucho.ejb.hessian.HessianContextFactory&lt;/factory&gt;
    &lt;init-param java.naming.provider.url='http://ejb.hogwarts.com:80/hessian'/&gt;
  &lt;/jndi-link&gt;
&lt;/web-app&gt;
</example>

<example title="Example: A JNDI foreign context for selected EJB">
&lt;web-app xmlns="http://caucho.com/ns/resin"&gt;
  &lt;jndi-link jndi-name='java:comp/env/remote-ejb'&gt;
    &lt;factory&gt;com.caucho.ejb.hessian.HessianContextFactory&lt;/factory&gt;
    &lt;init-param java.naming.provider.url='http://ejb.hogwarts.com:80/hessian'/&gt;
  &lt;/jndi-link&gt;

  &lt;jndi-link jndi-name="java:comp/env/ejb/Foo"&gt;
    &lt;foreign-name&gt;java:comp/env/remote-ejb/Foo&lt;/foreign-name&gt;
  &lt;/jndi-link&gt;

  &lt;jndi-link jndi-name="java:comp/env/ejb/Bar"&gt;
    &lt;foreign-name&gt;java:comp/env/local-ejb/Bar&lt;/foreign-name&gt;
  &lt;/jndi-link&gt;
&lt;/web-app&gt;
</example>

</defun>

<defun title="&lt;jpa-persistence>" occur="*" version="Resin 3.1">
<parents>resin, cluster, host, web-app</parents>

<p>&lt;jpa-persistence> configures JPA persistence defaults.
More details on JPA are available on the <a href="amber.xtp">Amber</a> page.</p>

<deftable title="&lt;jpa-persistence> Attributes">
<tr>
  <th>Attribute</th>
  <th>Description</th>
  <th>Default</th>
</tr>
<tr>
  <td>create-database-schema</td>
  <td>If true, Amber will automatically create the database schema</td>
  <td>false</td>
</tr>
<tr>
  <td>cache-size</td>
  <td>Size of the entity cache</td>
  <td>32k</td>
</tr>
<tr>
  <td>data-source</td>
  <td>database used for JTA</td>
  <td></td>
</tr>
<tr>
  <td>jdbc-isolation</td>
  <td>JDBC isolation level used for connections</td>
  <td></td>
</tr>
<tr>
  <td>read-data-source</td>
  <td>Data source to be used for read-only queries</td>
  <td>data-source</td>
</tr>
<tr>
  <td>validate-database-schema</td>
  <td>enables validation of the database tables on startup</td>
  <td>false</td>
</tr>
<tr>
  <td>xa-data-source</td>
  <td>database to use in transactions</td>
  <td>data-source</td>
</tr>
</deftable>

<def title="&lt;jpa-persistence> schema">
element jpa-persistence {
  create-database-schema?
  &amp; cache-size?
  &amp; cache-timeout?
  &amp; data-source?
  &amp; jdbc-isolation?
  &amp; persistence-unit*
  &amp; persistence-unit-default*
  &amp; read-data-source?
  &amp; validate-database-schema?
  &amp; xa-data-source?
}

element persistence-unit {
  name
  &amp; jta-data-source?
  &amp; non-jta-data-source?
  &amp; provider?
  &amp; transaction-type?
  &amp; properties?
}

element persistence-unit-default {
  &amp; jta-data-source?
  &amp; non-jta-data-source?
  &amp; provider?
  &amp; transaction-type?
  &amp; properties?
}

element properties {
  element property {
     name
     &amp; value
  }*
}
</def>

</defun>

<defun title="&lt;library-loader>" occur="*" version="Resin 3.0">
  <parents>class-loader</parents>

<p>&lt;library-loader> configures a jar
library, <var>WEB-INF/lib</var>-style class loader.</p>

<p>The library-loader will add jar files in its path to the current classpath.
Jar files are recognized wihen they have a filename extension of
<code>.jar</code> or <code>.zip</code>.</p>

<deftable>
<tr>
  <th>Attribute</th>
  <th>Description</th>
  <th>Default</th>
</tr>
<tr>
  <td>fileset</td>
  <td>An ant-style fileset</td>
  <td></td>
</tr>
<tr>
  <td>path</td>
  <td>Filesystem path for the class loader.  Since Resin 3.0</td>
  <td>required</td>
</tr>
</deftable>

<def title="&lt;library-loader> schema">
element library-loader {
  fileset
  | path
}

element fileset {
  dir
  &amp; exclude*
  &amp; include*
}
</def>

<p>See <a href="http://caucho.com/resin-javadoc/javadoc/com/caucho/loader/LibraryLoader.html">DirectoryLoader</a>.</p>

</defun>

<defun title="&lt;log>" occur="*" type="defun">
<parents>resin, cluster, host, web-app</parents>

<p>&lt;log> configures JDK 1.4 java.util.logger handler.</p>

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

<deftable title="&lt;log> Attributes">
<tr>
  <th>Attribute</th>
  <th>Description</th>
  <th>Default</th>
</tr>
<tr>
  <td>archive-format</td>
  <td>defines a format string for log rollover</td>
  <td></td>
</tr>
<tr>
  <td>format</td>
  <td>defines the output formatting</td>
  <td></td>
</tr>
<tr>
  <td>formatter</td>
  <td>defines a custom formatter</td>
  <td></td>
</tr>
<tr>
  <td>handler</td>
  <td>defines a custom handler</td>
  <td></td>
</tr>
<tr>
  <td>level</td>
  <td>sets the logging level of the handler</td>
  <td>info</td>
</tr>
<tr>
  <td>mbean-name</td>
  <td>sets an mbean-name to register the logger for runtime management</td>
  <td></td>
</tr>
<tr>
  <td>path</td>
  <td>sets the VFS path for the log file</td>
  <td></td>
</tr>
<tr>
  <td>path-format</td>
  <td>sets a pattern for creating the VFS path for the messages</td>
  <td></td>
</tr>
<tr>
  <td>rollover-count</td>
  <td>sets the maximum number of rollover files</td>
  <td></td>
</tr>
<tr>
  <td>rollover-period</td>
  <td>sets the number of days before a log file rollover </td>
  <td>1m</td>
</tr>
<tr>
  <td>rollover-size</td>
  <td>sets the maximum log size before a rollover</td>
  <td>1g</td>
</tr>
<tr>
  <td>timestamp</td>
  <td>sets the formatting string for the timestamp label</td>
  <td></td>
</tr>
<tr>
  <td>use-parent-handlers</td>
  <td>if true, the log is also copied to parent handlers</td>
  <td>true</td>
</tr>
</deftable>