You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by bu...@apache.org on 2015/07/19 23:21:30 UTC
svn commit: r958985 [15/29] - in /websites/production/tapestry/content: ./
2009/09/13/ 2009/10/27/ 2009/11/25/ 2010/07/18/ 2010/07/24/ 2010/10/11/
2010/10/31/ 2010/11/18/ 2010/12/16/ 2010/12/17/ 2011/01/18/ 2011/03/23/
2011/03/29/ 2011/03/30/ 2011/03/3...
Modified: websites/production/tapestry/content/injection-faq.html
==============================================================================
--- websites/production/tapestry/content/injection-faq.html (original)
+++ websites/production/tapestry/content/injection-faq.html Sun Jul 19 21:21:27 2015
@@ -27,6 +27,16 @@
</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"/>
@@ -57,65 +67,57 @@
</div>
<div id="content">
-<div id="ConfluenceContent"><style type="text/css">/*<![CDATA[*/
-table.ScrollbarTable {border: none;padding: 3px;width: 100%;padding: 3px;margin: 0px;background-color: #f0f0f0}
-table.ScrollbarTable td.ScrollbarPrevIcon {text-align: center;width: 16px;border: none;}
-table.ScrollbarTable td.ScrollbarPrevName {text-align: left;border: none;}
-table.ScrollbarTable td.ScrollbarParent {text-align: center;border: none;}
-table.ScrollbarTable td.ScrollbarNextName {text-align: right;border: none;}
-table.ScrollbarTable td.ScrollbarNextIcon {text-align: center;width: 16px;border: none;}
-
-/*]]>*/</style><div class="Scrollbar"><table class="ScrollbarTable"><tr><td colspan="1" rowspan="1" class="ScrollbarPrevIcon"><a shape="rect" href="ajax-components-faq.html"><img align="middle" border="0" src="https://cwiki.apache.org/confluence/images/icons/back_16.gif" width="16" height="16"></a></td><td colspan="1" rowspan="1" class="ScrollbarPrevName" width="33%"><a shape="rect" href="ajax-components-faq.html">Ajax Components FAQ</a> </td><td colspan="1" rowspan="1" class="ScrollbarParent" width="33%"><sup><a shape="rect" href="frequently-asked-questions.html"><img align="middle" border="0" src="https://cwiki.apache.org/confluence/images/icons/up_16.gif" width="8" height="8"></a></sup><a shape="rect" href="frequently-asked-questions.html">Frequently Asked Questions</a></td><td colspan="1" rowspan="1" class="ScrollbarNextName" width="33%"> <a shape="rect" href="tapestry-inversion-of-control-faq.html">Tapestry Inversion of Control FAQ</a></td><td colspan="1" rowspan="1"
class="ScrollbarNextIcon"><a shape="rect" href="tapestry-inversion-of-control-faq.html"><img align="middle" border="0" src="https://cwiki.apache.org/confluence/images/icons/forwd_16.gif" width="16" height="16"></a></td></tr></table></div><h2 id="InjectionFAQ-Injection">Injection</h2><p>Main article: <a shape="rect" href="injection.html">Injection</a></p><h3 id="InjectionFAQ-What'sthedifferencebetweenthe@Componentand@InjectComponentannotations?">What's the difference between the <code>@Component</code> and <code>@InjectComponent</code> annotations?</h3><p>The <code>@Component</code> annotation is used to define the <em>type</em> of component, and its parameter bindings. When using <code>@Component</code>, the template must not define the type, and any parameter bindings are merged in:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: true; theme: Default" type="syntaxhighlighter"><![CDATA[ <a t:id="home" class="nav">Back to home</a>
-]]></script>
+<div id="ConfluenceContent"><h2 id="InjectionFAQ-Injection">Injection</h2><p>Main article: <a shape="rect" href="injection.html">Injection</a></p><h3 id="InjectionFAQ-What'sthedifferencebetweenthe@Componentand@InjectComponentannotations?">What's the difference between the <code>@Component</code> and <code>@InjectComponent</code> annotations?</h3><p>The <code>@Component</code> annotation is used to define the <em>type</em> of component, and its parameter bindings. When using <code>@Component</code>, the template must not define the type, and any parameter bindings are merged in:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: true; theme: Default" style="font-size:12px;"> <a t:id="home" class="nav">Back to home</a>
+</pre>
</div></div><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: true; theme: Default" type="syntaxhighlighter"><![CDATA[ @Component(parameters={ "page=index" })
+<pre class="brush: java; gutter: true; theme: Default" style="font-size:12px;"> @Component(parameters={ "page=index" })
private PageLink home;
-]]></script>
+</pre>
</div></div><p>Here the type of component is defined by the field type. The field name is matched against the <code>t:id</code> in the template. The <code>page</code> parameter is set in the Java class, and the informal <code>class</code> parameter is set in the template. If the tag in the template was <code><t:pagelink></code>, or if the template tag included the attribute <code>t:type="pagelink"</code>, then you would see an exception.</p><p>By contrast, <code>@InjectComponent</code> expects the component to be already defined, and doesn't allow any configuration of it:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: true; theme: Default" type="syntaxhighlighter"><![CDATA[ <t:form t:id="login"> .... </t:form>
-]]></script>
+<pre class="brush: java; gutter: true; theme: Default" style="font-size:12px;"> <t:form t:id="login"> .... </t:form>
+</pre>
</div></div><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: true; theme: Default" type="syntaxhighlighter"><![CDATA[ @InjectComponent
+<pre class="brush: java; gutter: true; theme: Default" style="font-size:12px;"> @InjectComponent
private Form login;
-]]></script>
+</pre>
</div></div><p>Again, we're matching the field name to the component id, and you would get an error if the component is not defined in the template.</p><h3 id="InjectionFAQ-What'sthedifferencebetweenthe@InjectPageand@InjectContainerannotations?">What's the difference between the <code>@InjectPage</code> and <code>@InjectContainer</code> annotations?</h3><p>The <code>@InjectPage</code> annotation is used to inject some page in the application into a field of some other page. You often see it used from event handler methods:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: true; theme: Default" type="syntaxhighlighter"><![CDATA[ @InjectPage
+<pre class="brush: java; gutter: true; theme: Default" style="font-size:12px;"> @InjectPage
private ConfirmRegistration confirmRegistration;
Object onSuccessFromRegistrationForm()
{
- confirmRegistration.setStatus("Registration accepted");
+ confirmRegistration.setStatus("Registration accepted");
confirmRegistration.setValidationCode(userRegistrationData.getValidationCode());
return confirmRegistration;
}
-]]></script>
+</pre>
</div></div><p>This code pattern is used to configure peristent properties of a page before returning it; Tapestry will send a client redirect to the page to present the data.</p><p><code>@InjectContainer</code> can be used inside a component or a mixin. In a component, it injects the immediate container of the component; this is often the top-level page object.</p><p>In a mixin, it injects the component to which the mixin is attached.</p><h3 id="InjectionFAQ-IgetanexceptionbecauseIhavetwoserviceswiththesameinterface,howdoIhandlethis?">I get an exception because I have two services with the same interface, how do I handle this?</h3><p>It's not uncommon to have two or more services that implement the exact same interface. When you inject, you might start by just identifying the type of service to inject:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: true; theme: Default" type="syntaxhighlighter"><![CDATA[ @Inject
+<pre class="brush: java; gutter: true; theme: Default" style="font-size:12px;"> @Inject
private ComponentEventResultProcessor processor;
-]]></script>
+</pre>
</div></div><p>Which results in the error: <strong>Service interface org.apache.tapestry5.services.ComponentEventResultProcessor is matched by 3 services: AjaxComponentEventResultProcessor, ComponentEventResultProcessor, ComponentInstanceResultProcessor. Automatic dependency resolution requires that exactly one service implement the interface.</strong></p><p>We need more information than just the service interface type in order to identify which of the three services to inject. One possibility is to inject with the correct service id:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: true; theme: Default" type="syntaxhighlighter"><![CDATA[ @InjectService("ComponentEventResultProcessor")
+<pre class="brush: java; gutter: true; theme: Default" style="font-size:12px;"> @InjectService("ComponentEventResultProcessor")
private ComponentEventResultProcessor processor;
-]]></script>
+</pre>
</div></div><p>This works ... but it is clumsy. If the service id, "ComponentEventResultProcessor", ever changes, this code will break. It's not <em>refactoring safe</em>.</p><p>Instead, we should use marker annotations. If we look at <code>TapestryModule</code>, where the ComponentEventResultProcessor service is defined, we'll see it identifies the necessary markers:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: true; theme: Default" type="syntaxhighlighter"><![CDATA[ @Marker(
+<pre class="brush: java; gutter: true; theme: Default" style="font-size:12px;"> @Marker(
{ Primary.class, Traditional.class })
public ComponentEventResultProcessor buildComponentEventResultProcessor(
Map<Class, ComponentEventResultProcessor> configuration)
{
return constructComponentEventResultProcessor(configuration);
}
-]]></script>
+</pre>
</div></div><p>When a service has marker annotations, the annotations present at the <em>point of injection</em> (the field, method parameter, or constructor parameter) are used to select a matching service. The list of services that match by type is then filtered to only include services that have all of the marker annotations present at the point of injection.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: true; theme: Default" type="syntaxhighlighter"><![CDATA[ @Inject
+<pre class="brush: java; gutter: true; theme: Default" style="font-size:12px;"> @Inject
@Traditional @Primary
private ComponentEventResultProcessor processor;
-]]></script>
+</pre>
</div></div><p>The two marker annotations, <code>@Traditional</code> and <code>@Primary</code>, ensure that only a single service matches.</p><h3 id="InjectionFAQ-What'sthedifferencebetween@Injectand@Environmental?">What's the difference between <code>@Inject</code> and <code>@Environmental</code>?</h3><p><code>@Inject</code> is relatively general; it can be used to inject resources specific to a page or component (such as ComponentResources, Logger, or Messages), or it can inject services or other objects obtained from the Tapestry IoC container. Once the page is loaded, the values for these injections never change.</p><p><code>@Environmental</code> is different; it exposes a request-scoped, dynamically bound value:</p><ul><li>"Request scoped": different threads (processing different requests) will see different values when reading the field.</li><li>"Dynamically bound": the value is explicitly placed into the Environment, and can be overridden at any time.</li></ul><p>Environmenta
ls are a form of loosely connected communication between an outer component (or even a service) and an inner component. Example: the Form component places a <code>FormSupport</code> object into the environment. Other components, such as TextField, use the <code>FormSupport</code> when rendering to perform functions such as allocate unique control names or register client-side validations. The TextField doesn't require that the Form component be the immediate container component, or even an ancestor: a Form on one page may, indirectly, communicate with a TextField on some entirely different page. Neither component directly links to the other, the <code>FormSupport</code> is the conduit that connects them.</p><p>The term "Environmental" was chosen as the value "comes from the environment".</p><h3 id="InjectionFAQ-Butwait...IseeIusedthe@Injectannotationanditstillworked.Whatgives?">But wait ... I see I used the <code>@Inject</code> annotation and it still worked. What gives?</h3><p>In c
ertain cases, Tapestry exposes a service (which can be injected) that is a proxy to the environmental; this is primarily for common environmentals, such as <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/services/javascript/JavaScriptSupport.html">JavaScriptSupport</a>, that may be needed outside of component classes. You can see this in TapestryModule:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>TapestryModule.java (partial)</b></div><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ /**
- * Builds a proxy to the current {@link JavaScriptSupport} inside this thread's {@link Environment}.
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"> /**
+ * Builds a proxy to the current {@link JavaScriptSupport} inside this thread's {@link Environment}.
*
* @since 5.2.0
*/
@@ -123,22 +125,14 @@ table.ScrollbarTable td.ScrollbarNextIco
{
return environmentalBuilder.build(JavaScriptSupport.class);
}
-]]></script>
+</pre>
</div></div><p>This kind of logic is based on the <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/services/EnvironmentalShadowBuilder.html">EnvironmentalShadowBuilder</a> service.</p><h3 id="InjectionFAQ-Ok,butRequestisasingletonservice,notanenvironmental,andIcaninjectthat.IsTapestryreallythreadsafe?">Ok, but Request is a singleton service, not an environmental, and I can inject that. Is Tapestry really thread safe?</h3><p>Yes, of course Tapestry is thread safe. The Request service is another special case, as seen in TapestryModule:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>TapestryModule.java (partial)</b></div><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ public Request buildRequest()
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"> public Request buildRequest()
{
- return shadowBuilder.build(requestGlobals, "request", Request.class);
+ return shadowBuilder.build(requestGlobals, "request", Request.class);
}
-]]></script>
-</div></div><p><a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/services/RequestGlobals.html">RequestGlobals</a> is a per-thread service. The Request service is a global singleton created by the <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/services/PropertyShadowBuilder.html">PropertyShadowBuilder</a> service, but is just a proxy. It has no internal state; invoking a method on the Request service just turns around and extracts the Request object from the per-thread RequestGlobals and invokes the same method there.</p><h3 id="InjectionFAQ-Iuse@Injectonafieldtoinjectaservice,butthefieldisstillnull,whathappened?">I use <code>@Inject</code> on a field to inject a service, but the field is still null, what happened?</h3><p>This can happen when you use the wrong <code>@Inject</code> annotation; for example, com.google.inject.Inject instead of org.apache.tapestry5.i
oc.annotations.Inject. This can occur when you have TestNG on the classpath, for example, and your IDE is too helpful. Double check your imports when things seem weird.</p><p>Also remember that <code>@Inject</code> on fields works for components and for service implementations or other objects that Tapestry instantiates, but not on arbitrary objects (that are created via Java's new keyword).</p><style type="text/css">/*<![CDATA[*/
-table.ScrollbarTable {border: none;padding: 3px;width: 100%;padding: 3px;margin: 0px;background-color: #f0f0f0}
-table.ScrollbarTable td.ScrollbarPrevIcon {text-align: center;width: 16px;border: none;}
-table.ScrollbarTable td.ScrollbarPrevName {text-align: left;border: none;}
-table.ScrollbarTable td.ScrollbarParent {text-align: center;border: none;}
-table.ScrollbarTable td.ScrollbarNextName {text-align: right;border: none;}
-table.ScrollbarTable td.ScrollbarNextIcon {text-align: center;width: 16px;border: none;}
-
-/*]]>*/</style><div class="Scrollbar"><table class="ScrollbarTable"><tr><td colspan="1" rowspan="1" class="ScrollbarPrevIcon"><a shape="rect" href="ajax-components-faq.html"><img align="middle" border="0" src="https://cwiki.apache.org/confluence/images/icons/back_16.gif" width="16" height="16"></a></td><td colspan="1" rowspan="1" class="ScrollbarPrevName" width="33%"><a shape="rect" href="ajax-components-faq.html">Ajax Components FAQ</a> </td><td colspan="1" rowspan="1" class="ScrollbarParent" width="33%"><sup><a shape="rect" href="frequently-asked-questions.html"><img align="middle" border="0" src="https://cwiki.apache.org/confluence/images/icons/up_16.gif" width="8" height="8"></a></sup><a shape="rect" href="frequently-asked-questions.html">Frequently Asked Questions</a></td><td colspan="1" rowspan="1" class="ScrollbarNextName" width="33%"> <a shape="rect" href="tapestry-inversion-of-control-faq.html">Tapestry Inversion of Control FAQ</a></td><td colspan="1" rowspan="1"
class="ScrollbarNextIcon"><a shape="rect" href="tapestry-inversion-of-control-faq.html"><img align="middle" border="0" src="https://cwiki.apache.org/confluence/images/icons/forwd_16.gif" width="16" height="16"></a></td></tr></table></div></div>
+</pre>
+</div></div><p><a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/services/RequestGlobals.html">RequestGlobals</a> is a per-thread service. The Request service is a global singleton created by the <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/services/PropertyShadowBuilder.html">PropertyShadowBuilder</a> service, but is just a proxy. It has no internal state; invoking a method on the Request service just turns around and extracts the Request object from the per-thread RequestGlobals and invokes the same method there.</p><h3 id="InjectionFAQ-Iuse@Injectonafieldtoinjectaservice,butthefieldisstillnull,whathappened?">I use <code>@Inject</code> on a field to inject a service, but the field is still null, what happened?</h3><p>This can happen when you use the wrong <code>@Inject</code> annotation; for example, com.google.inject.Inject instead of org.apache.tapestry5.i
oc.annotations.Inject. This can occur when you have TestNG on the classpath, for example, and your IDE is too helpful. Double check your imports when things seem weird.</p><p>Also remember that <code>@Inject</code> on fields works for components and for service implementations or other objects that Tapestry instantiates, but not on arbitrary objects (that are created via Java's new keyword).</p></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 19 21:21:27 2015
@@ -27,6 +27,16 @@
</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"/>
@@ -57,17 +67,9 @@
</div>
<div id="content">
-<div id="ConfluenceContent"><style type="text/css">/*<![CDATA[*/
-table.ScrollbarTable {border: none;padding: 3px;width: 100%;padding: 3px;margin: 0px;background-color: #f0f0f0}
-table.ScrollbarTable td.ScrollbarPrevIcon {text-align: center;width: 16px;border: none;}
-table.ScrollbarTable td.ScrollbarPrevName {text-align: left;border: none;}
-table.ScrollbarTable td.ScrollbarParent {text-align: center;border: none;}
-table.ScrollbarTable td.ScrollbarNextName {text-align: right;border: none;}
-table.ScrollbarTable td.ScrollbarNextIcon {text-align: center;width: 16px;border: none;}
-
-/*]]>*/</style><div class="Scrollbar"><table class="ScrollbarTable"><tr><td colspan="1" rowspan="1" class="ScrollbarPrevIcon"><a shape="rect" href="strategybuilder-service.html"><img align="middle" border="0" src="https://cwiki.apache.org/confluence/images/icons/back_16.gif" width="16" height="16"></a></td><td colspan="1" rowspan="1" class="ScrollbarPrevName" width="33%"><a shape="rect" href="strategybuilder-service.html">StrategyBuilder Service</a> </td><td colspan="1" rowspan="1" class="ScrollbarParent" width="33%"><sup><a shape="rect" href="ioc.html"><img align="middle" border="0" src="https://cwiki.apache.org/confluence/images/icons/up_16.gif" width="8" height="8"></a></sup><a shape="rect" href="ioc.html">IoC</a></td><td colspan="1" rowspan="1" class="ScrollbarNextName" width="33%"> <a shape="rect" href="object-providers.html">Object Providers</a></td><td colspan="1" rowspan="1" class="ScrollbarNextIcon"><a shape="rect" href="object-providers.html"><img align="middle"
border="0" src="https://cwiki.apache.org/confluence/images/icons/forwd_16.gif" width="16" height="16"></a></td></tr></table></div><h1 id="InjectioninDetail-InjectioninDetail">Injection in Detail</h1><div class="navmenu" style="float:right; background:#eee; margin:3px; padding:3px">
+<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">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class MyServiceImpl implements MyService, UpdateListener
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class MyServiceImpl implements MyService, UpdateListener
{
@PostInjection
public void registerAsListener(UpdateListenerHub hub)
@@ -75,7 +77,7 @@ table.ScrollbarTable td.ScrollbarNextIco
hub.addUpdateListener(this);
}
}
-]]></script>
+</pre>
</div></div><h1 id="InjectioninDetail-ComponentInjection">Component Injection</h1><p>Inside Tapestry components, injection occurs exclusively on <em>fields</em> and is always triggered by the @Inject (or @InjectService) annotation.</p><p>Component field injection is very similar to IoC layer, but with a different set of injectable resources.</p><p>Injection is the responsibility of the <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/services/InjectionProvider.html">InjectionProvider</a> service, which is a chain-of-command across a number of implementations.</p><h2 id="InjectioninDetail-BlockInjectionProvider">Block InjectionProvider</h2><p>Checks if the field type is Block. If so, determines the block id to inject (either from the field name, or from an @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Id.html">Id</a> annotation, if present).</p><h2 id=
"InjectioninDetail-DefaultInjectionProvider">Default InjectionProvider</h2><p>Uses the MasterObjectProvider service to provide the injectable value. The Service Lookup stage is skipped.</p><h2 id="InjectioninDetail-ComponentResourcesInjectionProvider">ComponentResources InjectionProvider</h2><p>Injects fields of type ComponentResources.</p><h2 id="InjectioninDetail-CommonResourcesInjectionProvider">CommonResources InjectionProvider</h2><p>Injects fields with common resources:</p><ul><li>String: the components' complete id</li><li>org.slf4j.Logger: Logger for the component (based on component class name)</li><li>Locale: locale for the containing page (page locale is immutable)</li><li>Messages: Component's message catalog</li><li>ComponentResourceSelector: selector for the containing page (selector is immutable)</li></ul>
<div class="confluence-information-macro confluence-information-macro-information"><p class="title">Added in 5.3</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
Modified: websites/production/tapestry/content/injection.html
==============================================================================
--- websites/production/tapestry/content/injection.html (original)
+++ websites/production/tapestry/content/injection.html Sun Jul 19 21:21:27 2015
@@ -27,6 +27,16 @@
</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"/>
@@ -89,23 +99,23 @@
<h3 id="Injection-BlockInjection">Block Injection</h3>
-<p>For field type <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/Block.html">Block</a>, the value of the Inject annotation is the id of the <a shape="rect" href="component-templates.html#ComponentTemplates-block"><t:block></a> element within the component's template. Normally, the id of the block is determined from the field name (after stripping out any leading "_" and "$" characters):</p>
+<p>For field type <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/Block.html">Block</a>, the value of the Inject annotation is the id of the <a shape="rect" href="component-templates.html"><t:block></a> element within the component's template. Normally, the id of the block is determined from the field name (after stripping out any leading "_" and "$" characters):</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
@Inject
private Block foo;
-]]></script>
+</pre>
</div></div>
<p>Where that is not appropriate, an @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Id.html">Id</a> annotation can be supplied:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
@Inject
-@Id("bar")
+@Id("bar")
private Block barBlock;
-]]></script>
+</pre>
</div></div>
<p>The first injection will inject the Block with id "foo" (as always, case is ignored). The second injection will inject the Block with id "bar".</p>
@@ -117,10 +127,10 @@ private Block barBlock;
<p>A very common example occurs when a component needs access to its <a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ComponentResources.html">resources</a>. The component can define a field of the appropriate type and use the <code>@Inject</code> annotation without a value:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
@Inject
private ComponentResources resources;
-]]></script>
+</pre>
</div></div>
<p>Tapestry uses the type of the field, ComponentResources, to determine what to inject into this field.</p>
@@ -139,7 +149,7 @@ private ComponentResources resources;
<ul><li><strong>org.apache.tapestry5.ComponentResources</strong> – The resources for the component, often used to generate links related to the component.</li></ul>
-<ul><li><strong>org.apache.tapestry5.ioc.Messages</strong> – The component message catalog for the component, from which <a shape="rect" href="#Injection-localization.html">localized</a> messages can be generated.</li></ul>
+<ul><li><strong>org.apache.tapestry5.ioc.Messages</strong> – The component message catalog for the component, from which <a shape="rect" href="injection.html">localized</a> messages can be generated.</li></ul>
<h3 id="Injection-AssetInjection">Asset Injection</h3>
@@ -149,11 +159,11 @@ private ComponentResources resources;
<p>When the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Path.html">Path</a> annotation is also present, then the injected value (relative to the component) will be a localized asset.</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
@Inject
-@Path("context:images/top_banner.png")
+@Path("context:images/top_banner.png")
private Asset banner;
-]]></script>
+</pre>
</div></div>
<p>Symbols in the annotation value are expanded.</p>
@@ -163,10 +173,10 @@ private Asset banner;
<p>Here, a custom EmployeeService service is injected, but any custom or built-in service may be injected in the same way. </p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
@Inject
private EmployeeService employeeService;
-]]></script>
+</pre>
</div></div>
<p>A large number of services are provided by Tapestry. See the following packages:</p>
@@ -193,11 +203,11 @@ private EmployeeService employeeService;
<p>Here, a specific object is requested. A @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/annotations/Service.html">Service</a> annotation is used to identify the service name.</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
@Inject
-@Service("Request")
+@Service("Request")
private Request request;
-]]></script>
+</pre>
</div></div>
<p>This is generally not necessary; you should always be able to identify the service to be injected just by type, not by explicit id. Explicit ids have the disadvantage of not being refactoring-safe: this won't happen with the Request service, but perhaps in your own code ... if you rename the service interface and rename the service id to match, your existing injections using the explicit service id will break.</p>
Modified: websites/production/tapestry/content/integrating-with-jpa.html
==============================================================================
--- websites/production/tapestry/content/integrating-with-jpa.html (original)
+++ websites/production/tapestry/content/integrating-with-jpa.html Sun Jul 19 21:21:27 2015
@@ -27,6 +27,15 @@
</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 type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
<link href="/styles/style.css" rel="stylesheet" type="text/css"/>
@@ -62,49 +71,60 @@
<div class="confluence-information-macro confluence-information-macro-information"><p class="title">Added in 5.3</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body">
</div></div>
<div style="border-right: 20px solid #D8E4F1;border-left: 20px solid #D8E4F1;">
-<p> </p></div><p>Starting with Tapestry 5.3, Tapestry provides built-in integration with the Java Persistence API (JPA). This module supersedes <a shape="rect" class="external-link" href="http://tynamo.org/tapestry-jpa+guide" >Tynamo's JPA integration</a>.</p><p><strong>Contents</strong></p><p></p><div class="toc-macro client-side-toc-macro" data-headerelements="H1,H2,H3" data-structure="list"></div><h1 id="IntegratingwithJPA-ConfiguringJPA">Configuring JPA</h1><p>The persistence.xml file is the standard configuration file in JPA used to define the persistence units. Tapestry reads this file to create the <a shape="rect" class="external-link" href="http://download.oracle.com/javaee/6/api/javax/persistence/EntityManagerFactory.html" >EntityManagerFactory</a>. The following example demonstrates a persistence.xml file.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
-<persistence xmlns="http://java.sun.com/xml/ns/persistence" version="2.0">
- <persistence-unit name="DemoUnit" transaction-type="RESOURCE_LOCAL">
+<p> </p></div><p>Starting with Tapestry 5.3, Tapestry provides built-in integration with the Java Persistence API (JPA). This module supersedes <a shape="rect" class="external-link" href="http://tynamo.org/tapestry-jpa+guide" >Tynamo's JPA integration</a>.</p><p><strong>Contents</strong></p><p><style type="text/css">/*<![CDATA[*/
+div.rbtoc1437340849738 {padding: 0px;}
+div.rbtoc1437340849738 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1437340849738 li {margin-left: 0px;padding-left: 0px;}
+
+/*]]>*/</style></p><div class="toc-macro rbtoc1437340849738">
+<ul class="toc-indentation"><li><a shape="rect" href="#IntegratingwithJPA-ConfiguringJPA">Configuring JPA</a>
+<ul class="toc-indentation"><li><a shape="rect" href="#IntegratingwithJPA-XML-lessJPAconfiguration">XML-less JPA configuration</a></li><li><a shape="rect" href="#IntegratingwithJPA-Automaticallyaddingmanagedclasses">Automatically adding managed classes</a></li></ul>
+</li><li><a shape="rect" href="#IntegratingwithJPA-InjectingtheEntityManager">Injecting the EntityManager</a>
+<ul class="toc-indentation"><li><a shape="rect" href="#IntegratingwithJPA-InjectingtheEntityManagerintopageandcomponentclasses">Injecting the EntityManager into page and component classes</a></li><li><a shape="rect" href="#IntegratingwithJPA-InjectingEntityManagerintoservices">Injecting EntityManager into services</a></li></ul>
+</li><li><a shape="rect" href="#IntegratingwithJPA-Transactionmanagement">Transaction management</a></li></ul>
+</div><h1 id="IntegratingwithJPA-ConfiguringJPA">Configuring JPA</h1><p>The persistence.xml file is the standard configuration file in JPA used to define the persistence units. Tapestry reads this file to create the <a shape="rect" class="external-link" href="http://download.oracle.com/javaee/6/api/javax/persistence/EntityManagerFactory.html" >EntityManagerFactory</a>. The following example demonstrates a persistence.xml file.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><?xml version="1.0" encoding="UTF-8"?>
+<persistence xmlns="http://java.sun.com/xml/ns/persistence" version="2.0">
+ <persistence-unit name="DemoUnit" transaction-type="RESOURCE_LOCAL">
<properties>
- <property name="javax.persistence.jdbc.driver" value="org.h2.Driver" />
- <property name="javax.persistence.jdbc.url" value="jdbc:h2:mem:test" />
- <property name="javax.persistence.jdbc.user" value="sa" />
- <property name="eclipselink.ddl-generation" value="create-tables"/>
- <property name="eclipselink.logging.level" value="fine"/>
+ <property name="javax.persistence.jdbc.driver" value="org.h2.Driver" />
+ <property name="javax.persistence.jdbc.url" value="jdbc:h2:mem:test" />
+ <property name="javax.persistence.jdbc.user" value="sa" />
+ <property name="eclipselink.ddl-generation" value="create-tables"/>
+ <property name="eclipselink.logging.level" value="fine"/>
</properties>
</persistence-unit>
-</persistence>]]></script>
+</persistence></pre>
</div></div><p>By default, the persistence descriptor is named <em>persistence.xml</em> and is expected to be located on the classpath in the <em>META-INF</em> directory. If you want to place the <em>persistence.xml</em> file in another directory or name it differently, you can make a contribution to the <em>SymbolProvider</em> service, as shown in the following example. This is a quite useful feature if you want to use a different persistence descriptor for tests.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class AppModule {
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class AppModule {
@Contribute(SymbolProvider.class)
@FactoryDefaults
public static void provideFactoryDefaults(final MappedConfiguration<String, String> configuration) {
- configuration.add(JpaSymbols.PERSISTENCE_DESCRIPTOR, "/org/example/persistence.xml");
+ configuration.add(JpaSymbols.PERSISTENCE_DESCRIPTOR, "/org/example/persistence.xml");
}
-}]]></script>
+}</pre>
</div></div><h2 id="IntegratingwithJPA-XML-lessJPAconfiguration">XML-less JPA configuration</h2><p>With Tapestry, configuring JPA is much simpler than as described in the JPA specification. Tapestry allows you to configure the <a shape="rect" class="external-link" href="http://download.oracle.com/javaee/6/api/javax/persistence/EntityManagerFactory.html" >EntityManagerFactory</a> programmatically, without writing any XML. Imagine you want to use JDBC connections managed by the container and provided through JNDI. The resulting persistence descriptor might look like this:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
-<persistence xmlns="http://java.sun.com/xml/ns/persistence"
- version="2.0">
- <persistence-unit name="JTAUnit" transaction-type="RESOURCE_LOCAL">
+<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><?xml version="1.0" encoding="UTF-8"?>
+<persistence xmlns="http://java.sun.com/xml/ns/persistence"
+ version="2.0">
+ <persistence-unit name="JTAUnit" transaction-type="RESOURCE_LOCAL">
<non-jta-data-source>
jdbc/JPATest
</non-jta-data-source>
<properties>
- <property name="eclipselink.ddl-generation" value="create-tables"/>
- <property name="eclipselink.logging.level" value="fine"/>
+ <property name="eclipselink.ddl-generation" value="create-tables"/>
+ <property name="eclipselink.logging.level" value="fine"/>
</properties>
</persistence-unit>
-</persistence>]]></script>
+</persistence></pre>
</div></div><p>Now let's see how to provide the same configuration <em>without</em> XML. The following demonstrates an equivalent JPA configuration.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class AppModule {
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class AppModule {
@Contribute(EntityManagerSource.class)
public static void configurePersistenceUnitInfos(MappedConfiguration<String,PersistenceUnitConfigurer> cfg) {
@@ -113,27 +133,27 @@
public void configure(TapestryPersistenceUnitInfo unitInfo) {
- unitInfo.nonJtaDataSource("jdbc/JPATest")
- .addProperty("eclipselink.ddl-generation", "create-tables")
- .addProperty("eclipselink.logging.level", "fine");
+ unitInfo.nonJtaDataSource("jdbc/JPATest")
+ .addProperty("eclipselink.ddl-generation", "create-tables")
+ .addProperty("eclipselink.logging.level", "fine");
}
};
- cfg.add("JTAUnit", configurer);
+ cfg.add("JTAUnit", configurer);
}
-}]]></script>
+}</pre>
</div></div><p>In the example above you can see a contribution to the <em>EntityManagerSource</em> service. This service is responsible for creating the <a shape="rect" class="external-link" href="http://download.oracle.com/javaee/6/api/javax/persistence/EntityManagerFactory.html" >EntityManagerFactory</a> to be used to create <a shape="rect" class="external-link" href="http://download.oracle.com/javaee/6/api/javax/persistence/EntityManager.html" >EntityManager</a>. When the service is initialized, it parses the <em>persistence.xml</em> file, if available. For any persistence unit defined in the XML descriptor a <em>TapestryPersistenceUnitInfo</em> object is created. The <em>TapestryPersistenceUnitInfo</em> interface is a mutable extension of the <a shape="rect" class="external-link" href="http://download.oracle.com/javaee/6/api/javax/persistence/spi/PersistenceUnitInfo.html" >PersistenceUnitInfo</a> interface (defined in the JPA specification) that allows you to configure a persist
ence unit programmatically.</p><p>After parsing the persistence descriptor, the EntityManagerSource service applies its configuration to create further persistence units and/or update the existing ones. The service’s configuration is a map in which persistence unit names are associated with <em>PersistenceUnitConfigurer</em> instances. A PersistenceUnitConfigurer is used to configure a persistence unit programmatically that has been associated with it. In the example above you can see a contribution providing a PersistenceUnitConfigurer for the unit named <em>JTAUnit</em>.</p><div class="confluence-information-macro confluence-information-macro-information"><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>Note that the TapestryPersistenceUnitInfo instance passed to the PersistenceUnitConfigurer is either empty or my contain the persistence unit metadata read from the persistence.x
ml file. What happens if you contribute a PersistenceUnitConfigurer for a persistence unit that has not been defined in the persistence.xml file? In this case Tapestry assumes that you want to configure the persistence unit programmatically and just creates a fresh <em>TapestryPersistenceUnitInfo</em> object and passes it to the <em>PersistenceUnitConfigurer</em>.</p></div></div><h2 id="IntegratingwithJPA-Automaticallyaddingmanagedclasses">Automatically adding managed classes</h2><p>If only a single persistence unit is defined, Tapestry scans the <em>application-root-package.entities</em> package. The classes in that package are automatically added as managed classes to the defined persistence unit.</p><p>If you have additional packages containing entities, you may contribute them to the <em>JpaEntityPackageManager</em> service configuration.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class AppModule {
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class AppModule {
@Contribute(JpaEntityPackageManager.class)
public static void providePackages(Configuration<String> configuration) {
- configuration.add("org.example.myapp.domain");
- configuration.add("com.acme.model");
+ configuration.add("org.example.myapp.domain");
+ configuration.add("com.acme.model");
}
-}]]></script>
+}</pre>
</div></div><p>As you can see, you may add as many packages as you wish.</p><h1 id="IntegratingwithJPA-InjectingtheEntityManager">Injecting the EntityManager</h1><p>The created entity managers can be injected into page, component and other services.</p><h2 id="IntegratingwithJPA-InjectingtheEntityManagerintopageandcomponentclasses">Injecting the EntityManager into page and component classes</h2><p>Depending on whether more than one persistence unit has been defined, the way to inject <a shape="rect" class="external-link" href="http://download.oracle.com/javaee/6/api/javax/persistence/EntityManager.html" >EntityManager</a> varies slightly. Let’s start with a simple scenario, where only a single persistence unit is defined. In this case, an EntityManager can be injected using the @Inject annotation.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class CreateAddress {
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class CreateAddress {
@Inject
private EntityManager entityManager;
@@ -145,9 +165,9 @@
void onSuccess() {
entityManager.persist(address);
}
-}]]></script>
+}</pre>
</div></div><p>Alternatively, you can use the @<a shape="rect" class="external-link" href="http://download.oracle.com/javaee/6/api/javax/persistence/PersistenceContext.html" >PersistenceContext</a> annotation to get the EntityManager injected into a page or component, as shown in the following example.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class CreateAddress {
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class CreateAddress {
@PersistenceContext
private EntityManager entityManager;
@@ -159,31 +179,31 @@
void onSuccess() {
entityManager.persist(address);
}
-}]]></script>
+}</pre>
</div></div><p>If you have multiple instances of persistence-unit defined in the same application, you need to explicitly tell Tapestry which persistence unit you want to get injected. This is what the @PersistenceContext annotation’s <em>name</em> attribute is used for? The following example demonstrates how to inject the persistence unit named <em>DemoUnit</em>.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class CreateAddress {
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class CreateAddress {
- @PersistenceContext(unitName = "DemoUnit")
+ @PersistenceContext(unitName = "DemoUnit")
private EntityManager entityManager;
@Property
private Address address;
@CommitAfter
- @PersistenceContext(unitName = "DemoUnit")
+ @PersistenceContext(unitName = "DemoUnit")
void onSuccess() {
entityManager.persist(address);
}
-}]]></script>
+}</pre>
</div></div><h2 id="IntegratingwithJPA-InjectingEntityManagerintoservices">Injecting EntityManager into services</h2><p>While component injection occurs only on fields, the injection in the IoC layer may be triggered by a field or a constructor. The following example demonstrates field injection, when a single persistence unit is defined in the persistence descriptor.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class UserDAOImpl implements UserDAO {
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class UserDAOImpl implements UserDAO {
@Inject
private EntityManager entityManager;
...
-}]]></script>
+}</pre>
</div></div><p>The constructor injection is demonstrated in the following example.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class UserDAOImpl implements UserDAO {
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class UserDAOImpl implements UserDAO {
private EntityManager entityManager;
@@ -192,39 +212,39 @@
}
...
-}]]></script>
+}</pre>
</div></div><p>If multiple persistence units are defined in the same application, you need to disambiguate the unit to inject. This is done with the <a shape="rect" class="external-link" href="http://download.oracle.com/javaee/6/api/javax/persistence/PersistenceContext.html" >@PersistenceContext</a> annotation, as shown in the following example. Because @PersistenceContext must not be placed on constructor parameters, you can’t use constructor injection and must switch to field injection.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class UserDAOImpl implements UserDAO {
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class UserDAOImpl implements UserDAO {
@Inject
- @PersistenceContext(unitName = "DemoUnit")
+ @PersistenceContext(unitName = "DemoUnit")
private EntityManager entityManager;
...
-}]]></script>
+}</pre>
</div></div><h1 id="IntegratingwithJPA-Transactionmanagement">Transaction management</h1><p>As you may already know from the Hibernate integration library, Tapestry automatically manages transactions for you. The JPA integration library defines the @CommitAfter annotation, which acts as the correspondent annotation from the Hibernate integration library. Let’s explore the <em>UserDAO</em> interface to see the annotation in action.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public interface UserDAO {
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public interface UserDAO {
@CommitAfter
- @PersistenceContext(unitName = "DemoUnit")
+ @PersistenceContext(unitName = "DemoUnit")
void add(User user);
List<User> findAll();
@CommitAfter
- @PersistenceContext(unitName = "DemoUnit")
+ @PersistenceContext(unitName = "DemoUnit")
void delete(User... users);
-}]]></script>
+}</pre>
</div></div><p>As you can see, the annotation may be placed on service method in order to mark that method as transactional. Any method marked with the @CommitAfter annotation will have a transaction started before, and committed after, it is called. Runtime exceptions thrown by by a transactional method will abort the transaction. Checked exceptions are ignored and the transaction will be committed anyway.</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>Note that <a shape="rect" class="external-link" href="http://download.oracle.com/javaee/6/api/javax/persistence/EntityTransaction.html" >EntityTransaction</a> interface does not support two phase commits. Committing transactions of multiple EntityManagers in the same request might result in data consistency issues. That’s why @CommitAfter annotatio
n must be accompanied by the @PersistenceContext annotation if multiple persistence unit are defined in an application. This way you can only commit the transaction of a single persistence unit. You should be very carefully, if you are committing multiple transactions manually in the same request.</p></div></div><p>After placing the @CommitAfter annotation on methods, you need to tell Tapestry to advise those methods. This is accomplished by adding the transaction advice, as shown in the following example.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class AppModule {
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class AppModule {
- @Match("*DAO")
+ @Match("*DAO")
public static void adviseTransactionally(
JpaTransactionAdvisor advisor,
MethodAdviceReceiver receiver) {
advisor.addTransactionCommitAdvice(receiver);
}
-}]]></script>
+}</pre>
</div></div></div>
</div>
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 19 21:21:27 2015
@@ -27,6 +27,16 @@
</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"/>
@@ -58,32 +68,41 @@
<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></p><div class="toc-macro client-side-toc-macro" data-headerelements="H1,H2,H3" data-structure="list"></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">
-<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ <dependency>
+<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;}
+
+/*]]>*/</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>
+<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">
+<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"> <dependency>
<groupId>org.apache.tapestry</groupId>
<artifactId>tapestry-spring</artifactId>
<version>[your-tapestry-version]</version>
</dependency>
-]]></script>
+</pre>
</div></div><h3 id="IntegratingwithSpringFramework-Updateyourweb.xmlfile">Update your web.xml file</h3><p>The short form is that you must make two small changes to your application's web.xml.</p><p>First, a special filter is used in replace of the standard TapestryFilter:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ <filter>
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"> <filter>
<filter-name>app</filter-name>
<!-- Special filter that adds in a T5 IoC module derived from the Spring WebApplicationContext. -->
<filter-class>org.apache.tapestry5.spring.TapestrySpringFilter</filter-class>
- </filter>]]></script>
+ </filter></pre>
</div></div><p>Secondly, you may add the normal Spring configuration, consisting of an optional <context-param> identifying which Spring bean configuration file(s) to load:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<context-param>
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"><context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/daoContext.xml /WEB-INF/applicationContext.xml</param-value>
</context-param>
-]]></script>
+</pre>
</div></div><p>The <context-param> lists the Spring bean configuration file. It is optional and defaults to just /WEB-INF/applicationContext.xml if omitted.</p><h3 id="IntegratingwithSpringFramework-AccessingtheSpringApplicationContext">Accessing the Spring Application Context</h3><p>By integrating Spring in Tapestry, you get full access on Spring ApplicationContext as if you were accessing to any Tapestry service. Simply @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Inject.html">Inject</a> into your pages and components.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ @Inject
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"> @Inject
private ApplicationContext springContext;
-]]></script>
+</pre>
</div></div><h3 id="IntegratingwithSpringFramework-Injectingbeans">Injecting beans</h3><p>Inside your component classes, you may use the @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Inject.html">Inject</a> annotation. Typically, just adding @<a shape="rect" class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Inject.html">Inject</a> to the field type is sufficient to identify the Spring bean to inject:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ @Inject
- private UserDAO userDAO;]]></script>
+<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"> @Inject
+ private UserDAO userDAO;</pre>
</div></div><p>Searching for Spring beans is threaded into the <a shape="rect" href="injection.html">MasterObjectProvider service</a>. The Spring context becomes one more place that Tapestry searches when determining the injection for a injected field or method parameter.</p><h3 id="IntegratingwithSpringFramework-InjectingTapestryservicesinSpringbeans">Injecting Tapestry services in Spring beans</h3>
<div class="confluence-information-macro confluence-information-macro-information"><p class="title">Added in 5.2</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body">