summaryrefslogtreecommitdiffstats
path: root/site/trunk/site-publish/adding-the-spring-implementation-type.html
blob: e9718e06cc8c612542ad31302688448aa21a370b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
<!--

    Licensed to the Apache Software Foundation (ASF) under one or more
    contributor license agreements.  See the NOTICE file distributed with
    this work for additional information regarding copyright ownership.
    The ASF licenses this file to You under the Apache License, Version 2.0
    (the "License"); you may not use this file except in compliance with
    the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE- 2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-->


<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML>
    <HEAD>
		<!-- generateKeywords macro -->
	    <META name="description" content="Apache Tuscany">
        <META name="keywords" content="apache, apache tuscany, tuscany, service, services, fabric, soa, service oriented architecture,  sca, service component architecture, das, sdo, csa, ruby, opensource">
		<!-- generateKeywords macro end -->
		
        <LINK type="text/css" rel="stylesheet" href="http://tuscany.apache.org/stylesheets/default.css">
        <LINK rel="SHORTCUT ICON" href="https://cwiki.apache.org/confluence/display/TUSCANY/$images/favicon.ico">   
        <TITLE>Apache Tuscany : Adding the Spring Implementation Type</TITLE>
    <META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD>
    
    <BODY onload="init()">
        <!-- topNav macro -->
		<TABLE valign="top" border="0" cellspacing="0" cellpadding="0" width="100%" background="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg">
			<TR>
				<TD valing="top" align="left">
					<A href="https://cwiki.apache.org/confluence/pages/viewpage.action?spaceKey=TUSCANY&title=$siteroot"><IMG src="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg" height="91" width="25" border="0"></A>
				</TD>
				<TD>
					<A href="http://tuscany.apache.org/"><IMG src="http://tuscany.apache.org/images/TuscanyLogo.jpg" border="0"></A>
				</TD>
				
				<TD width="100%">
					&nbsp;
				</TD>

				<!-- Adds the edit page link to the top banner-->
				<TD valign="bottom">
					<DIV style="padding: 2px 10px; margin: 0px;">
						<A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=53225">
						<IMG src="http://tuscany.apache.org/images/notep_16.gif" height="16" width="16" border="0" align="absmiddle" title="Edit Page"></A>
					</DIV>
				</TD>

			</TR>
		</TABLE>
        <!-- topNav macro end -->

		<!-- breadCrumbs macro -->
		<TABLE border="0" cellpadding="2" cellspacing="0" width="100%">
			<TR class="topBar">
				<TD align="left" valign="middle" class="topBarDiv" nowrap="true" width="100%">
					&nbsp;<A href="home.html" title="Apache Tuscany">Apache Tuscany</A>&nbsp;&gt;&nbsp;<A href="home.html" title="Home">Home</A>&nbsp;&gt;&nbsp;<A href="sca-overview.html" title="SCA Overview">SCA Overview</A>&nbsp;&gt;&nbsp;<A href="sca-java.html" title="SCA Java">SCA Java</A>&nbsp;&gt;&nbsp;<A href="java-sca-documentation-menu.html" title="Java SCA Documentation Menu">Java SCA Documentation Menu</A>&nbsp;&gt;&nbsp;<A href="sca-java-extension-development-guide.html" title="SCA Java Extension Development Guide">SCA Java Extension Development Guide</A>&nbsp;&gt;&nbsp;<A href="mike-edwards-ramble-through-adding-a-new-implementation-type.html" title="Mike Edwards Ramble through Adding a New Implementation Type">Mike Edwards Ramble through Adding a New Implementation Type</A>&nbsp;&gt;&nbsp;<A href="" title="Adding the Spring Implementation Type">Adding the Spring Implementation Type</A>
				</TD>
				
				<TD align="right" valign="middle" class="topBarDiv" align="left" nowrap="true">
				<A href="http://mail-archives.apache.org/mod_mbox/tuscany-user">User List</A> | <A href="http://mail-archives.apache.org/mod_mbox/tuscany-dev">Dev List</A> | <A href="http://issues.apache.org/jira/browse/Tuscany">Issue Tracker</A>&nbsp;&nbsp;
				</TD>
			</TR>
		</TABLE>
		<!-- breadCrumbs macro end -->


        <TABLE border="0" cellpadding="0" width="100%" bgcolor="#FFFFFF">
            <TR>
                <TD align="left" valign="top">

					<!-- pageContent macro -->
					<DIV id="PageContent">
												
						<DIV class="pagecontent">
							<DIV class="wiki-content">
								<P>(3rd May 2007) This pages and the pages hung off it describe the creation of the module which supports the Spring Component Type that I am working on for a demo.  This might be useful to anyone looking to build their own Component Type implementation.</P>

