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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
|
<!--
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 : SCA Java implementation.web</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%">
</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=92446">
<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%">
<A href="home.html" title="Apache Tuscany">Apache Tuscany</A> > <A href="home.html" title="Home">Home</A> > <A href="sca-overview.html" title="SCA Overview">SCA Overview</A> > <A href="sca-java.html" title="SCA Java">SCA Java</A> > <A href="java-sca-documentation-menu.html" title="Java SCA Documentation Menu">Java SCA Documentation Menu</A> > <A href="sca-java-user-guide.html" title="SCA Java User Guide">SCA Java User Guide</A> > <A href="" title="SCA Java implementation.web">SCA Java implementation.web</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>
</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">
<TABLE class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><TBODY><TR>
<TD class="confluenceTd" valign="top" width="15%">
<DIV class="panel" style="background-color: #ECF4D1;border-color: #C3CDA1;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #C3CDA1;background-color: #C3CDA1;"><B>General</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;">
<P><A href="home.html" title="Home">Home</A><BR>
<A href="http://www.apache.org/licenses/LICENSE-2.0.html" class="external-link" rel="nofollow">License </A><BR>
<A href="sca-java-get-involved.html" title="SCA Java Get Involved">Get Involved</A><BR>
<A href="sca-java-found-a-bug.html" title="SCA Java Found A Bug">Found a Bug?</A></P>
</DIV></DIV>
<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>SCA Java</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;">
<P><A href="sca-java.html" title="SCA Java">SCA Java Home</A><BR>
<A href="tuscany-dashboard.html" title="Tuscany Dashboard">SCA Dashboard</A><BR>
<A href="java-sca-tools.html" title="Java SCA Tools">Tools </A><BR>
<A href="tuscany-sca-java-faq.html" title="Tuscany SCA Java - FAQ">FAQ</A></P>
</DIV></DIV>
<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>SCA Java 1.x</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;">
<P><A href="sca-java-releases.html" title="SCA Java Releases">Downloads</A><BR>
<A href="java-sca-documentation-menu.html" title="Java SCA Documentation Menu">Documentation</A><BR>
<A href="https://svn.apache.org/repos/asf/tuscany/sca-java-1.x/trunk/" class="external-link" rel="nofollow">1.x Source Code</A><BR>
<A href="http://tinyurl.com/8rlxd3" class="external-link" rel="nofollow">Roadmap</A></P>
</DIV></DIV>
<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>SCA Java 2.x</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;">
<P><A href="sca-java-2x-releases.html" title="SCA Java 2.x Releases">Downloads</A><BR>
<A href="http://tuscany.apache.org/documentation-2x/" class="external-link" rel="nofollow">Documentation</A><BR>
<A href="https://svn.apache.org/repos/asf/tuscany/sca-java-2.x/trunk/" class="external-link" rel="nofollow">2.x Source Code</A><BR>
<A href="http://tinyurl.com/8rlxd3" class="external-link" rel="nofollow">Roadmap</A></P>
</DIV></DIV>
<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>Documentation</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;">
<P><A href="sca-java-user-guide.html" title="SCA Java User Guide">User Guide</A><BR>
<A href="sca-java-architecture-guide.html" title="SCA Java Architecture Guide">Architecture Guide</A><BR>
<A href="sca-java-development-guide.html" title="SCA Java Development Guide">Developer Guide</A><BR>
<A href="sca-java-extension-development-guide.html" title="SCA Java Extension Development Guide">Extension Developer Guide</A></P>
</DIV></DIV>
<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>Resources</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;">
<P><A href="tuscany-sca-java-faq.html" title="Tuscany SCA Java - FAQ">FAQ</A><BR>
<A href="https://svn.apache.org/repos/asf/incubator/tuscany/java/sca" class="external-link" rel="nofollow">Source Code</A></P>
</DIV></DIV>
</TD>
<TD class="confluenceTd" valign="top" width="85%">
<H3><A name="SCAJavaimplementation.web-%3Cimplementation.web%3E"></A><implementation.web></H3>
<P>The Tuscany Java SCA runtime supports components implemented as JEE web modules by using the <implementation.web> SCDL extension. Implementation.web is one of the SCA extensions being formalized in the OASIS Open Composite Services Architecture with a published <A href="http://www.oasis-open.org/committees/download.php/28798/SCA_JAVAEE_Integration_V100.pdf" class="external-link" rel="nofollow">specification </A> document.</P>
<P>The web component implementation SCDL has the following format:</P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
<implementation.web web-uri=<SPAN class="code-quote">"<module name>"</SPAN> />
</PRE>
</DIV></DIV>
<P>Implementation.web can be used by components such as Servlets, JSPs, and Web 2.0 style html pages. How it works depends on the way the Tuscany runtime is being used.</P>
<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwithServlets%2CFilters%2CandEventlisteners"></A>Using implementation.web with Servlets, Filters, and Event listeners</H4>
<P>JEE Servlets, Filters, and Event listeners may acquire references to the services wired to a component which use implementation.web as shown in the following code snippets.</P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
<component name=<SPAN class="code-quote">"WebClient"</SPAN>>
<implementation.web web-uri=""/>
<reference name=<SPAN class="code-quote">"service"</SPAN> target=<SPAN class="code-quote">"HelloworldService"</SPAN>/>
</component>
</PRE>
</DIV></DIV>
<P>Then when using a JEE container with SCA integration Servlets, Filters, and Event listeners can use annotations to acquire references to the services wired to the component as shown in the following Servlet code snippet (note the Servlet field name 'service' matches the reference name in the SCDL):</P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
<SPAN class="code-keyword">public</SPAN> class HelloworldServlet <SPAN class="code-keyword">extends</SPAN> HttpServlet {
@Reference
<SPAN class="code-keyword">protected</SPAN> HelloworldService service;
. . .
}
</PRE>
</DIV></DIV>
<P>When the container does not have SCA integration then injection via annotations does not work, so to work around this the services need to be manually got from the ComponentContext which may be obtained from the application context. This is shown in the following code snippet:</P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
<SPAN class="code-keyword">public</SPAN> class HelloworldServlet <SPAN class="code-keyword">extends</SPAN> HttpServlet {
<SPAN class="code-keyword">public</SPAN> void init(ServletConfig config) {
ComponentContext context = (ComponentContext)config.getServletContext().getAttribute(<SPAN class="code-quote">"org.osoa.sca.ComponentContext"</SPAN>);
HelloworldService service = context .getService(HelloworldService.class, <SPAN class="code-quote">"service"</SPAN>);
. . .
}
. . .
}
</PRE>
</DIV></DIV>
<P>See the <A href="https://svn.apache.org/repos/asf/tuscany/branches/sca-java-1.x/samples/helloworld-servlet/" class="external-link" rel="nofollow">helloworld-servlet</A> sample for the complete code of the above Servlet example.</P>
<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwithJSPs"></A>Using implementation.web with JSPs</H4>
<P>A JSP tag library is available to expose SCA components in JSP pages. To use SCA references within a JSP use a taglib to include the SCA tags and define the reference field with the reference tag. </P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
<component name=<SPAN class="code-quote">"WebClient"</SPAN>>
<implementation.web web-uri=""/>
<reference name=<SPAN class="code-quote">"service"</SPAN> target=<SPAN class="code-quote">"HelloworldService"</SPAN>/>
</component>
</PRE>
</DIV></DIV>
<P>In the .jsp file:</P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
<%@ taglib uri=<SPAN class="code-quote">"http:<SPAN class="code-comment">//www.osoa.org/sca/sca_jsp.tld"</SPAN> prefix=<SPAN class="code-quote">"sca"</SPAN> %>
</SPAN><sca:reference name=<SPAN class="code-quote">"service"</SPAN> type=<SPAN class="code-quote">"sample.HelloworldService"</SPAN> />
<html>
<body >
<%= service.sayHello(<SPAN class="code-quote">"world"</SPAN>) %>
</body>
</html>
</PRE>
</DIV></DIV>
<P>See the <A href="https://svn.apache.org/repos/asf/tuscany/branches/sca-java-1.x/samples/helloworld-jsp/" class="external-link" rel="nofollow">helloworld-jsp</A> sample for the complete code of the above JSP example.</P>
<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwithWeb2.0stylebrowserclients"></A>Using implementation.web with Web 2.0 style browser clients</H4>
<P>Web 2.0 style pages can invoke SCA services by making RPC calls from the remote browser client to the service-side SCA service. To do this the HTML page includes Javascript code to import the SCA ComponentContext and then gets service proxys from that ComponentContext. The org.osoa.sca.componentContext.js script is generated by Tuscany when a component uses implementation.web.</P>
<P>In the SCDL the reference needs to specify one of the Tuscany Web2.0 bindings such as binding.jsonrpc or binding.dwr. <BR>
(TODO: could this be avoided - something like make binding.jsonrpc the default sca binding for web2.0 clients?) </P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
<component name=<SPAN class="code-quote">"WebClient"</SPAN>>
<implementation.web web-uri=""/>
<reference name=<SPAN class="code-quote">"service"</SPAN> target=<SPAN class="code-quote">"HelloworldService"</SPAN>>
<tuscany:binding.jsonrpc />
</reference>
</component>
</PRE>
</DIV></DIV>
<P>In the html page:</P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
<html>
<head>
<script type=<SPAN class="code-quote">"text/javascript"</SPAN> src=<SPAN class="code-quote">"org.osoa.sca.componentContext.js"</SPAN>></script>
<script language=<SPAN class="code-quote">"JavaScript"</SPAN>>
function callSayHello() {
componentContext.getService(<SPAN class="code-quote">"service"</SPAN>).sayHello(
document.getElementById('name').value,
function(reply) {
document.getElementById('result').innerHTML=reply;
});
}
</script>
</head>
<body >
. . .
<input type=<SPAN class="code-quote">"text"</SPAN> id=<SPAN class="code-quote">"name"</SPAN> width=<SPAN class="code-quote">"10"</SPAN>>
<button name=<SPAN class="code-quote">"submit"</SPAN> onclick=<SPAN class="code-quote">"callSayHello()"</SPAN>>Say hello</button>
<div id='result'></div>
. . .
</body>
</html>
</PRE>
</DIV></DIV>
<P>See the <A href="https://svn.apache.org/repos/asf/tuscany/branches/sca-java-1.x/samples/samples/helloworld-web/" class="external-link" rel="nofollow">helloworld-web</A> sample for the complete code of the above example.</P>
<P><IMG class="emoticon" src="https://cwiki.apache.org/confluence/images/icons/emoticons/warning.gif" height="16" width="16" align="absmiddle" alt="" border="0"> The following on Web 2.0 callbacks is not yet fully implemented, describing here to encourage feedback </P>
<P>Tuscany Web 2.0 clients using implementation.web support SCA asynchronous callbacks using what is known as <A href="http://en.wikipedia.org/wiki/Comet_(programming)" class="external-link" rel="nofollow">Comet or Reverse Ajax</A>. The only Tuscany binding that currently supports this in binding.dwr.</P>
<P>The following shows the previous sample changed to use callbacks to receive the replies. A callback binding is added to the reference in the SCDL and the callback function is defined as a seperate Javascript function defined by the client and attached to the service proxy object. </P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
<component name=<SPAN class="code-quote">"WebClient"</SPAN>>
<implementation.web web-uri=""/>
<reference name=<SPAN class="code-quote">"service"</SPAN> target=<SPAN class="code-quote">"HelloworldService"</SPAN>>
<tuscany:binding.dwr />
<callback>
<tuscany:binding.dwr />
</callback>
</reference>
</component>
</PRE>
</DIV></DIV>
<P>In the html page:</P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
<html>
<head>
<script type=<SPAN class="code-quote">"text/javascript"</SPAN> src=<SPAN class="code-quote">"org.osoa.sca.componentContext.js"</SPAN>></script>
<script language=<SPAN class="code-quote">"JavaScript"</SPAN>>
componentContext.getService(<SPAN class="code-quote">"service"</SPAN>).sayHelloCallback =
function(reply) {
document.getElementById('result').innerHTML=reply;
};
function callSayHello() {
componentContext.getService(<SPAN class="code-quote">"service"</SPAN>).sayHello(document.getElementById('name').value);
}
</script>
</head>
<body >
. . .
<input type=<SPAN class="code-quote">"text"</SPAN> id=<SPAN class="code-quote">"name"</SPAN> width=<SPAN class="code-quote">"10"</SPAN>>
<button name=<SPAN class="code-quote">"submit"</SPAN> onclick=<SPAN class="code-quote">"callSayHello()"</SPAN>>Say hello</button>
<div id='result'></div>
. . .
</body>
</html>
</PRE>
</DIV></DIV>
<P>See the <A href="https://svn.apache.org/repos/asf/tuscany/java/sca/samples/helloworld-web-callback/" class="external-link" rel="nofollow">helloworld-web-callback</A> sample for the complete code of the above example.</P>
<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwiththeTuscanyruntimeembeddedwithinawebapp"></A>Using implementation.web with the Tuscany runtime embedded within a webapp</H4>
<P>This is the style all the current Tuscany webapp samples use. When using implementation.web with the Tuscany runtime embedded within a webapp the implementation.web web-uri attribute is ignored.</P>
<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwiththeTuscanyruntimeintegratedintoaJEEserversuchasTomcatorGeronimo"></A>Using implementation.web with the Tuscany runtime integrated into a JEE server such as Tomcat or Geronimo</H4>
<P>The only code that is currently working is some prototype code in the Tuscany runtime-tomcat module that supports injecting references into Servlets, Filters and Event listeners using the @Reference annotation.</P>
<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwiththeTuscanystandaloneruntime"></A>Using implementation.web with the Tuscany standalone runtime</H4>
<P>Nothing implemented yet</P>
<H4><A name="SCAJavaimplementation.web-Usingimplementation.webwiththeTuscanydistributeddomainruntime"></A>Using implementation.web with the Tuscany distributed domain runtime</H4>
<P>Nothing implemented yet</P>
</TD></TR></TBODY></TABLE>
</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 </BR>
Apache Tuscany and the Apache Tuscany project logo are trademarks of The Apache Software Foundation.
</DIV>
<!-- footer macro end -->
</BODY>
</HTML>
|
