summaryrefslogtreecommitdiffstats
path: root/src/core/deployment/axis2_arch_file_data.h
blob: d27d065aac6d7cf5515422ac8d926ef55a55b765 (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
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
253
254
255
256
257
258
259
260
261
262
263
264
265
/*
 * 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_ARCH_FILE_DATA_H
#define AXIS2_ARCH_FILE_DATA_H

/** @defgroup axis2_arch_file_data Arch File Data
 * @ingroup axis2_deployment
 * @{
 */

/**
 * @file axis2_arch_file_data.h
 * @brief Axis2 Arch File Data interface. arch_file_data construct contain 
 * deployment information retrieved from a module or service configuration file.
 */
#include <axis2_const.h>
#include <axutil_error.h>
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axutil_allocator.h>
#include <axutil_qname.h>
#include <axis2_conf.h>
#include <axutil_array_list.h>
#include <axutil_dir_handler.h>
#include <axutil_file.h>

#ifdef __cplusplus
extern "C"
{
#endif

    struct axis2_conf;

    /** Type name for struct axis2_arch_fila_data */
    typedef struct axis2_arch_file_data axis2_arch_file_data_t;

    /**
     * De-allocate memory
     * @param arch_file_data pointer to arch_file_data
     * @param env pointer to environment struct
     * @return void
     */
    AXIS2_EXTERN void AXIS2_CALL
    axis2_arch_file_data_free(
        axis2_arch_file_data_t * arch_file_data,
        const axutil_env_t * env);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL
    axis2_arch_file_data_get_msg_recv(
        const axis2_arch_file_data_t * file_data,
        const axutil_env_t * env);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     * @param msg_recv pointer to message receiver
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axis2_arch_file_data_set_msg_recv(
        axis2_arch_file_data_t * file_data,
        const axutil_env_t * env,
        axis2_char_t * msg_recv);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     * @return the name of the contained file.
     */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL
    axis2_arch_file_data_get_name(
        const axis2_arch_file_data_t * file_data,
        const axutil_env_t * env);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     * @return the service name. If contained file is not null this is the
     * file name. else this is the name property
     */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL
    axis2_arch_file_data_get_svc_name(
        const axis2_arch_file_data_t * file_data,
        const axutil_env_t * env);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN int AXIS2_CALL
    axis2_arch_file_data_get_type(
        const axis2_arch_file_data_t * file_data,
        const axutil_env_t * env);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axutil_file_t *AXIS2_CALL
    axis2_arch_file_data_get_file(
        const axis2_arch_file_data_t * file_data,
        const axutil_env_t * env);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL

    axis2_arch_file_data_get_module_name(
        const axis2_arch_file_data_t * file_data,
        const axutil_env_t * env);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     * @param module_name pointer to module_name
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_arch_file_data_set_module_name(
        axis2_arch_file_data_t * file_data,
        const axutil_env_t * env,
        axis2_char_t * module_name);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL

    axis2_arch_file_data_get_module_dll_name(
        const axis2_arch_file_data_t * file_data,
        const axutil_env_t * env);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_arch_file_data_set_module_dll_name(
        axis2_arch_file_data_t * file_data,
        const axutil_env_t * env,
        axis2_char_t * module_dll_name);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axis2_arch_file_data_add_svc(
        axis2_arch_file_data_t * file_data,
        const axutil_env_t * env,
        struct axis2_svc *svc_desc);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN struct axis2_svc *AXIS2_CALL
                axis2_arch_file_data_get_svc(
                    const axis2_arch_file_data_t * file_data,
                    const axutil_env_t * env,
                    axis2_char_t * svc_name);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
    axis2_arch_file_data_get_svc_map(
        const axis2_arch_file_data_t * file_data,
        const axutil_env_t * env);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL

    axis2_arch_file_data_get_deployable_svcs(
        const axis2_arch_file_data_t * file_data,
        const axutil_env_t * env);

    /**
     * @param file_data pointer to arch_file_data
     * @param env pointer to environment struct
     * @param deployable_svcs pointer to deployable services
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_arch_file_data_set_deployable_svcs(
        axis2_arch_file_data_t * file_data,
        const axutil_env_t * env,
        axutil_array_list_t * deployable_svcs);

    /**
     * Creates arch file data struct
     * @param env pointer to environment struct
     * @return pointer to newly created arch file data
     */
    AXIS2_EXTERN axis2_arch_file_data_t *AXIS2_CALL

    axis2_arch_file_data_create(
        const axutil_env_t * env);

    /**
     * Creates arch file data struct
     * @param env pointer to environment struct
     * @param type type
     * @param file folder name of service or module
     * @return pointer to newly created arch file data
     */
    AXIS2_EXTERN axis2_arch_file_data_t *AXIS2_CALL

    axis2_arch_file_data_create_with_type_and_file(
        const axutil_env_t * env,
        int type,
        axutil_file_t * file);

    /**
     * Creates arch file data struct
     * @param env pointer to environment struct
     * @param type type
     * @param name pointer to name
     * @return pointer to newly created arch file data
     */
    AXIS2_EXTERN axis2_arch_file_data_t *AXIS2_CALL

    axis2_arch_file_data_create_with_type_and_name(
        const axutil_env_t * env,
        int type,
        const axis2_char_t * name);

    /** @} */

#ifdef __cplusplus
}
#endif
#endif                          /* AXIS2_ARCH_FILE_DATA_H */