You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tapestry.apache.org by bu...@apache.org on 2015/07/27 00:19:48 UTC
svn commit: r959689 [1/4] - in /websites/production/tapestry/content: ./
cache/
Author: buildbot
Date: Sun Jul 26 22:19:48 2015
New Revision: 959689
Log:
Production update by buildbot for tapestry
Modified:
websites/production/tapestry/content/cache/main.pageCache
websites/production/tapestry/content/chainbuilder-service.html
websites/production/tapestry/content/hibernate-core-conf.html
websites/production/tapestry/content/hibernate-core.html
websites/production/tapestry/content/hibernate.html
websites/production/tapestry/content/injection-in-detail.html
websites/production/tapestry/content/integrating-with-spring-framework.html
websites/production/tapestry/content/logging-in-tapestry.html
websites/production/tapestry/content/object-providers.html
websites/production/tapestry/content/operation-tracker.html
websites/production/tapestry/content/parallel-execution.html
websites/production/tapestry/content/pipelinebuilder-service.html
websites/production/tapestry/content/registry-startup.html
websites/production/tapestry/content/service-implementation-reloading.html
websites/production/tapestry/content/service-serialization.html
websites/production/tapestry/content/shadowbuilder-service.html
websites/production/tapestry/content/starting-the-ioc-registry.html
websites/production/tapestry/content/strategybuilder-service.html
websites/production/tapestry/content/symbols.html
websites/production/tapestry/content/type-coercion.html
websites/production/tapestry/content/using-jsr-330-standard-annotations.html
Modified: websites/production/tapestry/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/tapestry/content/chainbuilder-service.html
==============================================================================
--- websites/production/tapestry/content/chainbuilder-service.html (original)
+++ websites/production/tapestry/content/chainbuilder-service.html Sun Jul 26 22:19:48 2015
@@ -62,64 +62,81 @@
<div class="clearer"></div>
<div id="breadcrumbs">
- <a href="index.html">Apache Tapestry</a> > <a href="documentation.html">Documentation</a> > <a href="user-guide.html">User Guide</a> > <a href="ioc.html">IoC</a> > <a href="chainbuilder-service.html">ChainBuilder Service</a>
+ <a href="index.html">Apache Tapestry</a> > <a href="documentation.html">Documentation</a> > <a href="user-guide.html">User Guide</a> > <a href="ioc.html">IOC</a> > <a href="chainbuilder-service.html">ChainBuilder Service</a>
<a class="edit" title="Edit this page (requires approval -- just ask on the mailing list)" href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=23338479">edit</a>
</div>
<div id="content">
-<div id="ConfluenceContent">
+<div id="ConfluenceContent"><p>The <strong>ChainBuilder Service</strong> is a built-in service used to implement of one of the most useful of the <em>Gang Of Four</em> design patterns, the <a shape="rect" class="external-link" href="https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern" >chain of responsibility</a>.</p><div class="aui-label" style="float:right" title="Related Articles">
-<h1 id="ChainBuilderService-ChainofCommand">Chain of Command</h1>
-<div class="navmenu" style="float:right; background:#eee; margin:3px; padding:3px">
-<div class="error"><span class="error">Error formatting macro: contentbylabel: com.atlassian.confluence.api.service.exceptions.BadRequestException: Could not parse cql : null</span> </div></div>
-<p>One of the most useful of the Gang Of Four Design Patterns is the <strong>command</strong> pattern.</p>
-<p>With the command pattern, a complex process is broken down into many individual steps. The steps are the <em>commands</em> in the command pattern. A key part of this is that the commands are expected to implement some common interface. The commands are carefully arranged into a specific order.</p>
-<p>The process operates by working down the list of commands. Each command is given a chance to operate. A command can terminate the process either by throwing an exception, or by returning true.</p>
-<p>The return type of the command method does not have to be boolean: For object types, any non-null value short-circuits the process. For numeric type, any non-zero value. For void methods, only throwing an exception will short circuit the process.</p>
-<p>Often, the command interface consists of a single method. When the command interface has multiple methods, each can be thought of as its own chain.</p>
-<p>This is a useful pattern because it makes it very easy to <em>extend</em> a given process, simply by providing new commands and specifying where they fit into the overall process. Most often chain of command is combined with an ordered <a shape="rect" href="tapestry-ioc-configuration.html">configuration</a> to define what the list of commands are (and in what order they should execute).</p>
-
-<h1 id="ChainBuilderService-ChainBuilderService">ChainBuilder Service</h1>
-
-<p>Because this pattern is used so often inside Tapestry, a built-in service exists to create implementations of the pattern as needed. The <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/services/ChainBuilder.html">ChainBuilder</a> service takes care of all the work:</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
-public interface ChainBuilder
+<h3>Related Articles</h3>
+
+<ul class="content-by-label"><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="chainbuilder-service.html">ChainBuilder Service</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="shadowbuilder-service.html">ShadowBuilder Service</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="ioc-cookbook-patterns.html">IoC Cookbook - Patterns</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="strategybuilder-service.html">StrategyBuilder Service</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="pipelinebuilder-service.html">PipelineBuilder Service</a>
+
+
+ </div>
+ </li></ul>
+</div><p>With the chain of responsibility design pattern, a complex process is broken down into many individual steps. Each step is a <em>command</em> (see <a shape="rect" class="external-link" href="https://en.wikipedia.org/wiki/Command_pattern" >command pattern</a>). A key part of this is that the commands are expected to implement some common interface. The commands are also carefully arranged into a specific order.</p><p>The process operates by working down the list of commands, and each command is given a chance to operate. In the ChainBuilder service, a command can terminate the process either by throwing an exception, or by returning true.</p><p>The return type of the command method does not have to be boolean: For object types, any non-null value short-circuits the process. For numeric type, any non-zero value. For void methods, only throwing an exception will short circuit the process.</p><p>Often, the command interface consists of a single method. When the command interfac
e has multiple methods, each can be thought of as its own chain.</p><p>This is a useful pattern because it makes it very easy to <em>extend</em> a given process, simply by providing new commands and specifying where they fit into the overall process. Most often chain of command is combined with an ordered <a shape="rect" href="tapestry-ioc-configuration.html">configuration</a> to define what the list of commands are (and in what order they should execute).</p><h1 id="ChainBuilderService-ChainBuilderService">ChainBuilder Service</h1><p>Because this pattern is used so often inside Tapestry, a built-in service exists to create implementations of the pattern as needed. The <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/services/ChainBuilder.html">ChainBuilder</a> service takes care of all the work:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public interface ChainBuilder
{
<T> T build(Class<T> commandInterface, List<T> commands);
}</pre>
-</div></div>
-
-<p>All that generics parameterization just ensures that the command interface matches the items in the list, and confirms that a single instance of the command interface will be returned.</p>
-
-<p>Invoking this method returns an object that encapsulates the chain of command for a particular interface and a particular list of commands implementing that interface.</p>
-
-<p>This can be used inside a service builder method. Nothing says a service builder method just has to instantiate a class; it is only required to return an appropriate object. We can just let the ChainBuilder service create that object.</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
- public static MyChainService build(List<MyChainService> commands,
+</div></div><p>All that generics parameterization just ensures that the command interface matches the items in the list, and confirms that a single instance of the command interface will be returned.</p><p>Invoking this method returns an object that encapsulates the chain of command for a particular interface and a particular list of commands implementing that interface.</p><p>This can be used inside a service builder method. Nothing says a service builder method just has to instantiate a class; it is only required to return an appropriate object. We can just let the ChainBuilder service create that object.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"> public static MyChainService build(List<MyChainService> commands,
@InjectService("ChainBuilder")
ChainBuilder chainBuilder)
{
return chainBuilder.build(MyChainService.class, commands);
}</pre>
-</div></div>
-
-<p>Here, the behavior of the MyChainService is defined by its configuration: an ordered list of MyChainService commands that are contributed by one or more modules.</p>
-
-<p>Internally, the ChainBuilder creates a new class that implements the service interface. The list of commands is converted into an array, which is used inside the service implementation (for maximum efficiency). Therefore, changing the list after creating the chain instance will not affect the chain instance's behavior.</p>
-
-<p>ChainBuilder will reuse the fabricated class for any number of chains of the same command interface.</p>
-</div>
+</div></div><p>Here, the behavior of the MyChainService is defined by its configuration: an ordered list of MyChainService commands that are contributed by one or more modules.</p><p>Internally, the ChainBuilder creates a new class that implements the service interface. The list of commands is converted into an array, which is used inside the service implementation (for maximum efficiency). Therefore, changing the list after creating the chain instance will not affect the chain instance's behavior.</p><p>ChainBuilder will reuse the fabricated class for any number of chains of the same command interface.</p></div>
</div>
<div class="clearer"></div>
Modified: websites/production/tapestry/content/hibernate-core-conf.html
==============================================================================
--- websites/production/tapestry/content/hibernate-core-conf.html (original)
+++ websites/production/tapestry/content/hibernate-core-conf.html Sun Jul 26 22:19:48 2015
@@ -31,8 +31,6 @@
<link href='/resources/highlighter/styles/shThemeCXF.css' rel='stylesheet' type='text/css' />
<script src='/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
<script src='/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
- <script src='/resources/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
- <script src='/resources/highlighter/scripts/shBrushPlain.js' type='text/javascript'></script>
<script type="text/javascript">
SyntaxHighlighter.defaults['toolbar'] = false;
SyntaxHighlighter.all();
@@ -67,58 +65,92 @@
</div>
<div id="content">
-<div id="ConfluenceContent"><div class="navmenu" style="float:right; background:#eee; margin:3px; padding:3px">
-<div class="error"><span class="error">Error formatting macro: contentbylabel: com.atlassian.confluence.api.service.exceptions.BadRequestException: Could not parse cql : null</span> </div></div>
+<div id="ConfluenceContent"><p><strong>Hibernate Configuration</strong> is handled by the Tapestry Hibernate Core module. This is done in a just-in-time manner, the first time a Hibernate Session is required.</p><div class="aui-label" style="float:right" title="Related Articles">
-<h1 id="Hibernate-Core-Conf-ConfiguringHibernate">Configuring Hibernate</h1>
-<p>The Tapestry Hibernate Library is responsible for configuring Hibernate for you. This is done in a just-in-time manner, the first time a Hibernate Session is required.</p>
-<h2 id="Hibernate-Core-Conf-HibernateSessionSourceConfiguration">HibernateSessionSource Configuration</h2>
-<p>One way to configure hibernate is to create a <code>hibernate.cfg.xml</code> file and place it in the root of your application (i.e., under src/main/resources). Most Hibernate-specific configuration occurs in this file. Another way is to contribute objects that perform configuration (such as setting event listeners). Example:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
-public static void contributeHibernateSessionSource(OrderedConfiguration<HibernateConfigurer> config)
-{
- config.add("Widget", new WidgetHibernateConfigurer());
-}</pre>
-</div></div>
-
-<p>Note that the configuration is an OrderedConfiguration. The library contributes two configurers by default:</p>
-
-<ul><li><strong>Default</strong> - performs default hibernate configuration</li><li><strong>PackageName</strong> - loads entities by package name as contributed to the HibernateEntityPackageManager service</li></ul>
-
-
-<h2 id="Hibernate-Core-Conf-HibernateEntityPackageManagerConfiguration">HibernateEntityPackageManager Configuration</h2>
-
-<p>This configuration is a set of package names, identifying where to search for entity classes.</p>
-
-<p>For each package contributed, the library will:</p>
-<ul><li><a shape="rect" class="external-link" href="http://docs.jboss.org/hibernate/stable/core/api/org/hibernate/cfg/AnnotationConfiguration.html#addPackage(java.lang.String)" >Add the package to the configuration</a>, which will load annotations from the package-info class within the named package, if present.</li><li>Every Java class in the package (or any subpackage) will be <a shape="rect" class="external-link" href="http://docs.jboss.org/hibernate/stable/core/api/org/hibernate/cfg/AnnotationConfiguration.html#addAnnotatedClass(java.lang.Class)" >added as an annotated class</a>. This excludes inner classes, but includes all other classes.</li></ul>
-<p>By default, the package <em>application-root-package.entities</em> is scanned as described above. If you have additional packages containing entities, you must <a shape="rect" href="configuration.html">contribute</a> them to the tapestry.hibernate.HibernateEntityPackageManager service configuration.</p>
-
-<p>Example:</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
-public static void contributeHibernateEntityPackageManager(Configuration<String> configuration)
+<h3>Related Articles</h3>
+
+<ul class="content-by-label"><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="using-tapestry-with-hibernate.html">Using Tapestry With Hibernate</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-support-faq.html">Hibernate Support FAQ</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate.html">Hibernate</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-statistics.html">Hibernate Statistics</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-user-guide.html">Hibernate User Guide</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-core.html">Hibernate - Core</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-core-conf.html">Hibernate - Core - Conf</a>
+
+
+ </div>
+ </li></ul>
+</div><h2 id="Hibernate-Core-Conf-HibernateSessionSourceConfiguration">HibernateSessionSource Configuration</h2><p>One way to configure hibernate is to create a <code>hibernate.cfg.xml</code> file and place it in the root of your application (i.e., under src/main/resources). Most Hibernate-specific configuration occurs in this file. Another way is to contribute objects that perform configuration (such as setting event listeners). Example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public static void contributeHibernateSessionSource(OrderedConfiguration<HibernateConfigurer> config)
+{
+ config.add("Widget", new WidgetHibernateConfigurer());
+}</pre>
+</div></div><p>Note that the configuration is an OrderedConfiguration. The library contributes two configurers by default:</p><ul><li><strong>Default</strong> - performs default hibernate configuration</li><li><strong>PackageName</strong> - loads entities by package name as contributed to the HibernateEntityPackageManager service</li></ul><h2 id="Hibernate-Core-Conf-HibernateEntityPackageManagerConfiguration">HibernateEntityPackageManager Configuration</h2><p>This configuration is a set of package names, identifying where to search for entity classes.</p><p>For each package contributed, the library will:</p><ul><li><a shape="rect" class="external-link" href="http://docs.jboss.org/hibernate/stable/core/api/org/hibernate/cfg/AnnotationConfiguration.html#addPackage(java.lang.String)" >Add the package to the configuration</a>, which will load annotations from the package-info class within the named package, if present.</li><li>Every Java class in the package (or any subpackage) will be
<a shape="rect" class="external-link" href="http://docs.jboss.org/hibernate/stable/core/api/org/hibernate/cfg/AnnotationConfiguration.html#addAnnotatedClass(java.lang.Class)" >added as an annotated class</a>. This excludes inner classes, but includes all other classes.</li></ul><p>By default, the package <em>application-root-package.entities</em> is scanned as described above. If you have additional packages containing entities, you must <a shape="rect" href="configuration.html">contribute</a> them to the tapestry.hibernate.HibernateEntityPackageManager service configuration.</p><p>Example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public static void contributeHibernateEntityPackageManager(Configuration<String> configuration)
{
configuration.add("org.example.myapp.domain");
}</pre>
-</div></div>
-
-<p>You may add as many packages in this manner as you wish. This option is most often used when the entities themselves are contained in a library included within an application, rather than part of the application directly.</p>
-
-<h1 id="Hibernate-Core-Conf-HibernateSymbols">Hibernate Symbols</h1>
-
-<p>The Hibernate integration includes a number of <a shape="rect" href="symbols.html">symbols</a> used to control certain features:</p>
-
-<div class="table-wrap"><table class="confluenceTable"><tbody><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> tapestry.hibernate.provide-entity-value-encoders </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> If true (the default) then ValueEncoders are automatically provided for all Hibernate entities (ValueEncoders are used to encode the primary keys of entities as strings that can be included in URLs). Set to false if you want direct control over this feature. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> tapestry.hibernate.default-configuration </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> If true (the default), then the application must include a <code>hibernate.cfg.xml</code> file. If your application configures itself entirely in code, you should set this symbol to false. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> tapestry.hibernate.early-startup </p></td><td colspan="1" rowspan="1" clas
s="confluenceTd"><p> If "true", the Hibernate is initialized when the application starts up. The default is "false", to start Hibernate up lazily, on first use. </p></td></tr></tbody></table></div></div>
+</div></div><p>You may add as many packages in this manner as you wish. This option is most often used when the entities themselves are contained in a library included within an application, rather than part of the application directly.</p><h1 id="Hibernate-Core-Conf-HibernateSymbols">Hibernate Symbols</h1><p>The Hibernate integration includes a number of <a shape="rect" href="symbols.html">symbols</a> used to control certain features:</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>tapestry.hibernate.provide-entity-value-encoders</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If true (the default) then ValueEncoders are automatically provided for all Hibernate entities (ValueEncoders are used to encode the primary keys of entities as strings that can be included in URLs). Set to false if you want direct control over this feature.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p
>tapestry.hibernate.default-configuration</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If true (the default), then the application must include a <code>hibernate.cfg.xml</code> file. If your application configures itself entirely in code, you should set this symbol to false.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>tapestry.hibernate.early-startup</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If "true", the Hibernate is initialized when the application starts up. The default is "false", to start Hibernate up lazily, on first use.</p></td></tr></tbody></table></div></div>
</div>
<div class="clearer"></div>
Modified: websites/production/tapestry/content/hibernate-core.html
==============================================================================
--- websites/production/tapestry/content/hibernate-core.html (original)
+++ websites/production/tapestry/content/hibernate-core.html Sun Jul 26 22:19:48 2015
@@ -27,16 +27,6 @@
</title>
<link type="text/css" rel="stylesheet" href="/resources/space.css">
- <link href='/resources/highlighter/styles/shCoreCXF.css' rel='stylesheet' type='text/css' />
- <link href='/resources/highlighter/styles/shThemeCXF.css' rel='stylesheet' type='text/css' />
- <script src='/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
- <script src='/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
- <script src='/resources/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
- <script src='/resources/highlighter/scripts/shBrushPlain.js' type='text/javascript'></script>
- <script type="text/javascript">
- SyntaxHighlighter.defaults['toolbar'] = false;
- SyntaxHighlighter.all();
- </script>
<link href="/styles/style.css" rel="stylesheet" type="text/css"/>
@@ -67,20 +57,82 @@
</div>
<div id="content">
-<div id="ConfluenceContent"><div class="navmenu" style="float:right; background:#eee; margin:3px; padding:3px">
-<div class="error"><span class="error">Error formatting macro: contentbylabel: com.atlassian.confluence.api.service.exceptions.BadRequestException: Could not parse cql : null</span> </div></div>
+<div id="ConfluenceContent"><p><strong>Hibernate-Core </strong>is a Tapestry module that provides basic Hibernate support without dependencies on the Tapestry-core (the web framework part of Tapestry).</p><div class="aui-label" style="float:right" title="Related Articles">
-<h1 id="Hibernate-Core-CoreHibernateSupport">Core Hibernate Support</h1>
-<p>This library contains basic Hibernate support package without dependencies on the Tapestry-core (the web framework part of Tapestry); it only requires the <a shape="rect" href="ioc.html">Tapestry IoC</a> module. This makes it useful in non-web applications, such as back-end processing.</p>
-<p>The <a shape="rect" href="hibernate.html">Tapestry-hibernate</a> module extends this further, adding features to support the creation of CRUD (Create/Read/Update/Delete) database applications in Tapestry.</p>
-<h1 id="Hibernate-Core-LicensingIssues">Licensing Issues</h1>
-<p>Hibernate is licensed under the Lesser GNU Public License. This is more restrictive license than the Apache Software License used by the rest of Tapestry. The restrictions mostly apply to redistributing Hibernate, especially in any altered form, and will likely be irrelvant to the vast majority of users, but you should be aware.</p>
-<p>This library is compiled against version <strong>3.3.1.GA</strong> of Hibernate (and version 3.4.0.GA of hibernate-annotations), but should work with more recent versions.</p></div>
+
+
+<h3>Related Articles</h3>
+
+<ul class="content-by-label"><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="using-tapestry-with-hibernate.html">Using Tapestry With Hibernate</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-support-faq.html">Hibernate Support FAQ</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate.html">Hibernate</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-statistics.html">Hibernate Statistics</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-user-guide.html">Hibernate User Guide</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-core.html">Hibernate - Core</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-core-conf.html">Hibernate - Core - Conf</a>
+
+
+ </div>
+ </li></ul>
+</div><p>This module only requires the <a shape="rect" href="ioc.html">Tapestry IoC</a> module. This makes it useful in non-web applications, such as back-end processing.</p><p>The <a shape="rect" href="hibernate.html">Tapestry-hibernate</a> module extends this further, adding features to support the creation of CRUD (Create/Read/Update/Delete) database applications in Tapestry.</p><h1 id="Hibernate-Core-LicensingIssues">Licensing Issues</h1><p>Hibernate is licensed under the Lesser GNU Public License. This is more restrictive license than the Apache Software License used by the rest of Tapestry. The restrictions mostly apply to redistributing Hibernate, especially in any altered form, and will likely be irrelvant to the vast majority of users, but you should be aware.</p><p>This library is compiled against version <strong>3.3.1.GA</strong> of Hibernate (and version 3.4.0.GA of hibernate-annotations), but should work with more recent versions.</p></div>
</div>
<div class="clearer"></div>
Modified: websites/production/tapestry/content/hibernate.html
==============================================================================
--- websites/production/tapestry/content/hibernate.html (original)
+++ websites/production/tapestry/content/hibernate.html Sun Jul 26 22:19:48 2015
@@ -27,16 +27,6 @@
</title>
<link type="text/css" rel="stylesheet" href="/resources/space.css">
- <link href='/resources/highlighter/styles/shCoreCXF.css' rel='stylesheet' type='text/css' />
- <link href='/resources/highlighter/styles/shThemeCXF.css' rel='stylesheet' type='text/css' />
- <script src='/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
- <script src='/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
- <script src='/resources/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
- <script src='/resources/highlighter/scripts/shBrushPlain.js' type='text/javascript'></script>
- <script type="text/javascript">
- SyntaxHighlighter.defaults['toolbar'] = false;
- SyntaxHighlighter.all();
- </script>
<link href="/styles/style.css" rel="stylesheet" type="text/css"/>
@@ -67,8 +57,82 @@
</div>
<div id="content">
-<div id="ConfluenceContent"><div class="navmenu" style="float:right; background:#eee; margin:3px; padding:3px">
-<div class="error"><span class="error">Error formatting macro: contentbylabel: com.atlassian.confluence.api.service.exceptions.BadRequestException: Could not parse cql : null</span> </div></div><p>The <strong>Tapestry-Hibernate Integration Library</strong> provides out-of-the-box support for using Hibernate 3 as the back end for normal CRUD style Tapestry applications.</p><p>This represents access to the native Hibernate interfaces, exposed in a thread-safe manner, within a <em>session-per-request</em> strategy.</p><p>Note that a number of the more esoteric ideas in Hibernate are not supported, including nested transactions and supporting multiple persistence units.</p><p>The <a shape="rect" href="hibernate-core.html">tapestry-hibernate-core</a> module allows non-Tapestry applications to access Hibernate.</p><h1 id="Hibernate-LicensingIssues">Licensing Issues</h1><p>Hibernate is licensed under the Lesser GNU Public License. This is more restrictive license than the Apache Software L
icense used by the rest of Tapestry. The restrictions mostly apply to redistributing Hibernate, especially in any altered form, and will likely be irrelevant to the vast majority of users, but you should be aware.</p><p>This library is compiled against version <strong>3.3.1.GA</strong> of Hibernate (and version 3.4.0.GA of hibernate-annotations), but should work with more recent versions.</p><h2 id="Hibernate-Notes">Notes</h2><ul><li>Transactions are <em>aborted</em> (not <em>committed</em>) at the end of each request: you must explicitly commit the transaction if changes are to be saved.</li><li>The CommitAfter annotation for component and service methods can commit the transaction automatically after the method is invoked.</li><li><a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/hibernate/HibernateGridDataSource.html">HibernateGridDataSource</a> can be used with the Grid component to support optimized queries against large
data sets.</li></ul></div>
+<div id="ConfluenceContent"><p>The <strong>Tapestry-Hibernate Integration Library</strong> provides out-of-the-box support for using Hibernate 3 as the back end for normal CRUD style Tapestry applications.</p><div class="aui-label" style="float:right" title="Related Articles">
+
+
+
+
+
+
+
+
+<h3>Related Articles</h3>
+
+<ul class="content-by-label"><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="using-tapestry-with-hibernate.html">Using Tapestry With Hibernate</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-support-faq.html">Hibernate Support FAQ</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate.html">Hibernate</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-statistics.html">Hibernate Statistics</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-user-guide.html">Hibernate User Guide</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-core.html">Hibernate - Core</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="hibernate-core-conf.html">Hibernate - Core - Conf</a>
+
+
+ </div>
+ </li></ul>
+</div><p>This represents access to the native Hibernate interfaces, exposed in a thread-safe manner, within a <em>session-per-request</em> strategy.</p><p>Note that a number of the more esoteric ideas in Hibernate are not supported, including nested transactions and supporting multiple persistence units.</p><p>The <a shape="rect" href="hibernate-core.html">tapestry-hibernate-core</a> module allows non-Tapestry applications to access Hibernate.</p><h1 id="Hibernate-LicensingIssues">Licensing Issues</h1><p>Hibernate is licensed under the Lesser GNU Public License. This is more restrictive license than the Apache Software License used by the rest of Tapestry. The restrictions mostly apply to redistributing Hibernate, especially in any altered form, and will likely be irrelevant to the vast majority of users, but you should be aware.</p><p>This library is compiled against version <strong>3.3.1.GA</strong> of Hibernate (and version 3.4.0.GA of hibernate-annotations), but should work with
more recent versions.</p><h2 id="Hibernate-Notes">Notes</h2><ul><li>Transactions are <em>aborted</em> (not <em>committed</em>) at the end of each request: you must explicitly commit the transaction if changes are to be saved.</li><li>The CommitAfter annotation for component and service methods can commit the transaction automatically after the method is invoked.</li><li><a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/hibernate/HibernateGridDataSource.html">HibernateGridDataSource</a> can be used with the Grid component to support optimized queries against large data sets.</li></ul></div>
</div>
<div class="clearer"></div>
Modified: websites/production/tapestry/content/injection-in-detail.html
==============================================================================
--- websites/production/tapestry/content/injection-in-detail.html (original)
+++ websites/production/tapestry/content/injection-in-detail.html Sun Jul 26 22:19:48 2015
@@ -62,13 +62,51 @@
<div class="clearer"></div>
<div id="breadcrumbs">
- <a href="index.html">Apache Tapestry</a> > <a href="documentation.html">Documentation</a> > <a href="user-guide.html">User Guide</a> > <a href="ioc.html">IoC</a> > <a href="injection-in-detail.html">Injection in Detail</a>
+ <a href="index.html">Apache Tapestry</a> > <a href="documentation.html">Documentation</a> > <a href="user-guide.html">User Guide</a> > <a href="ioc.html">IOC</a> > <a href="injection-in-detail.html">Injection in Detail</a>
<a class="edit" title="Edit this page (requires approval -- just ask on the mailing list)" href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=23338482">edit</a>
</div>
<div id="content">
-<div id="ConfluenceContent"><h1 id="InjectioninDetail-InjectioninDetail">Injection in Detail</h1><div class="navmenu" style="float:right; background:#eee; margin:3px; padding:3px">
-<div class="error"><span class="error">Error formatting macro: contentbylabel: com.atlassian.confluence.api.service.exceptions.BadRequestException: Could not parse cql : null</span> </div></div><p>Injection in Tapestry IoC can be a complicated subject for a number of reasons:</p><ul><li>Injection can occur in many places: on fields, and on parameters to methods and constructors of certain objects.</li><li>Parts of Injection are themselves defined in terms of Tapestry IoC services, many of which are extensible.</li></ul><p>Despite this, injection generally <em>Just Works</em>: most of the time, you want Tapestry to inject a service, and only a single service implements the service interface.</p><p>This document discusses what to do when you hit a case that doesn't Just Work, or when you want to extend the injection logic in some way.</p><p>Some aspects of this discussion reflect Tapestry IoC used within a Tapestry web application: the tapestry-core module makes some extensions to inj
ection.</p><h1 id="InjectioninDetail-InjectionTriggers">Injection Triggers</h1><p>Injection is triggered in a number of ways:</p><ul><li>A field in a component class, autobuilt object, or service implementation class is annotated with @Inject.</li><li>A method parameter to a service builder method, a decorator method, or a contribute method (in a Tapestry IoC module class).</li><li>A constructor parameter to an autobuilt object, or a service implementation class.</li><li>Any of the above with an @InjectService annotation.</li></ul><p>These define the <em>point of injection</em>.</p><p>Injection also covers a related matter: providing special resources to a service or component (remember that pages are specialized components). For a service, the service's id (as a string) or extensible configuration (as a Collection, List or Map) may be provided. For a component, the component's id, locale, message catalog, or component resources may be provided.</p><h1 id="InjectioninDetail-Sta
ndardInjectionProcessing">Standard Injection Processing</h1><p>This section describes standard injection, which applies at the IoC layer: autobuilt objects and service implementations. The steps for injection into Tapestry components are slightly different and are covered later.</p><p>So a the point of injection, Tapestry has identified a field or parameter that should be injected. At this point, Tapestry knows the following:</p><ul><li>The field name (if field injection). The parameter name is not available.</li><li>The field or parameter type, as a Java class. In many cases, this will be enough to identify what object shall be injected.</li><li>Any additional annotations on the field or parameter.</li></ul><p>Tapestry proceeds with this information.</p><h2 id="InjectioninDetail-Checkfor@InjectService">Check for @InjectService</h2><p>Tapestry checks first for the @InjectService annotation. The value of this annotation is the service id to inject. When @InjectService is present at t
he point of injection, the search is complete, though the injection can fail (throwing an exception) if the service id indicated does not exist, or if the service's interface is not compatible with the field's type.</p><h2 id="InjectioninDetail-Checkforserviceresources">Check for service resources</h2><p>This step applies only to IoC layer injection (not to injection into components).</p><p>When the @Inject annotation is <em>not present</em> at the point of injection, Tapestry checks to see if a resource can be injected. Services are global values, but resources are specific to the service under construction.</p><p>When the Inject annotation is present, this step is skipped (this is necessary when the object to be injected has a type that conflicts with a resource type, such as List or Class).</p><ul><li>org.slf4j.Logger – The Logger of the service being constructed (or the logger of the Module class being instantiated).</li><li><a shape="rect" class="external-link" href="http
://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/ObjectLocator.html">ObjectLocator</a> – For contribute methods, used to locate additional objects.</li><li><a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/ServiceResources.html">ServiceResources</a> – For service builder methods, an extended version of ObjectLocator. </li><li>Class – The service interface type.</li><li><a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/OperationTracker.html">OperationTracker</a> – Used to track deeply nested operations so that errors can be reported sensibly.</li><li>Object, or service interface type – Passed to decorator methods.</li><li>Collection, List, Map – Assembled service configurations passed to service builder methods (or service class constructors).</li><li><p>Configuration, OrderedConfiguration, MappedConfi
guration – Configuration passed to contribute methods, to build service configurations. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> If field type does not match any of the available resource types, or the Inject annotation is present, logic continues to the next step.</p><div class="confluence-information-macro confluence-information-macro-warning"><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>Injection of resources into fields is triggered by the presence of the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/InjectResource.html">InjectResource</a> annotation, whereas injection of resources into parameters occurs when the Inject or InjectService annotation is <em>not</em> present. These rules are slightly tricky, which reflects a desire to avoid any annot
ations except when needed, and the fact that field injection came much later than parameter injection.</p></div></div></li></ul><h2 id="InjectioninDetail-ServiceLookupbyTypeandAnnotations">Service Lookup by Type and Annotations</h2><p>Tapestry attempts to find a matching <em>service</em>.</p><p>First, it generates a set of services whose service interface is compatible with the injection type. This is based on assignability.</p><p>If the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Local.html">Local</a> annotation is present, then services not from the module containing the service being constructed will be eliminated.</p><p>Tapestry then works through the known marker annotations. For each marker annotation that is present at the point of injection, Tapestry eliminates services which <em>do not</em> have the marker. Thus, if multiple marker annotations are present, the final service must have <em>all of
them</em>.</p><p>At the end, of this, Tapestry determines how many services match.</p><ul><li>If there is a single matching service, then the service to inject as been identified.</li><li>If there are no matches, and there were no marker annotations at the point of injection, then the Tapestry continues to the next step.</li><li>Otherwise there were either no matches, or too many matches: Tapestry will throw a RuntimeException.</li></ul><h2 id="InjectioninDetail-MasterObjectProviderLookup">MasterObjectProvider Lookup</h2><p>This is the point at which Tapestry's extensibility comes into play. MasterObjectProvider is a service, with a configuration of <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/ObjectProvider.html">ObjectProviders</a>.</p><p>The MasterObjectProvider is also the point at which Tapestry's IoC layer injection, and Tapestry's component injection, unite.</p><p>As a chain-of-command, each of the following
ObjectProviders will be considered and will attempt to identify the object to be injected.</p><div class="confluence-information-macro confluence-information-macro-note"><span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>A common problem when extending injection is that contributions into the MasterObjectProvider configuration have to be handled carefully. Any dependencies of the contributed objects should be resolvable using only the early stages of the injection process, otherwise MasterObjectProvider will have to be instantiated in order to handle its own injection: Tapestry will detect this impossibility and throw an exception. In addition, the <a shape="rect" href="typecoercer-service.html">TypeCoercer</a> service is used by several ObjectProvider implementations, so the same restrictions apply to TypeCoercer service contributions.</p></div></div><h3 id="InjectioninDetail-ValueObj
ectProvider">Value ObjectProvider</h3><p>Checks for the presence of the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Value.html">Value</a> annotation. If present, then the annotation's value is evaluated (to expand any symbol references), and the TypeCoercer service is used to convert the resulting String to the injection type (the field or parameter type).</p><h3 id="InjectioninDetail-SymbolObjectProvider">Symbol ObjectProvider</h3><p>Similar to the Value ObjectProvider: the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Symbol.html">Symbol</a> annotation's value (if present) is looked up using the <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/services/SymbolSource.html">SymbolSource</a> service, and converted to the injection type via the TypeCoercer servi
ce.</p><h3 id="InjectioninDetail-AutobuildObjectProvider">Autobuild ObjectProvider</h3><p>Checks to see if the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Autobuild.html">Autobuild</a> annotation is present and, if so, autobuilds the value for the parameter. Of course, the object being built will itself be configured via injection.</p><h3 id="InjectioninDetail-ServiceOverrideObjectProvider">ServiceOverride ObjectProvider</h3><p>Checks any contributions to the <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/services/ServiceOverride.html">ServiceOverride</a> service. Contributions map a type to an object of that type. Thus, ServiceOverrides will override injections of services that are not qualified with a marker annotation.</p><h3 id="InjectioninDetail-AliasObjectProvider(tapestry-core)">Alias ObjectProvider (tapestry-core)</h3><p>Uses the A
lias service (<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/services/Alias.html">API</a>) to look for an object that can be injected.</p><div class="confluence-information-macro confluence-information-macro-warning"><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>Deprecated in Tapestry 5.2 and removed in 5.4.</p></div></div><p>This is commonly used to override a built-in service by contributing an object with the exact same interface. This is an older and more complex version of the ServiceOverride provider.</p><h3 id="InjectioninDetail-AssetObjectProvider(tapestry-core)">Asset ObjectProvider (tapestry-core)</h3><p>Checks for the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Path.html">Path</a> annotation.</p><p>If present, the annotation's value has
embedded symbols expanded, and is converted into an Asset (which must exist).</p><p>The TypeCoercer can then convert the Asset to the injection type, for example, as Resource.</p><h3 id="InjectioninDetail-ServiceObjectProvider(tapestry-core)">Service ObjectProvider (tapestry-core)</h3><p>Looks for the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Service.html">Service</a> annotation; if present, the annotation's value is the exact service id to inject. This is necessary because injections into <em>component</em> fields are always triggered by the Inject annotation.</p><div class="confluence-information-macro confluence-information-macro-note"><span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>This is supported but no longer necessary, as the @InjectService annotation is now also supported for component fields.<
/p></div></div><h3 id="InjectioninDetail-SpringBeanObjectProvider(tapestry-spring)">SpringBean ObjectProvider (tapestry-spring)</h3><p>Attempts to resolve a Spring bean purely by object type (Spring qualifiers are not supported). If no beans are assignable to the type, then processing continues. If exactly one is assignable, it is used as the injection value. If more than one bean is assignable, it is an error (and a list of matching beans names will be part of the thrown exception).</p><h2 id="InjectioninDetail-ServiceLookup">Service Lookup</h2><p>If none of the ObjectProviders can identify the value to inject, a last step occurs: lookup by service type. If exactly <em>one</em> service matches the injection type, then that service is injected.</p><p>Otherwise, the lookup fails because either no services match, or more than one matches. An exception will be thrown with the details, including a list of matching services (if there is more than one match).</p><h1 id="InjectioninDetail-
Post-InjectionMethods">Post-Injection Methods</h1><p>Autobuilt objects (services and the like, but <em>not</em> components) may have post-injection methods.</p><p>Any public method may have the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/PostInjection.html">PostInjection</a> annotation.</p><p>Such methods are invoked after constructor and/or field injection. Only <strong>public methods</strong> will be invoked. Any return value is ignored.</p><p>The method often takes no parameters; however if the method has parameters, these parameters are new points of injection.</p><p>Often this is used to perform additional setup, such as registerring a service as a listener of events produced by another service:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div id="ConfluenceContent"><p><strong>Injection</strong> in Tapestry IoC can be a complicated subject for a number of reasons:</p><ul><li>Injection can occur in many places: on fields, and on parameters to methods and constructors of certain objects.</li><li>Parts of Injection are themselves defined in terms of Tapestry IoC services, many of which are extensible.</li></ul><div class="aui-label" style="float:right" title="Related Articles">
+
+
+
+
+
+
+
+
+<h3>Related Articles</h3>
+
+<ul class="content-by-label"><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="injection-in-detail.html">Injection in Detail</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="injection-faq.html">Injection FAQ</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="injection.html">Injection</a>
+
+
+ </div>
+ </li></ul>
+</div><p>Despite this, injection generally <em>Just Works</em>: most of the time, you want Tapestry to inject a service, and only a single service implements the service interface.</p><p>This document discusses what to do when you hit a case that doesn't Just Work, or when you want to extend the injection logic in some way.</p><p>Some aspects of this discussion reflect Tapestry IoC used within a Tapestry web application: the tapestry-core module makes some extensions to injection.</p><h1 id="InjectioninDetail-InjectionTriggers">Injection Triggers</h1><p>Injection is triggered in a number of ways:</p><ul><li>A field in a component class, autobuilt object, or service implementation class is annotated with @Inject.</li><li>A method parameter to a service builder method, a decorator method, or a contribute method (in a Tapestry IoC module class).</li><li>A constructor parameter to an autobuilt object, or a service implementation class.</li><li>Any of the above with an @InjectService ann
otation.</li></ul><p>These define the <em>point of injection</em>.</p><p>Injection also covers a related matter: providing special resources to a service or component (remember that pages are specialized components). For a service, the service's id (as a string) or extensible configuration (as a Collection, List or Map) may be provided. For a component, the component's id, locale, message catalog, or component resources may be provided.</p><h1 id="InjectioninDetail-StandardInjectionProcessing">Standard Injection Processing</h1><p>This section describes standard injection, which applies at the IoC layer: autobuilt objects and service implementations. The steps for injection into Tapestry components are slightly different and are covered later.</p><p>So a the point of injection, Tapestry has identified a field or parameter that should be injected. At this point, Tapestry knows the following:</p><ul><li>The field name (if field injection). The parameter name is not available.</li>
<li>The field or parameter type, as a Java class. In many cases, this will be enough to identify what object shall be injected.</li><li>Any additional annotations on the field or parameter.</li></ul><p>Tapestry proceeds with this information.</p><h2 id="InjectioninDetail-Checkfor@InjectService">Check for @InjectService</h2><p>Tapestry checks first for the @InjectService annotation. The value of this annotation is the service id to inject. When @InjectService is present at the point of injection, the search is complete, though the injection can fail (throwing an exception) if the service id indicated does not exist, or if the service's interface is not compatible with the field's type.</p><h2 id="InjectioninDetail-Checkforserviceresources">Check for service resources</h2><p>This step applies only to IoC layer injection (not to injection into components).</p><p>When the @Inject annotation is <em>not present</em> at the point of injection, Tapestry checks to see if a resource can be in
jected. Services are global values, but resources are specific to the service under construction.</p><p>When the Inject annotation is present, this step is skipped (this is necessary when the object to be injected has a type that conflicts with a resource type, such as List or Class).</p><ul><li>org.slf4j.Logger – The Logger of the service being constructed (or the logger of the Module class being instantiated).</li><li><a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/ObjectLocator.html">ObjectLocator</a> – For contribute methods, used to locate additional objects.</li><li><a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/ServiceResources.html">ServiceResources</a> – For service builder methods, an extended version of ObjectLocator. </li><li>Class – The service interface type.</li><li><a shape="rect" class="external-link" href
="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/OperationTracker.html">OperationTracker</a> – Used to track deeply nested operations so that errors can be reported sensibly.</li><li>Object, or service interface type – Passed to decorator methods.</li><li>Collection, List, Map – Assembled service configurations passed to service builder methods (or service class constructors).</li><li><p>Configuration, OrderedConfiguration, MappedConfiguration – Configuration passed to contribute methods, to build service configurations. <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> If field type does not match any of the available resource types, or the Inject annotation is present, logic continues to the next step.</p><div class="confluence-information-macro confluence-information-macro-warning"><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"></span><div class="conflu
ence-information-macro-body"><p>Injection of resources into fields is triggered by the presence of the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/InjectResource.html">InjectResource</a> annotation, whereas injection of resources into parameters occurs when the Inject or InjectService annotation is <em>not</em> present. These rules are slightly tricky, which reflects a desire to avoid any annotations except when needed, and the fact that field injection came much later than parameter injection.</p></div></div></li></ul><h2 id="InjectioninDetail-ServiceLookupbyTypeandAnnotations">Service Lookup by Type and Annotations</h2><p>Tapestry attempts to find a matching <em>service</em>.</p><p>First, it generates a set of services whose service interface is compatible with the injection type. This is based on assignability.</p><p>If the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/curre
nt/apidocs/org/apache/tapestry5/ioc/annotations/Local.html">Local</a> annotation is present, then services not from the module containing the service being constructed will be eliminated.</p><p>Tapestry then works through the known marker annotations. For each marker annotation that is present at the point of injection, Tapestry eliminates services which <em>do not</em> have the marker. Thus, if multiple marker annotations are present, the final service must have <em>all of them</em>.</p><p>At the end, of this, Tapestry determines how many services match.</p><ul><li>If there is a single matching service, then the service to inject as been identified.</li><li>If there are no matches, and there were no marker annotations at the point of injection, then the Tapestry continues to the next step.</li><li>Otherwise there were either no matches, or too many matches: Tapestry will throw a RuntimeException.</li></ul><h2 id="InjectioninDetail-MasterObjectProviderLookup">MasterObjectProvider Lo
okup</h2><p>This is the point at which Tapestry's extensibility comes into play. MasterObjectProvider is a service, with a configuration of <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/ObjectProvider.html">ObjectProviders</a>.</p><p>The MasterObjectProvider is also the point at which Tapestry's IoC layer injection, and Tapestry's component injection, unite.</p><p>As a chain-of-command, each of the following ObjectProviders will be considered and will attempt to identify the object to be injected.</p><div class="confluence-information-macro confluence-information-macro-note"><span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>A common problem when extending injection is that contributions into the MasterObjectProvider configuration have to be handled carefully. Any dependencies of the contributed objects should be resolva
ble using only the early stages of the injection process, otherwise MasterObjectProvider will have to be instantiated in order to handle its own injection: Tapestry will detect this impossibility and throw an exception. In addition, the <a shape="rect" href="typecoercer-service.html">TypeCoercer</a> service is used by several ObjectProvider implementations, so the same restrictions apply to TypeCoercer service contributions.</p></div></div><h3 id="InjectioninDetail-ValueObjectProvider">Value ObjectProvider</h3><p>Checks for the presence of the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Value.html">Value</a> annotation. If present, then the annotation's value is evaluated (to expand any symbol references), and the TypeCoercer service is used to convert the resulting String to the injection type (the field or parameter type).</p><h3 id="InjectioninDetail-SymbolObjectProvider">Symbol ObjectProvider</h3><p
>Similar to the Value ObjectProvider: the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Symbol.html">Symbol</a> annotation's value (if present) is looked up using the <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/services/SymbolSource.html">SymbolSource</a> service, and converted to the injection type via the TypeCoercer service.</p><h3 id="InjectioninDetail-AutobuildObjectProvider">Autobuild ObjectProvider</h3><p>Checks to see if the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Autobuild.html">Autobuild</a> annotation is present and, if so, autobuilds the value for the parameter. Of course, the object being built will itself be configured via injection.</p><h3 id="InjectioninDetail-ServiceOverrideObjectProvider">ServiceOverride ObjectProvider</h3><p>Checks
any contributions to the <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/services/ServiceOverride.html">ServiceOverride</a> service. Contributions map a type to an object of that type. Thus, ServiceOverrides will override injections of services that are not qualified with a marker annotation.</p><h3 id="InjectioninDetail-AliasObjectProvider(tapestry-core)">Alias ObjectProvider (tapestry-core)</h3><p>Uses the Alias service (<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/services/Alias.html">API</a>) to look for an object that can be injected.</p><div class="confluence-information-macro confluence-information-macro-warning"><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>Deprecated in Tapestry 5.2 and removed in 5.4.</p></div></div><p>This is commonly used to ove
rride a built-in service by contributing an object with the exact same interface. This is an older and more complex version of the ServiceOverride provider.</p><h3 id="InjectioninDetail-AssetObjectProvider(tapestry-core)">Asset ObjectProvider (tapestry-core)</h3><p>Checks for the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Path.html">Path</a> annotation.</p><p>If present, the annotation's value has embedded symbols expanded, and is converted into an Asset (which must exist).</p><p>The TypeCoercer can then convert the Asset to the injection type, for example, as Resource.</p><h3 id="InjectioninDetail-ServiceObjectProvider(tapestry-core)">Service ObjectProvider (tapestry-core)</h3><p>Looks for the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Service.html">Service</a> annotation; if present, the annotation's value is the exact service
id to inject. This is necessary because injections into <em>component</em> fields are always triggered by the Inject annotation.</p><div class="confluence-information-macro confluence-information-macro-note"><span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>This is supported but no longer necessary, as the @InjectService annotation is now also supported for component fields.</p></div></div><h3 id="InjectioninDetail-SpringBeanObjectProvider(tapestry-spring)">SpringBean ObjectProvider (tapestry-spring)</h3><p>Attempts to resolve a Spring bean purely by object type (Spring qualifiers are not supported). If no beans are assignable to the type, then processing continues. If exactly one is assignable, it is used as the injection value. If more than one bean is assignable, it is an error (and a list of matching beans names will be part of the thrown exception).</p><h2 id="InjectioninDetail-S
erviceLookup">Service Lookup</h2><p>If none of the ObjectProviders can identify the value to inject, a last step occurs: lookup by service type. If exactly <em>one</em> service matches the injection type, then that service is injected.</p><p>Otherwise, the lookup fails because either no services match, or more than one matches. An exception will be thrown with the details, including a list of matching services (if there is more than one match).</p><h1 id="InjectioninDetail-Post-InjectionMethods">Post-Injection Methods</h1><p>Autobuilt objects (services and the like, but <em>not</em> components) may have post-injection methods.</p><p>Any public method may have the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/PostInjection.html">PostInjection</a> annotation.</p><p>Such methods are invoked after constructor and/or field injection. Only <strong>public methods</strong> will be invoked. Any return value is ignored
.</p><p>The method often takes no parameters; however if the method has parameters, these parameters are new points of injection.</p><p>Often this is used to perform additional setup, such as registerring a service as a listener of events produced by another service:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class MyServiceImpl implements MyService, UpdateListener
{
@PostInjection
Modified: websites/production/tapestry/content/integrating-with-spring-framework.html
==============================================================================
--- websites/production/tapestry/content/integrating-with-spring-framework.html (original)
+++ websites/production/tapestry/content/integrating-with-spring-framework.html Sun Jul 26 22:19:48 2015
@@ -32,7 +32,6 @@
<script src='/resources/highlighter/scripts/shCore.js' type='text/javascript'></script>
<script src='/resources/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
<script src='/resources/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
- <script src='/resources/highlighter/scripts/shBrushPlain.js' type='text/javascript'></script>
<script type="text/javascript">
SyntaxHighlighter.defaults['toolbar'] = false;
SyntaxHighlighter.all();
@@ -67,14 +66,44 @@
</div>
<div id="content">
-<div id="ConfluenceContent"><div class="navmenu" style="float:right; background:#eee; margin:3px; padding:3px">
-<div class="error"><span class="error">Error formatting macro: contentbylabel: com.atlassian.confluence.api.service.exceptions.BadRequestException: Could not parse cql : null</span> </div></div><p>Tapestry easily integrates with Spring Framework, allowing beans defined by Spring to be injected into Tapestry IoC services, and into Tapestry components. In addition, with Tapestry 5.2 and later, you can also go the other way, injecting Tapestry services in Spring beans.</p><p>For integrating Spring Security into your application, see <a shape="rect" href="security.html">Security</a>.</p><p><strong>Contents</strong></p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1437340785194 {padding: 0px;}
-div.rbtoc1437340785194 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1437340785194 li {margin-left: 0px;padding-left: 0px;}
+<div id="ConfluenceContent"><p>Tapestry easily integrates with Spring Framework, allowing beans defined by Spring to be injected into Tapestry IoC services, and into Tapestry components. In addition, with Tapestry 5.2 and later, you can also go the other way, injecting Tapestry services in Spring beans.</p><div class="aui-label" style="float:right" title="Related Articles">
-/*]]>*/</style></p><div class="toc-macro rbtoc1437340785194">
-<ul class="toc-indentation"><li><a shape="rect" href="#IntegratingwithSpringFramework-SpringVersion">Spring Version</a></li><li><a shape="rect" href="#IntegratingwithSpringFramework-Usage">Usage</a>
+
+
+
+
+
+
+
+<h3>Related Articles</h3>
+
+<ul class="content-by-label"><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="integrating-with-spring-framework.html">Integrating with Spring Framework</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="security.html">Security</a>
+
+
+ </div>
+ </li></ul>
+</div><p>For integrating Spring Security into your application, see <a shape="rect" href="security.html">Security</a>.</p><p><strong>Contents</strong></p><p><style type="text/css">/*<![CDATA[*/
+div.rbtoc1437949176882 {padding: 0px;}
+div.rbtoc1437949176882 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1437949176882 li {margin-left: 0px;padding-left: 0px;}
+
+/*]]>*/</style></p><div class="toc-macro rbtoc1437949176882">
+<ul class="toc-indentation"><li>Related Articles</li></ul>
+<ul><li><a shape="rect" href="#IntegratingwithSpringFramework-SpringVersion">Spring Version</a></li><li><a shape="rect" href="#IntegratingwithSpringFramework-Usage">Usage</a>
<ul class="toc-indentation"><li><a shape="rect" href="#IntegratingwithSpringFramework-Requireddependency">Required dependency</a></li><li><a shape="rect" href="#IntegratingwithSpringFramework-Updateyourweb.xmlfile">Update your web.xml file</a></li><li><a shape="rect" href="#IntegratingwithSpringFramework-AccessingtheSpringApplicationContext">Accessing the Spring Application Context</a></li><li><a shape="rect" href="#IntegratingwithSpringFramework-Injectingbeans">Injecting beans</a></li><li><a shape="rect" href="#IntegratingwithSpringFramework-InjectingTapestryservicesinSpringbeans">Injecting Tapestry services in Spring beans</a></li></ul>
</li><li><a shape="rect" href="#IntegratingwithSpringFramework-ApplicationContextCustomizer">ApplicationContextCustomizer</a></li><li><a shape="rect" href="#IntegratingwithSpringFramework-5.0CompatibilityMode">5.0 Compatibility Mode</a></li><li><a shape="rect" href="#IntegratingwithSpringFramework-ChangesFrom5.0">Changes From 5.0</a></li><li><a shape="rect" href="#IntegratingwithSpringFramework-Limitations">Limitations</a></li></ul>
</div><h2 id="IntegratingwithSpringFramework-SpringVersion">Spring Version</h2><p>This module is compiled and tested against Spring Framework 2.5.6. It should be reasonable to override the dependency to earlier versions of Spring, though the code makes use of some APIs that were added to Spring to support JDK 1.5 annotations.</p><h2 id="IntegratingwithSpringFramework-Usage">Usage</h2><p>The integration is designed to be a very thin layer on top of Spring's normal configuration for a web application.</p><p>Detailed instructions are available in the <a shape="rect" class="external-link" href="http://static.springframework.org/spring/docs/2.5.x/reference/beans.html#context-create" >Spring documentation</a>. Please omit the part about creating a ContextLoaderListener: this is now done automatically by Tapestry.</p><h3 id="IntegratingwithSpringFramework-Requireddependency">Required dependency</h3><p>To integrate Spring with Tapestry, you should add the below dependency in your classpath.
The following exemple is for Maven users.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
Modified: websites/production/tapestry/content/logging-in-tapestry.html
==============================================================================
--- websites/production/tapestry/content/logging-in-tapestry.html (original)
+++ websites/production/tapestry/content/logging-in-tapestry.html Sun Jul 26 22:19:48 2015
@@ -62,13 +62,42 @@
<div class="clearer"></div>
<div id="breadcrumbs">
- <a href="index.html">Apache Tapestry</a> > <a href="documentation.html">Documentation</a> > <a href="user-guide.html">User Guide</a> > <a href="ioc.html">IoC</a> > <a href="logging-in-tapestry.html">Logging in Tapestry</a>
+ <a href="index.html">Apache Tapestry</a> > <a href="documentation.html">Documentation</a> > <a href="user-guide.html">User Guide</a> > <a href="ioc.html">IOC</a> > <a href="logging-in-tapestry.html">Logging in Tapestry</a>
<a class="edit" title="Edit this page (requires approval -- just ask on the mailing list)" href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=23338483">edit</a>
</div>
<div id="content">
-<div id="ConfluenceContent"><div class="navmenu" style="float:right; background:#eee; margin:3px; padding:3px">
-<div class="error"><span class="error">Error formatting macro: contentbylabel: com.atlassian.confluence.api.service.exceptions.BadRequestException: Could not parse cql : null</span> </div></div><h1 id="LogginginTapestry-LogginginTapestry">Logging in Tapestry</h1><p>Logging in Tapestry is based on the <a shape="rect" class="external-link" href="http://www.slf4j.org/" >Simple Logging Facade for Java (SLF4J)</a>. You can think of SLF4J as a leaner, meaner replacement for <a shape="rect" class="external-link" href="http://commons.apache.org/logging/">commons-logging</a>.</p><p>In theory, SLF4J is a wrapper around any of a number of logging systems, including <a shape="rect" class="external-link" href="http://logging.apache.org/log4j/1.2/">Log4J</a> or the built-in JDK logging. In practice, it is almost always used with Log4J and no additional build configuration is needed.</p><p>Your application <em>will</em> need to provide a <strong>log4j.properties</strong> file (or its XML equivalen
t). See <a shape="rect" class="external-link" href="http://logging.apache.org/log4j/1.2/manual.html">the Log4J manual</a> for more information.</p><h1 id="LogginginTapestry-AccessingLoggers">Accessing Loggers</h1><p>Loggers are a special kind of resource that is injected into a service. In Tapestry IoC, Loggers an be injected into service constructors, or into service builder methods.</p><p>In Tapestry Core (the web framework), Loggers for components can be injected into component fields.</p><p>This often confuses people, because the standard idiom is to create a Logger based on the class name and inject it into a static field. In Tapestry, the Logger is created on your code's behalf and provided to you, and stored into a final private field.</p><p>In terms of separation of concerns, Tapestry's approach is superior ... the concern of creating loggers is offloaded into the framework, and you code retains the concern of actually logging useful information. However this is largely theo
retical.</p><p>For a pragmatic standpoint, injecting Loggers makes it easier to test <em>logging</em> code using the same techniques used to test other code: via the injection of Mock Object implementations of the Logger interface. This is something to consider when writing your own services, components and test.</p><h1 id="LogginginTapestry-ServiceLogging">Service Logging</h1><p>Tapestry uses the same loggers that are injected into services; it logs, at debug level, details about the construction of the service (and the proxy for the service), including details such as methods invoked.</p><h1 id="LogginginTapestry-OperationTracker">Operation Tracker</h1><p>The OperationTracker is a resource available throughout Tapestry that is used to track what Tapestry is doing at any given time. Normally, this information is only used when reporting errors, as it gives an indication of what Tapestry was doing leading up to the point where the exception occurred.</p><p>Starting in Tapestry 5.3,
you may also enable debug logging for <code>org.apache.tapestry5.ioc.Registry</code> to see voluminous details on creation of proxies, services, injections, and so forth. It also tracks creation of pages and components, triggering of component events, handling of return values from event handler methods, and many (many!) other details.</p><p>The logging even identifies how long each operation takes. This can be useful for understanding what is going on in a Tapestry application during the processing of the request, it can also be useful when tracking down performance issues.</p><p>An example from the startup of a Tapestry application:</p><div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
+<div id="ConfluenceContent"><p><strong>Logging in Tapestry</strong> is based on the <a shape="rect" class="external-link" href="http://www.slf4j.org/" >Simple Logging Facade for Java (SLF4J)</a>. You can think of SLF4J as a leaner, meaner replacement for <a shape="rect" class="external-link" href="http://commons.apache.org/logging/">commons-logging</a>.</p><div class="aui-label" style="float:right" title="Related Articles">
+
+
+
+
+
+
+
+
+<h3>Related Articles</h3>
+
+<ul class="content-by-label"><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="logging-in-tapestry.html">Logging in Tapestry</a>
+
+
+ </div>
+ </li><li>
+ <div>
+ <span class="icon aui-icon aui-icon-small aui-iconfont-page-default" title="Page">Page:</span> </div>
+
+ <div class="details">
+ <a shape="rect" href="logging.html">Logging</a>
+
+
+ </div>
+ </li></ul>
+</div><p>In theory, SLF4J is a wrapper around any of a number of logging systems, including <a shape="rect" class="external-link" href="http://logging.apache.org/log4j/1.2/">Log4J</a> or the built-in JDK logging. In practice, it is almost always used with Log4J and no additional build configuration is needed.</p><p>Your application <em>will</em> need to provide a <strong>log4j.properties</strong> file (or its XML equivalent). See <a shape="rect" class="external-link" href="http://logging.apache.org/log4j/1.2/manual.html">the Log4J manual</a> for more information.</p><h1 id="LogginginTapestry-AccessingLoggers">Accessing Loggers</h1><p>Loggers are a special kind of resource that is injected into a service. In Tapestry IoC, Loggers an be injected into service constructors, or into service builder methods.</p><p>In Tapestry Core (the web framework), Loggers for components can be injected into component fields.</p><p>This often confuses people, because the standard idiom is to create a L
ogger based on the class name and inject it into a static field. In Tapestry, the Logger is created on your code's behalf and provided to you, and stored into a final private field.</p><p>In terms of separation of concerns, Tapestry's approach is superior ... the concern of creating loggers is offloaded into the framework, and you code retains the concern of actually logging useful information. However this is largely theoretical.</p><p>For a pragmatic standpoint, injecting Loggers makes it easier to test <em>logging</em> code using the same techniques used to test other code: via the injection of Mock Object implementations of the Logger interface. This is something to consider when writing your own services, components and test.</p><h1 id="LogginginTapestry-ServiceLogging">Service Logging</h1><p>Tapestry uses the same loggers that are injected into services; it logs, at debug level, details about the construction of the service (and the proxy for the service), including details su
ch as methods invoked.</p><h1 id="LogginginTapestry-OperationTracker">Operation Tracker</h1><p>The OperationTracker is a resource available throughout Tapestry that is used to track what Tapestry is doing at any given time. Normally, this information is only used when reporting errors, as it gives an indication of what Tapestry was doing leading up to the point where the exception occurred.</p><p>Starting in Tapestry 5.3, you may also enable debug logging for <code>org.apache.tapestry5.ioc.Registry</code> to see voluminous details on creation of proxies, services, injections, and so forth. It also tracks creation of pages and components, triggering of component events, handling of return values from event handler methods, and many (many!) other details.</p><p>The logging even identifies how long each operation takes. This can be useful for understanding what is going on in a Tapestry application during the processing of the request, it can also be useful when tracking down performan
ce issues.</p><p>An example from the startup of a Tapestry application:</p><div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>[INFO] RegistryBuilder Adding module definition for class org.apache.tapestry5.services.TapestryModule
[INFO] RegistryBuilder Adding module definition for class org.apache.tapestry5.internal.services.InternalModule
[INFO] RegistryBuilder Adding module definition for class org.apache.tapestry5.services.assets.AssetsModule