summaryrefslogtreecommitdiffstats
path: root/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/message/Message.java
blob: e316050511f7d60ec1a762bac44aba911da92d31 (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
/**
 *
 *  Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
 *
 *  Licensed 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.
 */
package org.apache.tuscany.core.message;

import java.util.Map;

import org.apache.tuscany.core.addressing.EndpointReference;
import org.apache.tuscany.core.invocation.MessageChannel;
import org.apache.tuscany.core.invocation.TargetInvoker;

/**
 * Represents a request, response, or exception for an invocation
 */
public interface Message {

    /**
     * Return any message headers associated with the invocation.
     */
    Map<String, Object> getHeaders();

    /**
     * Returns the body of the message, which will be the payload or parameters
     * associated with the invocation
     * FIXME what is different w/ getPayload()?
     */
    Object getBody();

    /**
     * Sets the body of the message.
     */
    void setBody(Object body);

    /**
     * Returns true if the message is a request message
     * FIXME is this still used?
     */
    boolean isRequest();

    /**
     * Returns true if the message is an inbound message
     * FIXME is this still used?
     */
    boolean isResponse();

    /**
     * Sets the To header
     * FIXME Javadoc
     */
    void setTo(EndpointReference to);

    /**
     * Returns the To header
     * FIXME Javadoc
     */
    EndpointReference getTo();

    /**
     * Sets the From header
     * FIXME Javadoc
     */
    void setFrom(EndpointReference from);

    /**
     * Returns the From header
     * FIXME Javadoc
     */
    EndpointReference getFrom();

    /**
     * Sets the message ID
     */
    void setMessageID(String messageID);

    /**
     * Returns the message ID
     */
    String getMessageID();

    /**
     * Sets the Action header
     * FIXME Javadoc
     */
    void setAction(String action);

    /**
     * Returns the Action header
     * FIXME Javadoc
     */
    String getAction();

    /**
     * Sets the ReplyTo header
     * FIXME Javadoc
     */
    void setReplyTo(EndpointReference replyTo);

    /**
     * Returns the ReplyTo header
     * FIXME Javadoc
     */
    EndpointReference getReplyTo();

    /**
     * Sets the RelatesTo header
     * FIXME Javadoc
     */
    void setRelatesTo(String relatesTo);

    /**
     * Returns the RelatesTo header
     * FIXME Javadoc
     */
    String getRelatesTo();

    /**
     * Sets the FaultTo header
     * FIXME Javadoc
     */
    void setFaultTo(EndpointReference faultTo);

    /**
     * Returns the FaultTo header
     * FIXME Javadoc
     */
    EndpointReference getFaultTo();

    /**
     * Sets the EndpointReference header
     * FIXME Javadoc
     */
    void setEndpointReference(EndpointReference endpointReference);

    /**
     * Returns the EndpointReference header
     * FIXME Javadoc
     */
    EndpointReference getEndpointReference();

    /**
     * Sets the operation name
     * FIXME Javadoc
     */
    void setOperationName(String operationName);

    /**
     * Returns the operation name
     * FIXME Javadoc
     */
    String getOperationName();

    /**
     * Returns the callback channel
     * FIXME Javadoc
     */
    MessageChannel getCallbackChannel();

    /**
     * Returns the related callback message
     * FIXME Javadoc
     */
    Message getRelatedCallbackMessage();
    
    //ADDED
    public void setTargetInvoker(TargetInvoker invoker);
    
    public TargetInvoker getTargetInvoker();
    
} // Message