summaryrefslogtreecommitdiffstats
path: root/include/axis2_policy_include.h
blob: c088aeb0ccdfd0ed7901e896040891e67c2c083d (plain)
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
/*
 * 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_POLICY_INCLUDE_H
#define AXIS2_POLICY_INCLUDE_H

/**
 * @defgroup axis2_policy_include policy include
 * @ingroup axis2_desc
 * @{
 */

#include <axutil_array_list.h>
#include <axis2_desc.h>
#include <neethi_policy.h>
#include <neethi_registry.h>
#include <neethi_reference.h>

#ifdef __cplusplus
extern "C"
{
#endif

    /** Type name for struct axis2_policy_include */
    typedef struct axis2_policy_include axis2_policy_include_t;

    typedef enum axis2_policy_types
    {
        AXIS2_POLICY = 0,
        AXIS2_MODULE_POLICY,
        AXIS2_SERVICE_POLICY,
        AXIS2_OPERATION_POLICY,
        AXIS2_MESSAGE_POLICY,
        AXIS2_PORT_POLICY,
        AXIS2_PORT_TYPE_POLICY,
        AXIS2_BINDING_POLICY,
        AXIS2_BINDING_OPERATION_POLICY,
        AXIS2_INPUT_POLICY,
        AXIS2_OUTPUT_POLICY,
        AXIS2_BINDING_INPUT_POLICY,
        AXIS2_BINDING_OUTPUT_POLICY,
        AXIS2_MODULE_OPERATION_POLICY,
        AXIS2_POLICY_REF,
        AXIS2_ANON_POLICY
    } axis2_policy_types;

    /**
     * Creates policy include struct.
     * @param env pointer to environment struct
     * @return pointer to newly created policy include
     */
    AXIS2_EXTERN axis2_policy_include_t *AXIS2_CALL

    axis2_policy_include_create(
        const axutil_env_t * env);

    AXIS2_EXTERN axis2_policy_include_t *AXIS2_CALL

    axis2_policy_include_create_with_desc(
        const axutil_env_t * env,
        axis2_desc_t * desc);

    /**
     * Frees policy include.
     * @param policy_include pointer to policy include
     * @param env pointer to environment struct
     * @return void
     */
    AXIS2_EXTERN void AXIS2_CALL
    axis2_policy_include_free(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env);

    AXIS2_EXTERN void AXIS2_CALL
    axis2_policy_include_free(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axis2_policy_include_set_registry(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env,
        neethi_registry_t * registry);

    AXIS2_EXTERN neethi_registry_t *AXIS2_CALL

    axis2_policy_include_get_registry(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axis2_policy_include_set_policy(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env,
        neethi_policy_t * policy);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_policy_include_update_policy(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env,
        neethi_policy_t * policy);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_policy_include_set_effective_policy(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env,
        neethi_policy_t * effective_policy);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axis2_policy_include_set_desc(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env,
        axis2_desc_t * desc);

    AXIS2_EXTERN axis2_desc_t *AXIS2_CALL
    axis2_policy_include_get_desc(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env);

    AXIS2_EXTERN axis2_policy_include_t *AXIS2_CALL

    axis2_policy_include_get_parent(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env);

    AXIS2_EXTERN neethi_policy_t *AXIS2_CALL
    axis2_policy_include_get_policy(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env);

    AXIS2_EXTERN neethi_policy_t *AXIS2_CALL

    axis2_policy_include_get_effective_policy(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env);

    AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL

    axis2_policy_include_get_policy_elements(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env);

    AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL

    axis2_policy_include_get_policy_elements_with_type(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env,
        int type);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_policy_include_register_policy(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env,
        axis2_char_t * key,
        neethi_policy_t * effective_policy);

    AXIS2_EXTERN neethi_policy_t *AXIS2_CALL

    axis2_policy_include_get_policy_with_key(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env,
        axis2_char_t * key);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_policy_include_add_policy_element(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env,
        int type,
        neethi_policy_t * policy);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_policy_include_add_policy_reference_element(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env,
        int type,
        neethi_reference_t * reference);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_policy_include_remove_policy_element(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env,
        axis2_char_t * policy_uri);

    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_policy_include_remove_all_policy_element(
        axis2_policy_include_t * policy_include,
        const axutil_env_t * env);

    /** @} */
#ifdef __cplusplus
}
#endif
#endif                          /* AXIS2_POLICY_INCLUDE_H */