summaryrefslogtreecommitdiffstats
path: root/site/site-publish/doc/javadoc/java-sca-0.9/sca-spi/org/apache/tuscany/sca/invocation/Message.html
blob: 801352d0ce27442e36328357e450c146ad308551 (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
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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_11) on Tue Jun 05 22:00:52 PDT 2007 -->
<TITLE>
Message
</TITLE>

<META NAME="keywords" CONTENT="org.apache.tuscany.sca.invocation.Message interface">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    parent.document.title="Message";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Message.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/tuscany/sca/invocation/Invoker.html" title="interface in org.apache.tuscany.sca.invocation"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/tuscany/sca/invocation/MessageFactory.html" title="interface in org.apache.tuscany.sca.invocation"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html?org/apache/tuscany/sca/invocation/Message.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Message.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.tuscany.sca.invocation</FONT>
<BR>
Interface Message</H2>
<HR>
<DL>
<DT><PRE>public interface <B>Message</B></DL>
</PRE>

<P>
Represents a request, response, or exception flowing through a wire
<P>

<P>
<DL>
<DT><B>Version:</B></DT>
  <DD>$Rev $Date</DD>
</DL>
<HR>

<P>

<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE>&lt;T&gt; T</CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#getBody()">getBody</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the body of the message, which will be the payload or parameters associated with the wire</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#getConversationID()">getConversationID</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the conversation id</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/tuscany/sca/interfacedef/ConversationSequence.html" title="enum in org.apache.tuscany.sca.interfacedef">ConversationSequence</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#getConversationSequence()">getConversationSequence</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the conversational sequence the message is associated with, NONE, START, CONTINUE, or END on TargetInvoker}</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#getCorrelationID()">getCorrelationID</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the correlation id of the message or null if one is not available.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/tuscany/sca/runtime/EndpointReference.html" title="interface in org.apache.tuscany.sca.runtime">EndpointReference</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#getFrom()">getFrom</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the end point reference of the source reference</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#getMessageID()">getMessageID</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the id of the message</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/tuscany/sca/runtime/EndpointReference.html" title="interface in org.apache.tuscany.sca.runtime">EndpointReference</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#getTo()">getTo</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the end point reference of target service</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#isFault()">isFault</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the message represents a fault/exception</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE>&lt;T&gt; void</CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#setBody(T)">setBody</A></B>(T&nbsp;body)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the body of the message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#setConversationID(java.lang.String)">setConversationID</A></B>(java.lang.String&nbsp;conversationId)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the conversation id</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#setConversationSequence(org.apache.tuscany.sca.interfacedef.ConversationSequence)">setConversationSequence</A></B>(<A HREF="../../../../../org/apache/tuscany/sca/interfacedef/ConversationSequence.html" title="enum in org.apache.tuscany.sca.interfacedef">ConversationSequence</A>&nbsp;sequence)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the conversational sequence the message is associated with, NONE, START, CONTINUE, or END</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#setCorrelationID(java.lang.Object)">setCorrelationID</A></B>(java.lang.Object&nbsp;correlationId)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the correlation id of the message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE>&lt;T&gt; void</CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#setFaultBody(T)">setFaultBody</A></B>(T&nbsp;fault)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the message body with a fault object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#setFrom(org.apache.tuscany.sca.runtime.EndpointReference)">setFrom</A></B>(<A HREF="../../../../../org/apache/tuscany/sca/runtime/EndpointReference.html" title="interface in org.apache.tuscany.sca.runtime">EndpointReference</A>&nbsp;from)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the end point reference of the reference originating the message</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#setMessageID(java.lang.Object)">setMessageID</A></B>(java.lang.Object&nbsp;messageId)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the id of the message</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/invocation/Message.html#setTo(org.apache.tuscany.sca.runtime.EndpointReference)">setTo</A></B>(<A HREF="../../../../../org/apache/tuscany/sca/runtime/EndpointReference.html" title="interface in org.apache.tuscany.sca.runtime">EndpointReference</A>&nbsp;to)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the end point reference of target service</TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getBody()"><!-- --></A><H3>
getBody</H3>
<PRE>
&lt;T&gt; T <B>getBody</B>()</PRE>
<DL>
<DD>Returns the body of the message, which will be the payload or parameters associated with the wire
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The body of the message</DL>
</DD>
</DL>
<HR>

<A NAME="setBody(java.lang.Object)"><!-- --></A><A NAME="setBody(T)"><!-- --></A><H3>
setBody</H3>
<PRE>
&lt;T&gt; void <B>setBody</B>(T&nbsp;body)</PRE>
<DL>
<DD>Sets the body of the message.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>body</CODE> - The body of the message</DL>
</DD>
</DL>
<HR>

<A NAME="getConversationID()"><!-- --></A><H3>
getConversationID</H3>
<PRE>
java.lang.String <B>getConversationID</B>()</PRE>
<DL>
<DD>Get the conversation id
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The conversation ID</DL>
</DD>
</DL>
<HR>

<A NAME="setConversationID(java.lang.String)"><!-- --></A><H3>
setConversationID</H3>
<PRE>
void <B>setConversationID</B>(java.lang.String&nbsp;conversationId)</PRE>
<DL>
<DD>Set the conversation id
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>conversationId</CODE> - The conversation ID</DL>
</DD>
</DL>
<HR>