<H2><A name="AddingtheSpringImplementationType-Sequence"></A>Sequence</H2>

<DIV class="table-wrap">
<TABLE class="confluenceTable"><TBODY>
<TR>
<TH class="confluenceTh"> Order </TH>
<TH class="confluenceTh"> Work Item <BR class="atl-forced-newline"> </TH>
<TH class="confluenceTh"> Comment </TH>
</TR>
<TR>
<TD class="confluenceTd"> 0 <BR class="atl-forced-newline"> </TD>
<TD class="confluenceTd"> implementation-spring module created <BR class="atl-forced-newline">
<BR class="atl-forced-newline">
org.apache.tuscany.implementation.spring package </TD>
<TD class="confluenceTd">&nbsp;</TD>
</TR>
<TR>
<TD class="confluenceTd"> 1 </TD>
<TD class="confluenceTd"> Created ModuleActivator file <BR class="atl-forced-newline"> </TD>
<TD class="confluenceTd"> Points at the SpringModuleActivator class <BR class="atl-forced-newline"> </TD>
</TR>
<TR>
<TD class="confluenceTd"> 2 </TD>
<TD class="confluenceTd"> Create SpringModuleActivator class </TD>
<TD class="confluenceTd"> Core of the Spring implementation module </TD>
</TR>
<TR>
<TD class="confluenceTd"> 3 <BR class="atl-forced-newline"> </TD>
<TD class="confluenceTd"> Create SpringArtifactProcessor class <BR class="atl-forced-newline"> </TD>
<TD class="confluenceTd"> Reads the implementation.spring xml in the composite file <BR class="atl-forced-newline">
 &#45; one required attribute = location, which specifies the location of the Spring application context <BR class="atl-forced-newline">
 Creates the implementationSpring instance <BR class="atl-forced-newline">
 Initiates resolution of the componentType of the Spring application context by calling SpringXMLComponentTypeLoader <BR class="atl-forced-newline"> </TD>
</TR>
<TR>
<TD class="confluenceTd"> 4 <BR class="atl-forced-newline"> </TD>
<TD class="confluenceTd"> Create SpringXMLComponentTypeLoader class <BR class="atl-forced-newline"> </TD>
<TD class="confluenceTd"> Reads the Spring application context and introspects the Beans referenced from it to determine the component type of the Spring implementation (ie Services, References, Properties) <BR class="atl-forced-newline"> </TD>
</TR>
<TR>
<TD class="confluenceTd">&nbsp;</TD>
<TD class="confluenceTd">&nbsp;</TD>
<TD class="confluenceTd">&nbsp;</TD>
</TR>
<TR>
<TD class="confluenceTd">&nbsp;</TD>
<TD class="confluenceTd">&nbsp;</TD>
<TD class="confluenceTd">&nbsp;</TD>
</TR>
<TR>
<TD class="confluenceTd">&nbsp;</TD>
<TD class="confluenceTd">&nbsp;</TD>
<TD class="confluenceTd">&nbsp;</TD>
</TR>
<TR>
<TD class="confluenceTd">&nbsp;</TD>
<TD class="confluenceTd">&nbsp;</TD>
<TD class="confluenceTd">&nbsp;</TD>
</TR>
<TR>
<TD class="confluenceTd">&nbsp;</TD>
<TD class="confluenceTd">&nbsp;</TD>
<TD class="confluenceTd">&nbsp;</TD>
</TR>
</TBODY></TABLE>
</DIV>


<H2><A name="AddingtheSpringImplementationType-ModuleActivatorfile"></A>ModuleActivator file</H2>

<P>Placed into the resources/META-INF/services directory:</P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java"># Implementation class <SPAN class="code-keyword">for</SPAN> the ExtensionActivator
org.apache.tuscany.implementation.script.ScriptModuleActivator
</PRE>
</DIV></DIV>

<H2><A name="AddingtheSpringImplementationType-SpringModuleActivatorclass%26nbsp%3B"></A>SpringModuleActivator class&nbsp;</H2>


<H4><A name="AddingtheSpringImplementationType-Constructor"></A>Constructor</H4>

<P>Creates resources used by other parts of the Module implementation:</P>
<UL>
	<LI>AssemblyFactory</LI>
	<LI>JavaInterfaceFactory</LI>
	<LI>PolicyFactory</LI>
</UL>


