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 Mon Apr 10 10:21:38 2017 @@ -44,13 +44,26 @@ <div class="wrapper bs"> - <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div></div> + <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div> + +</div> <div id="top"> - <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span><form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> - <input type="text" name="q"> - <input type="submit" value="Search"> -</form></div><div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div><div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">Injection in Detail</h1></div></div> + <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span> +<form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> + <input type="text" name="q"> + <input type="submit" value="Search"> +</form> + +</div> + + +<div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div> + + +<div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">Injection in Detail</h1></div> + +</div> <div class="clearer"></div> </div> @@ -62,25 +75,49 @@ </div> <div id="content"> - <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 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 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 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 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-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 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 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 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 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="confluence-information- macro-body"><p>Injection of resources into fields is triggered by the presence of the @<a 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 class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annot ations/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 Ta pestry's extensibility comes into play. MasterObjectProvider is a service, with a configuration of <a 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 proc ess, 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 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 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 class="external-link" href="ht tp://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 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 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 class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/t apestry5/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 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 Servic eOverride provider.</p><h3 id="InjectioninDetail-AssetObjectProvider(tapestry-core)">Asset ObjectProvider (tapestry-core)</h3><p>Checks for the @<a 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 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-inform ation-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>o ne</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 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 additio nal 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 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 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 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 annotatio n.</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>Th e 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 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 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 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 class="external-link" href="http://tapestry.apache.org/current/apido cs/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="confluence-information-macro-body"><p>Injection of resources into fields is triggered by the presence of the @<a 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 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 co mes into play. MasterObjectProvider is a service, with a configuration of <a 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 MasterObje ctProvider 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 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 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 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 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 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 class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/services/Ser viceOverride.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 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><h 3 id="InjectioninDetail-AssetObjectProvider(tapestry-core)">Asset ObjectProvider (tapestry-core)</h3><p>Checks for the @<a 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 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-in formation-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 t he 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 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 regist erring 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 @@ -94,7 +131,9 @@ <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>ComponentResourceSelector is new as of release 5.3. It encapsulates a locale plus additional application-specific data used for skinning and/or themeing.</p></div><h2 id="InjectioninDetail-AssetInjectionProvider">Asset InjectionProvider</h2><p>Triggered by the @Path annotation: the Path value has symbols expanded, and is then converted to an Asset.</p><h2 id="InjectioninDetail-ServiceInjectionProvider">Service InjectionProvider</h2><p>Equivalent to the Service Lookup phase in an IoC layer injection.</p><h1 id="InjectioninDetail-@InjectServiceinComponents">@InjectService in Components</h1><p>You may use the @<a class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/InjectService.html";>InjectService</a> annotation on component fields.</p><p></p></div> +<div class="error"><span class="error">Unknown macro: {div}</span> +<p>ComponentResourceSelector is new as of release 5.3. It encapsulates a locale plus additional application-specific data used for skinning and/or themeing.</p> +</div><h2 id="InjectioninDetail-AssetInjectionProvider">Asset InjectionProvider</h2><p>Triggered by the @Path annotation: the Path value has symbols expanded, and is then converted to an Asset.</p><h2 id="InjectioninDetail-ServiceInjectionProvider">Service InjectionProvider</h2><p>Equivalent to the Service Lookup phase in an IoC layer injection.</p><h1 id="InjectioninDetail-@InjectServiceinComponents">@InjectService in Components</h1><p>You may use the @<a class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/InjectService.html";>InjectService</a> annotation on component fields.</p><p></p></div> </div> <div class="clearer"></div>
Modified: websites/production/tapestry/content/injection.html ============================================================================== --- websites/production/tapestry/content/injection.html (original) +++ websites/production/tapestry/content/injection.html Mon Apr 10 10:21:38 2017 @@ -46,13 +46,26 @@ <div class="wrapper bs"> - <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div></div> + <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div> + +</div> <div id="top"> - <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span><form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> - <input type="text" name="q"> - <input type="submit" value="Search"> -</form></div><div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div><div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">Injection</h1></div></div> + <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span> +<form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> + <input type="text" name="q"> + <input type="submit" value="Search"> +</form> + +</div> + + +<div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div> + + +<div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">Injection</h1></div> + +</div> <div class="clearer"></div> </div> @@ -64,25 +77,49 @@ </div> <div id="content"> - <div id="ConfluenceContent"><p><strong>Injection</strong> is Tapestry's way of making a dependency – such as a resource, asset, component, block or service – available in a page, component, mixin or service class.</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 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 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 href="injection.html">Injection</a> - </div> </li></ul></div><p>Injection is a key concept in Tapestry, and it is used in several different but related ways.</p><h2 id="Injection-InjectioninTapestryIOCServices">Injection in Tapestry IOC Services</h2><p>Main Article: <a href="tapestry-ioc-overview.html">Tapestry IoC Overview</a></p><p>The Tapestry IoC container makes use of injection primarily through constructors and via parameters to service builder methods.</p><h2 id="Injection-InjectioninComponentClasses">Injection in Component Classes</h2><p>For components, however, Tapestry takes a completely different tack: injection directly into component fields.</p><p>The @<a class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Inject.html";>Inject</a> annotation is used to identify fields that will contain injected services and other resources.</p><p>Tapestry allows for two kinds of injection:</p><ul><li><strong>Default injection</strong>, where Tapestry determines the object to inject into the field based on its type.</li><li><strong>Explicit injection</strong>, where the particular service to be injected is specified.</li></ul><p>In both cases, the field is transformed into a read only value. As elsewhere in Tapestry, this transformation occurs at runtime (which is very important in terms of being able to test your components). Attempting to update an injected field will result in a runtime exception.</p><p>In addition, there are a few special cases that are triggered by specific field types, or additional annotations, in addition, to @Inject, on a field.</p><h3 id="Injection-BlockInjection">Block Injection</h3><p>For field type <a 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 href="component-templates.html"><t:block></a> element within the component's template. Normally, the id of the block is determined from the f ield name (after stripping out any leading "_" and "$" characters):</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> + <div id="ConfluenceContent"><p><strong>Injection</strong> is Tapestry's way of making a dependency – such as a resource, asset, component, block or service – available in a page, component, mixin or service class.</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 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 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 href="injection.html">Injection</a> + + + </div> + </li></ul> +</div> + + +<p>Injection is a key concept in Tapestry, and it is used in several different but related ways.</p><h2 id="Injection-InjectioninTapestryIOCServices">Injection in Tapestry IOC Services</h2><p>Main Article: <a href="tapestry-ioc-overview.html">Tapestry IoC Overview</a></p><p>The Tapestry IoC container makes use of injection primarily through constructors and via parameters to service builder methods.</p><h2 id="Injection-InjectioninComponentClasses">Injection in Component Classes</h2><p>For components, however, Tapestry takes a completely different tack: injection directly into component fields.</p><p>The @<a class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Inject.html";>Inject</a> annotation is used to identify fields that will contain injected services and other resources.</p><p>Tapestry allows for two kinds of injection:</p><ul><li><strong>Default injection</strong>, where Tapestry determines the object to inject into the field based on its type.</li><li><strong>Explicit injection</strong>, where the particular service to be injected is specified.</li></ul><p>In both cases, the field is transformed into a read only value. As elsewhere in Tapestry, this transformation occurs at runtime (which is very important in terms of being able to test your components). Attempting to update an injected field will result in a runtime exception.</p><p>In addition, there are a few special cases that are triggered by specific field types, or additional annotations, in addition, to @Inject, on a field.</p><h3 id="Injection-BlockInjection">Block Injection</h3><p>For field type <a 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 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 strippin g out any leading "_" and "$" characters):</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;">@Inject private Block foo; </pre> 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 Mon Apr 10 10:21:38 2017 @@ -45,13 +45,26 @@ <div class="wrapper bs"> - <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div></div> + <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div> + +</div> <div id="top"> - <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span><form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> - <input type="text" name="q"> - <input type="submit" value="Search"> -</form></div><div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div><div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">Integrating with JPA</h1></div></div> + <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span> +<form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> + <input type="text" name="q"> + <input type="submit" value="Search"> +</form> + +</div> + + +<div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div> + + +<div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">Integrating with JPA</h1></div> + +</div> <div class="clearer"></div> </div> @@ -67,12 +80,13 @@ <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>Tapestry provides a built-in integration with the Java Persistence API (JPA) through the <strong>Tapestry-jpa</strong> module. This module supersedes the 3rd-party <a class="external-link" href="http://www.tynamo.org/tapestry-jpa+guide/"; rel="nofollow">Tynamo JPA module</a>.</p><p><strong>Contents</strong></p><p><style type="text/css">/*<![CDATA[*/ -div.rbtoc1479914391647 {padding: 0px;} -div.rbtoc1479914391647 ul {list-style: disc;margin-left: 0px;} -div.rbtoc1479914391647 li {margin-left: 0px;padding-left: 0px;} +<div class="error"><span class="error">Unknown macro: {div}</span> +<p> </p></div><p>Tapestry provides a built-in integration with the Java Persistence API (JPA) through the <strong>Tapestry-jpa</strong> module. This module supersedes the 3rd-party <a class="external-link" href="http://www.tynamo.org/tapestry-jpa+guide/"; rel="nofollow">Tynamo JPA module</a>.</p><p><strong>Contents</strong></p><p><style type="text/css">/*<![CDATA[*/ +div.rbtoc1491819660710 {padding: 0px;} +div.rbtoc1491819660710 ul {list-style: disc;margin-left: 0px;} +div.rbtoc1491819660710 li {margin-left: 0px;padding-left: 0px;} -/*]]>*/</style></p><div class="toc-macro rbtoc1479914391647"> +/*]]>*/</style></p><div class="toc-macro rbtoc1491819660710"> <ul class="toc-indentation"><li><a href="#IntegratingwithJPA-Downloading">Downloading</a> <ul class="toc-indentation"><li><a href="#IntegratingwithJPA-SelectingaJPAImplementation">Selecting a JPA Implementation</a></li></ul> </li><li><a href="#IntegratingwithJPA-ConfiguringJPA">Configuring JPA</a> 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 Mon Apr 10 10:21:38 2017 @@ -45,13 +45,26 @@ <div class="wrapper bs"> - <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div></div> + <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div> + +</div> <div id="top"> - <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span><form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> - <input type="text" name="q"> - <input type="submit" value="Search"> -</form></div><div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div><div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">Integrating with Spring Framework</h1></div></div> + <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span> +<form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> + <input type="text" name="q"> + <input type="submit" value="Search"> +</form> + +</div> + + +<div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div> + + +<div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">Integrating with Spring Framework</h1></div> + +</div> <div class="clearer"></div> </div> @@ -63,24 +76,45 @@ </div> <div id="content"> - <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"><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 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 href="security.html">Security</a> - </div> </li></ul></div><p>For integrating Spring Security into your application, see <a href="security.html">Security</a>.</p><p><strong>Contents</strong></p><p><style type="text/css">/*<![CDATA[*/ -div.rbtoc1478607584645 {padding: 0px;} -div.rbtoc1478607584645 ul {list-style: disc;margin-left: 0px;} -div.rbtoc1478607584645 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 rbtoc1478607584645"> + + +<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 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 href="security.html">Security</a> + + + </div> + </li></ul> +</div> + + +<p>For integrating Spring Security into your application, see <a href="security.html">Security</a>.</p><p><strong>Contents</strong></p><p><style type="text/css">/*<![CDATA[*/ +div.rbtoc1491819649664 {padding: 0px;} +div.rbtoc1491819649664 ul {list-style: disc;margin-left: 0px;} +div.rbtoc1491819649664 li {margin-left: 0px;padding-left: 0px;} + +/*]]>*/</style></p><div class="toc-macro rbtoc1491819649664"> <ul class="toc-indentation"><li>Related Articles</li></ul> <ul><li><a href="#IntegratingwithSpringFramework-SpringVersion">Spring Version</a></li><li><a href="#IntegratingwithSpringFramework-Usage">Usage</a> <ul class="toc-indentation"><li><a href="#IntegratingwithSpringFramework-Requireddependency">Required dependency</a></li><li><a href="#IntegratingwithSpringFramework-Updateyourweb.xmlfile">Update your web.xml file</a></li><li><a href="#IntegratingwithSpringFramework-AccessingtheSpringApplicationContext">Accessing the Spring Application Context</a></li><li><a href="#IntegratingwithSpringFramework-Injectingbeans">Injecting beans</a></li><li><a href="#IntegratingwithSpringFramework-InjectingTapestryservicesinSpringbeans">Injecting Tapestry services in Spring beans</a></li></ul> @@ -115,7 +149,14 @@ div.rbtoc1478607584645 li {margin-left: <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"> </div></div> -<div style="border-right: 20px solid #D8E4F1;border-left: 20px solid #D8E4F1;"><p>If you have configured Spring to allow annotation-based injection, then you will be able to inject Tapestry services into your Spring Beans.</p><p>This feature is only available when Spring ApplicationContext is not configured and loaded externally.</p><p>Inside your Spring beans, you may use @<a class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Inject.html";>Inject</a> and @<a class="external-link" href="http://static.springsource.org/spring/docs/3.0.x/javadoc-api/org/springframework/beans/factory/annotation/Autowired.html"; rel="nofollow">Autowired</a> annotations.</p></div><pre>Simply add these two annotations on top the field you want to inject in your Spring bean. +<div class="error"><span class="error">Unknown macro: {div}</span> +<p>If you have configured Spring to allow annotation-based injection, then you will be able to inject Tapestry services into your Spring Beans.</p> + +<p>This feature is only available when Spring ApplicationContext is not configured and loaded externally.</p> + +<p>Inside your Spring beans, you may use @<a class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/ioc/annotations/Inject.html";>Inject</a> and @<a class="external-link" href="http://static.springsource.org/spring/docs/3.0.x/javadoc-api/org/springframework/beans/factory/annotation/Autowired.html"; rel="nofollow">Autowired</a> annotations.</p> + +</div><pre>Simply add these two annotations on top the field you want to inject in your Spring bean. </pre><pre>{code:language=java}</pre><pre> @Inject @Autowired private MyService myService;</pre><pre>{code} Modified: websites/production/tapestry/content/integration-with-existing-applications.html ============================================================================== --- websites/production/tapestry/content/integration-with-existing-applications.html (original) +++ websites/production/tapestry/content/integration-with-existing-applications.html Mon Apr 10 10:21:38 2017 @@ -46,13 +46,26 @@ <div class="wrapper bs"> - <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div></div> + <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div> + +</div> <div id="top"> - <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span><form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> - <input type="text" name="q"> - <input type="submit" value="Search"> -</form></div><div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div><div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">Integration with existing applications</h1></div></div> + <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span> +<form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> + <input type="text" name="q"> + <input type="submit" value="Search"> +</form> + +</div> + + +<div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div> + + +<div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">Integration with existing applications</h1></div> + +</div> <div class="clearer"></div> </div> Modified: websites/production/tapestry/content/ioc-cookbook-basic-services-and-injection.html ============================================================================== --- websites/production/tapestry/content/ioc-cookbook-basic-services-and-injection.html (original) +++ websites/production/tapestry/content/ioc-cookbook-basic-services-and-injection.html Mon Apr 10 10:21:38 2017 @@ -46,13 +46,26 @@ <div class="wrapper bs"> - <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div></div> + <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div> + +</div> <div id="top"> - <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span><form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> - <input type="text" name="q"> - <input type="submit" value="Search"> -</form></div><div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div><div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">IoC Cookbook - Basic Services and Injection</h1></div></div> + <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span> +<form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> + <input type="text" name="q"> + <input type="submit" value="Search"> +</form> + +</div> + + +<div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div> + + +<div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">IoC Cookbook - Basic Services and Injection</h1></div> + +</div> <div class="clearer"></div> </div> Modified: websites/production/tapestry/content/ioc-cookbook-overriding-ioc-services.html ============================================================================== --- websites/production/tapestry/content/ioc-cookbook-overriding-ioc-services.html (original) +++ websites/production/tapestry/content/ioc-cookbook-overriding-ioc-services.html Mon Apr 10 10:21:38 2017 @@ -46,13 +46,26 @@ <div class="wrapper bs"> - <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div></div> + <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div> + +</div> <div id="top"> - <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span><form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> - <input type="text" name="q"> - <input type="submit" value="Search"> -</form></div><div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div><div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">IoC Cookbook - Overriding IoC Services</h1></div></div> + <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span> +<form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> + <input type="text" name="q"> + <input type="submit" value="Search"> +</form> + +</div> + + +<div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div> + + +<div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">IoC Cookbook - Overriding IoC Services</h1></div> + +</div> <div class="clearer"></div> </div> Modified: websites/production/tapestry/content/ioc-cookbook-patterns.html ============================================================================== --- websites/production/tapestry/content/ioc-cookbook-patterns.html (original) +++ websites/production/tapestry/content/ioc-cookbook-patterns.html Mon Apr 10 10:21:38 2017 @@ -46,13 +46,26 @@ <div class="wrapper bs"> - <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div></div> + <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div> + +</div> <div id="top"> - <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span><form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> - <input type="text" name="q"> - <input type="submit" value="Search"> -</form></div><div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div><div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">IoC Cookbook - Patterns</h1></div></div> + <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span> +<form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> + <input type="text" name="q"> + <input type="submit" value="Search"> +</form> + +</div> + + +<div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div> + + +<div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">IoC Cookbook - Patterns</h1></div> + +</div> <div class="clearer"></div> </div> @@ -64,31 +77,58 @@ </div> <div id="content"> - <div id="ConfluenceContent"><p>Tapestry IoC has support for implementing several of the <a class="external-link" href="http://en.wikipedia.org/wiki/Design_pattern_(computer_science)" rel="nofollow">Gang Of Four Design Patterns</a>. In fact, the IoC container itself is a pumped up version of the Factory pattern.</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 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 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 href="pipelinebuilder-service.html">PipelineBuilder 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 href="chainbuilder-service.html">ChainBuilder Service</a> - </div> </li></ul></div><p>The basis for these patterns is often the use of <em>service builder methods</em>, where a <a href="ioc-cookbook-service-configurations.html">configuration</a> for the service is combined with a factory to produce the service implementation on the fly.</p><p><span class="confluence-anchor-link" id="IoCCookbook-Patterns-chainofcommand"></span></p><h1 id="IoCCookbook-Patterns-ChainofCommandPattern">Chain of Command Pattern</h1><p>Main Article: <a href="chainbuilder-service.html">Chain of Command</a></p><p>Let's look at another example, again from the Tapestry code base. The <a class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/services/InjectionProvider.html";>InjectProvider</a> interface is used to process the @Inject annotation on the fields of a Tapestry page or component. Many different instances are combined together to form a <em>chain of command</em>.</p><p>The interface has only a single method (this is far from uncommon):</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> + <div id="ConfluenceContent"><p>Tapestry IoC has support for implementing several of the <a class="external-link" href="http://en.wikipedia.org/wiki/Design_pattern_(computer_science)" rel="nofollow">Gang Of Four Design Patterns</a>. In fact, the IoC container itself is a pumped up version of the Factory pattern.</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 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 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 href="pipelinebuilder-service.html">PipelineBuilder 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 href="chainbuilder-service.html">ChainBuilder Service</a> + + + </div> + </li></ul> +</div> + + +<p>The basis for these patterns is often the use of <em>service builder methods</em>, where a <a href="ioc-cookbook-service-configurations.html">configuration</a> for the service is combined with a factory to produce the service implementation on the fly.</p><p><span class="confluence-anchor-link" id="IoCCookbook-Patterns-chainofcommand"></span></p><h1 id="IoCCookbook-Patterns-ChainofCommandPattern">Chain of Command Pattern</h1><p>Main Article: <a href="chainbuilder-service.html">Chain of Command</a></p><p>Let's look at another example, again from the Tapestry code base. The <a class="external-link" href="http://tapestry.apache.org/current/apidocs/org/apache/tapestry5/services/InjectionProvider.html";>InjectProvider</a> interface is used to process the @Inject annotation on the fields of a Tapestry page or component. Many different instances are combined together to form a <em>chain of command</em>.</p><p>The interface has only a single method (this is far from uncommon):</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 InjectionProvider { boolean provideInjection(String fieldName, Class fieldType, ObjectLocator locator, Modified: websites/production/tapestry/content/ioc-cookbook-service-configurations.html ============================================================================== --- websites/production/tapestry/content/ioc-cookbook-service-configurations.html (original) +++ websites/production/tapestry/content/ioc-cookbook-service-configurations.html Mon Apr 10 10:21:38 2017 @@ -46,13 +46,26 @@ <div class="wrapper bs"> - <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div></div> + <div id="navigation"><div class="nav"><ul class="alternate"><li><a href="index.html">Home</a></li><li><a href="getting-started.html">Getting Started</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="download.html">Download</a></li><li><a href="about.html">About</a></li><li><a class="external-link" href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li><li><a href="community.html">Community</a></li><li><a class="external-link" href="http://www.apache.org/security/";>Security</a></li><li><a class="external-link" href="http://www.apache.org/";>Apache</a></li><li><a class="external-link" href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a class="external-link" href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li></ul></div> + +</div> <div id="top"> - <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span><form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> - <input type="text" name="q"> - <input type="submit" value="Search"> -</form></div><div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div><div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">IoC cookbook - Service Configurations</h1></div></div> + <div id="smallbanner"><div class="searchbox" style="float:right;margin: .3em 1em .1em 1em"><span style="color: #999; font-size: 90%">Tapestry docs, issues, wikis & blogs:</span> +<form enctype="application/x-www-form-urlencoded" method="get" action="http://tapestry.apache.org/search.html";> + <input type="text" name="q"> + <input type="submit" value="Search"> +</form> + +</div> + + +<div class="emblem" style="float:left"><p><a href="index.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://tapestry.apache.org/images/tapestry_small.png"; data-image-src="http://tapestry.apache.org/images/tapestry_small.png";></span></a></p></div> + + +<div class="title" style="float:left; margin: 0 0 0 3em"><h1 id="SmallBanner-PageTitle">IoC cookbook - Service Configurations</h1></div> + +</div> <div class="clearer"></div> </div>
![http://tapestry.apache.org/images/tapestry_small.png"](http://tapestry.apache.org/images/tapestry_small.png"){kind=link}