<A NAME="getFrom()"><!-- --></A><H3>
getFrom</H3>
<PRE>
<A HREF="../../../../../org/apache/tuscany/sca/runtime/EndpointReference.html" title="interface in org.apache.tuscany.sca.runtime">EndpointReference</A> <B>getFrom</B>()</PRE>
<DL>
<DD>Get the end point reference of the source reference
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The end point reference of the reference originating the message</DL>
</DD>
</DL>
<HR>

<A NAME="setFrom(org.apache.tuscany.sca.runtime.EndpointReference)"><!-- --></A><H3>
setFrom</H3>
<PRE>
void <B>setFrom</B>(<A HREF="../../../../../org/apache/tuscany/sca/runtime/EndpointReference.html" title="interface in org.apache.tuscany.sca.runtime">EndpointReference</A>&nbsp;from)</PRE>
<DL>
<DD>Set the end point reference of the reference originating the message
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>from</CODE> - The end point reference of the reference originating the message</DL>
</DD>
</DL>
<HR>

<A NAME="getTo()"><!-- --></A><H3>
getTo</H3>
<PRE>
<A HREF="../../../../../org/apache/tuscany/sca/runtime/EndpointReference.html" title="interface in org.apache.tuscany.sca.runtime">EndpointReference</A> <B>getTo</B>()</PRE>
<DL>
<DD>Get the end point reference of target service
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The end point reference of the service that the message targets</DL>
</DD>
</DL>
<HR>

<A NAME="setTo(org.apache.tuscany.sca.runtime.EndpointReference)"><!-- --></A><H3>
setTo</H3>
<PRE>
void <B>setTo</B>(<A HREF="../../../../../org/apache/tuscany/sca/runtime/EndpointReference.html" title="interface in org.apache.tuscany.sca.runtime">EndpointReference</A>&nbsp;to)</PRE>
<DL>
<DD>Set the end point reference of target service
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>to</CODE> - The end point reference of the service that the message targets</DL>
</DD>
</DL>
<HR>

<A NAME="getMessageID()"><!-- --></A><H3>
getMessageID</H3>
<PRE>
java.lang.Object <B>getMessageID</B>()</PRE>
<DL>
<DD>Returns the id of the message
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The message Id</DL>
</DD>
</DL>
<HR>

<A NAME="setMessageID(java.lang.Object)"><!-- --></A><H3>
setMessageID</H3>
<PRE>
void <B>setMessageID</B>(java.lang.Object&nbsp;messageId)</PRE>
<DL>
<DD>Sets the id of the message
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>messageId</CODE> - The message ID</DL>
</DD>
</DL>
<HR>

<A NAME="getCorrelationID()"><!-- --></A><H3>
getCorrelationID</H3>
<PRE>
java.lang.Object <B>getCorrelationID</B>()</PRE>
<DL>
<DD>Returns the correlation id of the message or null if one is not available. Correlation ids are used by transports
 for message routing.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The correlation Id</DL>
</DD>
</DL>
<HR>

<A NAME="setCorrelationID(java.lang.Object)"><!-- --></A><H3>
setCorrelationID</H3>
<PRE>
void <B>setCorrelationID</B>(java.lang.Object&nbsp;correlationId)</PRE>
<DL>
<DD>Sets the correlation id of the message. Correlation ids are used by transports for message routing.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>correlationId</CODE> - The correlation Id</DL>
</DD>
</DL>
<HR>

<A NAME="isFault()"><!-- --></A><H3>
isFault</H3>
<PRE>
boolean <B>isFault</B>()</PRE>
<DL>
<DD>Determines if the message represents a fault/exception
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true If the message body is a fault object, false if the body is a normal payload</DL>
</DD>
</DL>
<HR>

<A NAME="setFaultBody(java.lang.Object)"><!-- --></A><A NAME="setFaultBody(T)"><!-- --></A><H3>
setFaultBody</H3>
<PRE>
&lt;T&gt; void <B>setFaultBody</B>(T&nbsp;fault)</PRE>
<DL>
<DD>Set the message body with a fault object. After this method is called, isFault() returns true.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fault</CODE> - The fault object represents an exception</DL>
</DD>
</DL>
<HR>

<A NAME="getConversationSequence()"><!-- --></A><H3>
getConversationSequence</H3>
<PRE>
<A HREF="../../../../../org/apache/tuscany/sca/interfacedef/ConversationSequence.html" title="enum in org.apache.tuscany.sca.interfacedef">ConversationSequence</A> <B>getConversationSequence</B>()</PRE>
<DL>
<DD>Returns the conversational sequence the message is associated with, NONE, START, CONTINUE, or END on TargetInvoker}
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The conversational sequence the message is associated with</DL>
</DD>
</DL>
<HR>

<A NAME="setConversationSequence(org.apache.tuscany.sca.interfacedef.ConversationSequence)"><!-- --></A><H3>
setConversationSequence</H3>
<PRE>
void <B>setConversationSequence</B>(<A HREF="../../../../../org/apache/tuscany/sca/interfacedef/ConversationSequence.html" title="enum in org.apache.tuscany.sca.interfacedef">ConversationSequence</A>&nbsp;sequence)</PRE>
<DL>
<DD>Returns the conversational sequence the message is associated with, NONE, START, CONTINUE, or END
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sequence</CODE> - The conversational sequence</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Message.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/tuscany/sca/invocation/Invoker.html" title="interface in org.apache.tuscany.sca.invocation"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/tuscany/sca/invocation/MessageFactory.html" title="interface in org.apache.tuscany.sca.invocation"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html?org/apache/tuscany/sca/invocation/Message.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Message.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>