<H4><A name="AddingtheSpringImplementationType-start%28%29"></A>start()</H4>

<P>Takes an ExtensionPointRegistry as input parameter, which provides access to configuration of the core.</P>
<UL>
	<LI>Creates a SpringArtifactProcessor and adds to the registry StAXArtifactProcessors</LI>
	<LI>Creates a SpringImplementationProviderFactory and adds to the registry ProviderFactories</LI>
</UL>


<P>Creates a series of artifacts that are required by the SpringArtifactProcessor and SpringImplementationProviderFactory:</P>
<UL>
	<LI>ExtensibleJavaInterfaceIntrospector (used to introspect Spring Beans)</LI>
	<LI>JavaPropertyValueObjectFactory</LI>
</UL>


<H4><A name="AddingtheSpringImplementationType-stop%28%29"></A>stop()</H4>

<P>Removes the SpringArtifactProcessor from the registry StAXArtifactProcessors&nbsp;</P>

<H4><A name="AddingtheSpringImplementationType-getExtensionPoints%28%29%26nbsp%3B"></A>getExtensionPoints()&nbsp;</H4>

<P>Returns a very simple DefaultJavaClassIntrospectorExtensionPoint.&nbsp;</P>

<H2><A name="AddingtheSpringImplementationType-SpringArtifactProcessorclass%26nbsp%3B"></A>SpringArtifactProcessor class&nbsp;</H2>

<P>Handles the &lt;implementation.spring..../&gt; element used in composite files.</P>

<H4><A name="AddingtheSpringImplementationType-Constructor"></A>Constructor</H4>

<P>Takes a series of classes used&nbsp; in loading &amp; resolution:</P>
<UL>
	<LI>AssemblyFactory</LI>
	<LI>JavaInterfaceFactory</LI>
	<LI>JavaInterfaceIntrospector</LI>
	<LI>PolicyFactory&nbsp;</LI>
	<LI>JavaPropertyValueObjectFactor</LI>
</UL>


<H4><A name="AddingtheSpringImplementationType-read%28%29"></A>read()</H4>

<P>Reads the &lt;implementation.spring.../&gt; element from the composite.</P>

<P>Gets the <B><EM>location</EM></B> attribute - throws an exception if the attribute is missing.&nbsp;</P>

<P>Creates a SpringImplementation instance, sets its location field and returns it.&nbsp;</P>

<H4><A name="AddingtheSpringImplementationType-resolve%28%29%26nbsp%3B"></A>resolve()&nbsp;</H4>

<P>Given the SpringImplementation instance and a ModelResolver, gets the ComponentType for the implementation.</P>

<P>Does this by invoking&nbsp; SpringXMLComponentTypeLoader.load() - will follow up by reading a side file if this does not fully resolve the component type.</P>


<H4><A name="AddingtheSpringImplementationType-getArtifactType%28%29%26nbsp%3B"></A>getArtifactType()&nbsp;</H4>

<P>Returns the fully qualified name of the implementation.spring element (includes the SCA namespace...) &nbsp;</P>

<H2><A name="AddingtheSpringImplementationType-%26nbsp%3BSpringXMLComponentTypeLoaderclass"></A>&nbsp;SpringXMLComponentTypeLoader class</H2>


<OL>
	<LI>&nbsp;</LI>
</OL>


<H3><A name="AddingtheSpringImplementationType-ResolutionoftheComponentTypeofSpringapplicationcontext"></A>Resolution of the ComponentType of Spring application context</H3>

<P>ComponentType of the Spring application-context is performed by reading the application-context.xml file and by introspecting the Java beans which it references. This is done by the SpringXMLComponentTypeLoader class.</P>
							</DIV>
						</DIV>
					</DIV>	
		            <!-- pageContent macro end -->
					
                </TD>
            </TR>
        </TABLE>

		<!-- footer macro -->
				<SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript">
		</SCRIPT>
		<SCRIPT type="text/javascript">
		   _uacct = "UA-1174707-5";
		   urchinTracker();
		</SCRIPT>
		
				<A href="http://www.statcounter.com/" target="_blank"><IMG src="http://c26.statcounter.com/counter.php?sc_project=2619156&java=0&security=94bd7e7d&invisible=0" alt="website stats" border="0"></A>    

		<DIV class="footer">
			Copyright � 2003-2012, The Apache Software Foundation&nbsp;&nbsp;</BR>
                        Apache Tuscany and the Apache Tuscany project logo are trademarks of The Apache Software Foundation.
		</DIV>
		<!-- footer macro end -->

    </BODY>
</HTML>