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
|
/*
* 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_BUILDER_H
#define AXIOM_SOAP_BUILDER_H
#include <axiom_stax_builder.h>
#include <axiom_soap_envelope.h>
#include <axiom_mime_parser.h>
/**
* @file axiom_soap_builder.h
* @brief axiom_soap_builder struct
*/
#ifdef __cplusplus
extern "C"
{
#endif
typedef struct axiom_soap_builder axiom_soap_builder_t;
/**
* @defgroup axiom_soap_builder soap builder
* @ingroup axiom_soap
* @{
*/
/**
* creates a axiom_soap_builder struct
* @param env Environment. MUST NOT be NULL
* @param builder Stax builder
* @return the created SOAP Builder
*/
AXIS2_EXTERN axiom_soap_builder_t *AXIS2_CALL
axiom_soap_builder_create(
const axutil_env_t * env,
axiom_stax_builder_t * builder,
const axis2_char_t * soap_version);
/**
* Free the SOAP Builder
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
*
* @return VOID
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_soap_builder_free(
axiom_soap_builder_t * builder,
const axutil_env_t * env);
/**
* Get the SOAP envelope of the SOAP builder
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
*
* @return the SOAP envelope
*/
AXIS2_EXTERN axiom_soap_envelope_t *AXIS2_CALL
axiom_soap_builder_get_soap_envelope(
axiom_soap_builder_t * builder,
const axutil_env_t * env);
/**
* Get the OM document of the SOAP Buidler
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
*
* @return the OM document
*/
AXIS2_EXTERN axiom_document_t *AXIS2_CALL
axiom_soap_builder_get_document(
axiom_soap_builder_t * builder,
const axutil_env_t * env);
/**
* Builds next element of the OM structure
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
* @return AXIS2_SUCCESS if the next element is present else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_soap_builder_next(
axiom_soap_builder_t * builder,
const axutil_env_t * env);
/**
*
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
*
* @return the axiom_node of the OM document
*/
AXIS2_EXTERN axiom_node_t *AXIS2_CALL
axiom_soap_builder_get_document_element(
axiom_soap_builder_t * builder,
const axutil_env_t * env);
/**
*
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
*
* @return AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_soap_builder_set_bool_processing_mandatory_fault_elements(
axiom_soap_builder_t * builder,
const axutil_env_t * env,
axis2_bool_t value);
/**
*
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
*
* @return AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_soap_builder_set_processing_detail_elements(
axiom_soap_builder_t * builder,
const axutil_env_t * env,
axis2_bool_t value);
/**
*
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
*
* @return AXIS2_TRUE if the the element is present, AXIS2_FALSE otherwise
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axiom_soap_builder_is_processing_detail_elements(
axiom_soap_builder_t * builder,
const axutil_env_t * env);
/**
* Get the SOAP version
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
*
* @return the SOAP version
*/
AXIS2_EXTERN int AXIS2_CALL
axiom_soap_builder_get_soap_version(
axiom_soap_builder_t * builder,
const axutil_env_t * env);
/**
* Set the MIME body parts
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
*
* @return AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_soap_builder_set_mime_body_parts(
axiom_soap_builder_t * builder,
const axutil_env_t * env,
axutil_hash_t * map);
/**
* Get the MIME body parts
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
*
* @return hash of mime body parts
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axiom_soap_builder_get_mime_body_parts(
axiom_soap_builder_t * builder,
const axutil_env_t * env);
/**
* Set the mime_parser
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
* @paran mime_parser pointer to a axiom_mime_parser_t instance
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_soap_builder_set_mime_parser(
axiom_soap_builder_t * builder,
const axutil_env_t * env,
axiom_mime_parser_t *mime_parser);
/**
* Set the callback function
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
* @param callback to the callback function pointer
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_soap_builder_set_callback_function(
axiom_soap_builder_t * builder,
const axutil_env_t * env,
AXIS2_READ_INPUT_CALLBACK callback);
/**
* Set the callback_ctx
* @param builder pointer to the SOAP Builder struct
* @param env Environment. MUST NOT be NULL
* @param void pointer to the callback_ctx
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_soap_builder_set_callback_ctx(
axiom_soap_builder_t * builder,
const axutil_env_t * env,
void *callback_ctx);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_soap_builder_create_attachments(
axiom_soap_builder_t * builder,
const axutil_env_t * env,
void *user_param,
axis2_char_t *callback_name);
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axiom_soap_builder_replace_xop(
axiom_soap_builder_t * builder,
const axutil_env_t * env,
axiom_node_t *om_element_node,
axiom_element_t *om_element);
AXIS2_EXTERN axiom_stax_builder_t *AXIS2_CALL
axiom_soap_builder_get_om_builder(
axiom_soap_builder_t * builder,
const axutil_env_t * env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIOM_SOAP_BUILDER_H */
|
