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
|
/*
* 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.
*/
#ifndef AXIS2_MSG_INFO_HEADERS_H
#define AXIS2_MSG_INFO_HEADERS_H
/**
* @defgroup axis2_msg_info_headers message information headers
* @ingroup axis2_addr
* message information headers encapsulates properties that enable the
* identification and location of the endpoints involved in an interaction.
* The basic interaction pattern from which all others are composed is
* "one way". In this pattern a source sends a message to a destination
* without any further definition of the interaction. "Request Reply" is a
* common interaction pattern that consists of an initial message sent by
* a source endpoint (the request) and a subsequent message sent from the
* destination of the request back to the source (the reply).
* A reply can be either an application message, a fault, or any other message.
* message information headers capture addressing information related to these
* interaction patterns such as from, to, reply to and fault to addresses.
* @{
*/
/**
* @file axis2_msg_info_headers.h
*/
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axis2_const.h>
#include <axutil_array_list.h>
#include <axis2_endpoint_ref.h>
#include <axis2_any_content_type.h>
#include <axis2_svc_name.h>
#include <axis2_relates_to.h>
#include <axiom_node.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_msg_info_headers */
typedef struct axis2_msg_info_headers axis2_msg_info_headers_t;
/**
* Creates message information headers struct.
* @param env pointer to environment struct
* @param to pointer to endpoint reference representing to endpoint
* @param action WS-Addressing action string
* @return pointer to newly created message information headers struct
*/
AXIS2_EXTERN axis2_msg_info_headers_t *AXIS2_CALL
axis2_msg_info_headers_create(
const axutil_env_t * env,
axis2_endpoint_ref_t * to,
const axis2_char_t * action);
/**
* Gets to endpoint. to endpoint represents the address of the
* intended receiver of this message.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return pointer to endpoint reference representing to address,
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
axis2_msg_info_headers_get_to(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Sets to endpoint. to endpoint represents the address of the
* intended receiver of this message.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param to pointer to endpoint reference representing to address,
* message information headers assumes ownership of the endpoint
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_to(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
axis2_endpoint_ref_t * to);
/**
* Gets from endpoint. from endpoint represents the address of the
* endpoint where the message originated from.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return pointer to endpoint reference representing from address,
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
axis2_msg_info_headers_get_from(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Sets from endpoint. from endpoint represents the address of the
* endpoint where the message originated from.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param from pointer to endpoint reference representing from address,
* message information headers assumes ownership of the endpoint
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_from(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
axis2_endpoint_ref_t * from);
/**
* Gets reply to endpoint. reply to endpoint identifies the intended
* receiver to which a message is replied.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return pointer to endpoint reference representing reply to address,
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
axis2_msg_info_headers_get_reply_to(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Sets reply to endpoint. reply to endpoint identifies the intended
* receiver to which a message is replied.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param reply_to pointer to endpoint reference representing reply to
* address, message information headers assumes ownership of the endpoint
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_reply_to(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
axis2_endpoint_ref_t * reply_to);
/**
* Sets the bool value indicating whether the reply to endpoint should
* be none. reply to endpoint identifies the intended receiver for
* replies to a message. The URI "http://www.w3.org/2005/08/addressing/none"
* in the reply to address indicates that no reply should be sent.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param none AXIS2_TRUE if http://www.w3.org/2005/08/addressing/none
* is to be used as reply to URI, else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_reply_to_none(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
const axis2_bool_t none);
/**
* Gets the bool value indicating whether the reply to endpoint should
* be none. reply to endpoint identifies the intended receiver for
* replies related to a message. The URI
* "http://www.w3.org/2005/08/addressing/none"
* in the reply to address indicates that no reply should be sent.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return AXIS2_TRUE if http://www.w3.org/2005/08/addressing/none
* is to be used as reply to URI, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_info_headers_get_reply_to_none(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Sets the bool value indicating whether the reply to endpoint should
* be anonymous. reply to endpoint identifies the intended receiver for
* replies related to a message. The URI
* "http://www.w3.org/2005/08/addressing/anonymous"
* in the reply to address indicates that reply should be sent to
* from address.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param anonymous AXIS2_TRUE if
* http://www.w3.org/2005/08/addressing/anonymous
* is to be used as reply to URI, else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_reply_to_anonymous(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
const axis2_bool_t anonymous);
/**
* Gets the bool value indicating whether the reply to endpoint should
* be anonymous. reply to endpoint identifies the intended receiver for
* replies related to a message. The URI
* "http://www.w3.org/2005/08/addressing/anonymous"
* in the reply to address indicates that reply should be sent to
* from address.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return AXIS2_TRUE if http://www.w3.org/2005/08/addressing/anonymous
* is to be used as reply to URI, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_info_headers_get_reply_to_anonymous(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Gets fault to endpoint. fault to endpoint identifies the intended
* receiver for faults related to a message.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return pointer to endpoint reference representing fault to address,
* returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
axis2_msg_info_headers_get_fault_to(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Sets fault to endpoint. fault to endpoint identifies the intended
* receiver for faults related to a message.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param fault_to pointer to endpoint reference representing fault to
* address, message information headers assumes ownership of the endpoint
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_fault_to(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
axis2_endpoint_ref_t * fault_to);
/**
* Sets the bool value indicating whether the fault to endpoint should
* be none. fault to endpoint identifies the intended receiver for
* faults related to a message. The URI
* "http://www.w3.org/2005/08/addressing/none"
* in the fault to address indicates that no fault should be sent back.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param none AXIS2_TRUE if http://www.w3.org/2005/08/addressing/none
* is to be used as fault to URI, else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_fault_to_none(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
const axis2_bool_t none);
/**
* Gets the bool value indicating whether the fault to endpoint should
* be none. fault to endpoint identifies the intended receiver for
* faults related to a message. The URI
* "http://www.w3.org/2005/08/addressing/none"
* in the fault to address indicates that no fault should be sent back.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return AXIS2_TRUE if http://www.w3.org/2005/08/addressing/none
* is to be used as fault to URI, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_info_headers_get_fault_to_none(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Sets the bool value indicating whether the fault to endpoint should
* be anonymous. fault to endpoint identifies the intended receiver for
* faults related to a message. The URI
* "http://www.w3.org/2005/08/addressing/anonymous"
* in the fault to address indicates that fault should be sent to
* from address.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param anonymous AXIS2_TRUE if
* http://www.w3.org/2005/08/addressing/anonymous
* is to be used as fault to URI, else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_fault_to_anonymous(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
const axis2_bool_t anonymous);
/**
* Gets the bool value indicating whether the fault to endpoint should
* be anonymous. fault to endpoint identifies the intended receiver for
* faults related to a message. The URI
* "http://www.w3.org/2005/08/addressing/anonymous"
* in the fault to address indicates that fault should be sent to
* from address.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return AXIS2_TRUE if http://www.w3.org/2005/08/addressing/anonymous
* is to be used as fault to URI, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_info_headers_get_fault_to_anonymous(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Gets WS-Addressing action. action is an absolute IRI
* (Internationalized Resource Identifier) that uniquely identifies
* the semantics implied by this message.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return WS-Addressing action string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_msg_info_headers_get_action(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Sets WS-Addressing action. action is an absolute IRI
* (Internationalized Resource Identifier) that uniquely identifies
* the semantics implied by this message.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param action WS-Addressing action string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_action(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
const axis2_char_t * action);
/**
* Gets message ID. message ID is an absolute IRI that uniquely
* identifies the message.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return message ID string.
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_msg_info_headers_get_message_id(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Sets message ID. message ID is an absolute URI that uniquely
* identifies the message. Message ID will be prefixed with "urn:uuid:"
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param message_id message ID string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_message_id(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
const axis2_char_t * message_id);
/**
* Sets message ID. message ID is an absolute URI that uniquely
* identifies the message. Message ID Given will be used.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param message_id message ID string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_in_message_id(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
const axis2_char_t * message_id);
/**
* Gets relates to information.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return pointer to relates to struct, returns a reference, not a
* cloned copy
* @sa axis2_relates_to
*/
AXIS2_EXTERN axis2_relates_to_t *AXIS2_CALL
axis2_msg_info_headers_get_relates_to(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Sets relates to information.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param relates_to pointer to relates to struct, message information
* headers assumes ownership of struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_set_relates_to(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
axis2_relates_to_t * relates_to);
/**
* Gets all reference parameters associated with message information
* headers.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return pointer to array list containing all reference parameters
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_info_headers_get_all_ref_params(
const axis2_msg_info_headers_t * msg_info_headers,
const axutil_env_t * env);
/**
* Adds a reference parameter in the form of an AXIOM node.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @param ref_param pointer to AXIOM node representing reference
* parameter, message information header does not assume ownership of
* node
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_info_headers_add_ref_param(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env,
axiom_node_t * ref_param);
/**
* Frees message information header struct.
* @param msg_info_headers pointer to message information headers struct
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_msg_info_headers_free(
struct axis2_msg_info_headers *msg_info_headers,
const axutil_env_t * env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_MSG_INFO_HEADERS_H */
|