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
|
/*
* 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_PHASE_RULE_H
#define AXIS2_PHASE_RULE_H
/**
* @defgroup axis2_phase_rule phase rule
* @ingroup axis2_desc
* phase rule encapsulates data and operations related to phase rules for a
* given handler. phase rule lives within a handler.
* phase rules of a handler specify the relative location of the
* handler within the phase to which it belongs, with respect to other handlers
* in the phase or first and last positions of the handler chain of the phase.
* @{
*/
/**
* @file axis2_phase_rule.h
*/
#include <axis2_defines.h>
#include <axutil_qname.h>
#include <axutil_param.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_phase_rule */
typedef struct axis2_phase_rule axis2_phase_rule_t;
/**
* Gets the name of the handler before which the handler associated with
* this rule should be placed.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @return name of handler before which the handler should be placed
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_phase_rule_get_before(
const axis2_phase_rule_t * phase_rule,
const axutil_env_t * env);
/**
* Sets the name of the handler before which the handler associated with
* this rule should be placed.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @param before name of handler before which the handler should be placed
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_rule_set_before(
axis2_phase_rule_t * phase_rule,
const axutil_env_t * env,
const axis2_char_t * before);
/**
* Gets the name of the handler after which the handler associated with
* this rule should be placed.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @return name of handler after which the handler should be placed
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_phase_rule_get_after(
const axis2_phase_rule_t * phase_rule,
const axutil_env_t * env);
/**
* Sets the name of the handler after which the handler associated with
* this rule should be placed.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @param after name of handler after which the handler should be placed
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_rule_set_after(
axis2_phase_rule_t * phase_rule,
const axutil_env_t * env,
const axis2_char_t * after);
/**
* Gets name.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @return name string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_phase_rule_get_name(
const axis2_phase_rule_t * phase_rule,
const axutil_env_t * env);
/**
* Sets name.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @param name name string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_rule_set_name(
axis2_phase_rule_t * phase_rule,
const axutil_env_t * env,
const axis2_char_t * name);
/**
* Checks if the handler is the first in phase.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @return AXIS2_TRUE if the handler associated with this rule is the
* first in phase, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_phase_rule_is_first(
const axis2_phase_rule_t * phase_rule,
const axutil_env_t * env);
/**
* Sets handler to be the first in phase.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @param first AXIS2_TRUE if the handler associated with this rule is the
* first in phase, else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_rule_set_first(
axis2_phase_rule_t * phase_rule,
const axutil_env_t * env,
axis2_bool_t first);
/**
* Checks if the handler is the last in phase.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @return AXIS2_TRUE if the handler associated with this rule is the
* last in phase, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_phase_rule_is_last(
const axis2_phase_rule_t * phase_rule,
const axutil_env_t * env);
/**
* Sets handler to be the last in phase.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @param last AXIS2_TRUE if the handler associated with this rule is the
* last in phase, else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_phase_rule_set_last(
axis2_phase_rule_t * phase_rule,
const axutil_env_t * env,
axis2_bool_t last);
/**
* Frees phase rule.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_phase_rule_free(
axis2_phase_rule_t * phase_rule,
const axutil_env_t * env);
/**
* Clones phase rule.
* @param phase_rule pointer to phase rule
* @param env pointer to environment struct
* @return pointer to newly cloned phase rule
*/
AXIS2_EXTERN axis2_phase_rule_t *AXIS2_CALL
axis2_phase_rule_clone(
axis2_phase_rule_t * phase_rule,
const axutil_env_t * env);
/**
* Creates a phase rule struct instance.
* @param env pointer to environment struct
* @param phase_name name of the phase rule
* @return pointer to newly created phase rule
*/
AXIS2_EXTERN axis2_phase_rule_t *AXIS2_CALL
axis2_phase_rule_create(
const axutil_env_t * env,
const axis2_char_t * name);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_PHASE_RULE_H */
|
