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
|
/*
* 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 AXIOM_SOAP_BODY_H
#define AXIOM_SOAP_BODY_H
/**
* @file axiom_soap_body.h
* @brief axiom_soap_body struct
*/
#include <axutil_env.h>
#include <axiom_node.h>
#include <axiom_element.h>
#include <axiom_namespace.h>
#include <axiom_soap_fault.h>
#include <axiom_soap_envelope.h>
#ifdef __cplusplus
extern "C"
{
#endif
typedef struct axiom_soap_body axiom_soap_body_t;
struct axiom_soap_builder;
/**
* @defgroup axiom_soap_body soap body
* @ingroup axiom_soap
* @{
*/
/**
* a struct that represents the contents of the SOAP body
* element in a SOAP message. SOAP body element consists of XML data
* that affects the way the application-specific content is processed.
* soap_body_struct contains soap_header and
* which have the content for the SOAP body.
* this also contains axiom_soap_fault_t struct , which carries status and/or
* error information.
*/
/**
* creates a soap body struct
* @param env Environment. MUST NOT be NULL
* @param envelope the SOAP envelope to set the SOAP Body
* @return created SOAP Body
*/
AXIS2_EXTERN axiom_soap_body_t *AXIS2_CALL
axiom_soap_body_create_with_parent(
const axutil_env_t * env,
struct axiom_soap_envelope *envelope);
/**
* Deallocate all the resources associated to soap_body
* But it does not deallocate the underlying om structure
* @param body soap_body struct
* @param env must not be null
* @return status code AXIS2_SUCCESS
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_soap_body_free(
axiom_soap_body_t * body,
const axutil_env_t * env);
/**
* Indicates whether a soap fault is available with this
* soap body
* @param body soap_body struct
* @param env environment must not be null
* @return AXIS2_TRUE if fault is available, AXIS2_FALSE otherwise
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axiom_soap_body_has_fault(
axiom_soap_body_t * body,
const axutil_env_t * env);
/**
* returns the soap fault in this soap_body
* IF a soap_builder is associated with the soap_body
* Pulling will take place
* @param body soap_body
* @param env environment must not be null
* @return axiom_soap_fault_t if available, NULL otherwise
*/
AXIS2_EXTERN axiom_soap_fault_t *AXIS2_CALL
axiom_soap_body_get_fault(
axiom_soap_body_t * body,
const axutil_env_t * env);
/**
* get the underlying om_node
* @param body soap_body
* @param env environment must not be null
* @returns axiom_node_t
*/
AXIS2_EXTERN axiom_node_t *AXIS2_CALL
axiom_soap_body_get_base_node(
axiom_soap_body_t * body,
const axutil_env_t * env);
/**
* return the soap version
* @param body soap_body
* @param env environment must not be null
* @return one of AXIOM_SOAP11 or AXIOM_SOAP12
*/
AXIS2_EXTERN int AXIS2_CALL
axiom_soap_body_get_soap_version(
axiom_soap_body_t * body,
const axutil_env_t * env);
/**
* build the soap body completely . return the status code,
* @param body pointer to soap_body struct
* @param env axutil_environment struct MUST not be NULL
* @returns status code , AXIS2_SUCCESS on success , AXIS2_ERROR
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_soap_body_build(
axiom_soap_body_t * body,
const axutil_env_t * env);
/** add an om node as the child to this soap_body
* the child is added to as the first child
* @param body pointer to soap_body struct
* @param env axutil_environment struct MUST not be NULL
* @returns status code , AXIS2_SUCCESS on success , AXIS2_ERROR
* otherwise
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_soap_body_add_child(
axiom_soap_body_t * body,
const axutil_env_t * env,
axiom_node_t * child);
/**
* SOAP builder construct a SOAP 1.2 fault all the time.
* So when SOAP 1.1 is in use, we should convert SOAP fault to
* SOAP 1.1 fault format before use.
* @param body pointer to soap_body struct
* @param env axutil_environment struct MUST not be NULL
* @returns status code , AXIS2_SUCCESS on success , AXIS2_ERROR
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_soap_body_convert_fault_to_soap11(
axiom_soap_body_t * soap_body,
const axutil_env_t * env);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_soap_body_process_attachments(
axiom_soap_body_t * soap_body,
const axutil_env_t * env,
void *user_param,
axis2_char_t *callback_name);
AXIS2_EXTERN struct axiom_soap_builder *AXIS2_CALL
axiom_soap_body_get_builder(
axiom_soap_body_t * soap_body,
const axutil_env_t * env);
#ifdef __cplusplus
}
#endif
#endif /* AXIOM_SOAP_BODY_H */
|
