From 31d794be59cb2d1bf264df79f471b0c8d5f5a457 Mon Sep 17 00:00:00 2001 From: lresende Date: Sat, 21 Nov 2009 07:40:26 +0000 Subject: Moving to site trunk git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@882841 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/tuscany/sca/invocation/Message.html | 558 +++++++++++++++++++++ 1 file changed, 558 insertions(+) create mode 100644 site/trunk/site-publish/doc/javadoc/java-sca-0.9/sca-spi/org/apache/tuscany/sca/invocation/Message.html (limited to 'site/trunk/site-publish/doc/javadoc/java-sca-0.9/sca-spi/org/apache/tuscany/sca/invocation/Message.html') diff --git a/site/trunk/site-publish/doc/javadoc/java-sca-0.9/sca-spi/org/apache/tuscany/sca/invocation/Message.html b/site/trunk/site-publish/doc/javadoc/java-sca-0.9/sca-spi/org/apache/tuscany/sca/invocation/Message.html new file mode 100644 index 0000000000..801352d0ce --- /dev/null +++ b/site/trunk/site-publish/doc/javadoc/java-sca-0.9/sca-spi/org/apache/tuscany/sca/invocation/Message.html @@ -0,0 +1,558 @@ + + + + + + +Message + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.tuscany.sca.invocation +
+Interface Message

+
+
+
public interface Message
+ + +

+Represents a request, response, or exception flowing through a wire +

+ +

+

+
Version:
+
$Rev $Date
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ + + + + +
+<T> T
+		getBody() + +
+          Returns the body of the message, which will be the payload or parameters associated with the wire
+ java.lang.StringgetConversationID() + +
+          Get the conversation id
+ ConversationSequencegetConversationSequence() + +
+          Returns the conversational sequence the message is associated with, NONE, START, CONTINUE, or END on TargetInvoker}
+ java.lang.ObjectgetCorrelationID() + +
+          Returns the correlation id of the message or null if one is not available.
+ EndpointReferencegetFrom() + +
+          Get the end point reference of the source reference
+ java.lang.ObjectgetMessageID() + +
+          Returns the id of the message
+ EndpointReferencegetTo() + +
+          Get the end point reference of target service
+ booleanisFault() + +
+          Determines if the message represents a fault/exception
+ + + + + +
+<T> void
+		setBody(T body) + +
+          Sets the body of the message.
+ voidsetConversationID(java.lang.String conversationId) + +
+          Set the conversation id
+ voidsetConversationSequence(ConversationSequence sequence) + +
+          Returns the conversational sequence the message is associated with, NONE, START, CONTINUE, or END
+ voidsetCorrelationID(java.lang.Object correlationId) + +
+          Sets the correlation id of the message.
+ + + + + +
+<T> void
+		setFaultBody(T fault) + +
+          Set the message body with a fault object.
+ voidsetFrom(EndpointReference from) + +
+          Set the end point reference of the reference originating the message
+ voidsetMessageID(java.lang.Object messageId) + +
+          Sets the id of the message
+ voidsetTo(EndpointReference to) + +
+          Set the end point reference of target service
+  +

+ + + + + + + + +
+Method Detail
+ +

+getBody

+
+<T> T getBody()
+
+
Returns the body of the message, which will be the payload or parameters associated with the wire +

+

+ +
Returns:
The body of the message
+
+
+
+ +

+setBody

+
+<T> void setBody(T body)
+
+
Sets the body of the message. +

+

+
Parameters:
body - The body of the message
+
+
+
+ +

+getConversationID

+
+java.lang.String getConversationID()
+
+
Get the conversation id +

+

+ +
Returns:
The conversation ID
+
+
+
+ +

+setConversationID

+
+void setConversationID(java.lang.String conversationId)
+
+
Set the conversation id +

+

+
Parameters:
conversationId - The conversation ID
+
+
+
+ +

+getFrom

+
+EndpointReference getFrom()
+
+
Get the end point reference of the source reference +

+

+ +
Returns:
The end point reference of the reference originating the message
+
+
+
+ +

+setFrom

+
+void setFrom(EndpointReference from)
+
+
Set the end point reference of the reference originating the message +

+

+
Parameters:
from - The end point reference of the reference originating the message
+
+
+
+ +

+getTo

+
+EndpointReference getTo()
+
+
Get the end point reference of target service +

+

+ +
Returns:
The end point reference of the service that the message targets
+
+
+
+ +

+setTo

+
+void setTo(EndpointReference to)
+
+
Set the end point reference of target service +

+

+
Parameters:
to - The end point reference of the service that the message targets
+
+
+
+ +

+getMessageID

+
+java.lang.Object getMessageID()
+
+
Returns the id of the message +

+

+ +
Returns:
The message Id
+
+
+
+ +

+setMessageID

+
+void setMessageID(java.lang.Object messageId)
+
+
Sets the id of the message +

+

+
Parameters:
messageId - The message ID
+
+
+
+ +

+getCorrelationID

+
+java.lang.Object getCorrelationID()
+
+
Returns the correlation id of the message or null if one is not available. Correlation ids are used by transports + for message routing. +

+

+ +
Returns:
The correlation Id
+
+
+
+ +

+setCorrelationID

+
+void setCorrelationID(java.lang.Object correlationId)
+
+
Sets the correlation id of the message. Correlation ids are used by transports for message routing. +

+

+
Parameters:
correlationId - The correlation Id
+
+
+
+ +

+isFault

+
+boolean isFault()
+
+
Determines if the message represents a fault/exception +

+

+ +
Returns:
true If the message body is a fault object, false if the body is a normal payload
+
+
+
+ +

+setFaultBody

+
+<T> void setFaultBody(T fault)
+
+
Set the message body with a fault object. After this method is called, isFault() returns true. +

+

+
Parameters:
fault - The fault object represents an exception
+
+
+
+ +

+getConversationSequence

+
+ConversationSequence getConversationSequence()
+
+
Returns the conversational sequence the message is associated with, NONE, START, CONTINUE, or END on TargetInvoker} +

+

+ +
Returns:
The conversational sequence the message is associated with
+
+
+
+ +

+setConversationSequence

+
+void setConversationSequence(ConversationSequence sequence)
+
+
Returns the conversational sequence the message is associated with, NONE, START, CONTINUE, or END +

+

+
Parameters:
sequence - The conversational sequence
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + -- cgit v1.2.3