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
|
/*
* 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_PHASES_INFO_H
#define AXIS2_PHASES_INFO_H
/** @defgroup axis2_phases_info phases information
* @ingroup axis2_deployment
*
* In deployment engine when configuration builder parse phase order elements in axis2.xml, for
* phases defined in a phase order it will create a phase name list and add it to the phases
* info. There are four phase orders. inflow, outflow, in faultflow and out faultflow.
* So configuration builder add array lists for each of this phase orders into the phases info.
*
* At the time of module engagement phase resolver call the functions here to retrieve phase
* lists for each flow for the purpose of adding handlers. When such a request come what each
* function do is, create phase instances list for corresponding phase names stored in the phase name
* list for that flow and return.
*
* @{
*/
#include <axis2_const.h>
#include <axutil_error.h>
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axutil_allocator.h>
#include <axutil_string.h>
#include <axutil_array_list.h>
#include <axis2_op.h>
#include <axis2_phase.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_phases_info */
typedef struct axis2_phases_info axis2_phases_info_t;
/** Deallocate memory
* @param pahses_info pointer to phases info
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_phases_info_free(
axis2_phases_info_t * phases_info,
const axutil_env_t * env);
/**
* Set the inflow phase names as an array list. These phases are defined in the inflow phase
* order element defined in axis2.xml.
*
* @param phases_info pointer to phases info
* @param env pointer to environment struct
* @param in_phases inter to in phases
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phases_info_set_in_phases(
axis2_phases_info_t * phases_info,
const axutil_env_t * env,
axutil_array_list_t * in_phases);
/**
* Set the outflow phase names as an array list. These phases are defined in the outflow phase
* order element defined in axis2.xml.
*
* @param phases_info pointer to phases info
* @param env pointer to environment struct
* @param out_phases pointer to out phases
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phases_info_set_out_phases(
axis2_phases_info_t * phases_info,
const axutil_env_t * env,
axutil_array_list_t * out_phases);
/**
* Set the INfaultflow phase names as an array list. These phases are defined in the INfaultflow
* phase order element defined in axis2.xml.
*
* @param phases_info pointer to phases info
* @param env pointer to environment struct
* @param in_faultphases pionter to in fault phases
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phases_info_set_in_faultphases(
axis2_phases_info_t * phases_info,
const axutil_env_t * env,
axutil_array_list_t * in_faultphases);
/**
* Set the Outfaultflow phase names as an array list. These phases are defined in the
* Outfaultflow phase order element defined in axis2.xml.
*
* @param phases_info pointer to phases info
* @param env pointer to env
* @param out_faultphases pointer to out fault phases
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phases_info_set_out_faultphases(
axis2_phases_info_t * phases_info,
const axutil_env_t * env,
axutil_array_list_t * out_faultphases);
/**
* @param phases_info pointer to phases info
* @param env pointer to environment struct
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_phases_info_get_in_phases(
const axis2_phases_info_t * phases_info,
const axutil_env_t * env);
/**
* @param phases_info pointer to phases info
* @param env pointer to environment struct
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_phases_info_get_out_phases(
const axis2_phases_info_t * phases_info,
const axutil_env_t * env);
/**
* @param phases_info pointer to phases info
* @parma env pointer to environment struct
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_phases_info_get_in_faultphases(
const axis2_phases_info_t * phases_info,
const axutil_env_t * env);
/**
* @param phases_info pointer to phases info
* @param env pointer to environment struct
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_phases_info_get_out_faultphases(
const axis2_phases_info_t * phases_info,
const axutil_env_t * env);
/**
* @param phases_info pointer to phases info
* @param env pointer to environment struct
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_phases_info_get_op_in_phases(
const axis2_phases_info_t * phases_info,
const axutil_env_t * env);
/**
* @param phases_info pointer to phases info
* @param env pointer to environment struct
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_phases_info_get_op_out_phases(
const axis2_phases_info_t * phases_info,
const axutil_env_t * env);
/**
* @param phases_info pointer to phases info
* @param env pointer to environment struct
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_phases_info_get_op_in_faultphases(
const axis2_phases_info_t * phases_info,
const axutil_env_t * env);
/**
* @param phases_info pointer to phases info
* @param env pointer to environment struct
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_phases_info_get_op_out_faultphases(
const axis2_phases_info_t * phases_info,
const axutil_env_t * env);
/**
* @param phases_info pointer to phases info
* @param env pointer to environment struct
* @param axis2_opt pointer to axis2 opt
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phases_info_set_op_phases(
axis2_phases_info_t * phases_info,
const axutil_env_t * env,
struct axis2_op *axis2_opt);
/** create Phases Info struct
* @param env pointer to environment struct
* @return pointer to newly created phases info
*/
AXIS2_EXTERN axis2_phases_info_t *AXIS2_CALL
axis2_phases_info_create(
const axutil_env_t * env);
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_phases_info_copy_flow(
const axutil_env_t * env,
const axutil_array_list_t * flow_to_copy);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /*AXIS2_PHASES_INFO_H */
|
