summaryrefslogtreecommitdiffstats
path: root/src/core/deployment/axis2_svc_builder.h
blob: c71e7dccf5d145f71c4d031edf8c5af702dd323d (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
/*
 * 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_SVC_BUILDER_H
#define AXIS2_SVC_BUILDER_H

/**
 * @defgroup axis2_svc_builder Service Builder
 * @ingroup axis2_deployment
 * @{
 */

#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_desc_builder.h>
#include <axis2_addr.h>
#include <axis2_dep_engine.h>

#ifdef __cplusplus
extern "C"
{
#endif

    struct axis2_dep_engine;

    /** Type name for struct axis2_svc_builder */
    typedef struct axis2_svc_builder axis2_svc_builder_t;

    /**
     * De-allocate memory
     * @param svc_builder pointer to service builder
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN void AXIS2_CALL
    axis2_svc_builder_free(
        axis2_svc_builder_t * svc_builder,
        const axutil_env_t * env);

    /**
     * top most method that is used to populate service from corresponding OM
     * @param svc_builder pointer to service builder
     * @param env pointer to environment struct
     * @param svc_node pointer to service node
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axis2_svc_builder_populate_svc(
        axis2_svc_builder_t * svc_builder,
        const axutil_env_t * env,
        axiom_node_t * svc_node);

    /**
     * @param svc_builder pointer to service builder
     * @param env pointer to environment struct
     * @param module_confs pointer to module configurations
     * @param parent pointer to parent
     * @param svc pointer to service
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_svc_builder_process_svc_module_conf(
        axis2_svc_builder_t * svc_builder,
        const axutil_env_t * env,
        axiom_children_qname_iterator_t * module_confs,
        axutil_param_container_t * parent,
        axis2_svc_t * svc);

    /**
     * To get the list og modules that is requird to be engage globally
     * @param svc_builder pointer to service builder
     * @param env pointer to environment struct
     * @param module_refs pointer to module refs
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_svc_builder_process_module_refs(
        axis2_svc_builder_t * svc_builder,
        const axutil_env_t * env,
        axiom_children_qname_iterator_t * module_refs);

    AXIS2_EXTERN struct axis2_desc_builder *AXIS2_CALL

                axis2_svc_builder_get_desc_builder(
                    const axis2_svc_builder_t * svc_builder,
                    const axutil_env_t * env);

    /**
     * Creates svc builder struct
     * @param env pointer to environment struct
     * @return pointer to newly created service builder
     */
    AXIS2_EXTERN axis2_svc_builder_t *AXIS2_CALL
    axis2_svc_builder_create(
        const axutil_env_t * env);

    /**
     * Creates svc builder struct
     * @param env pointer to environment struct
     * @param file_name pointer to file name
     * @param dep_engine pointer to deployment engine
     * @param svc pointer to service
     * @return pointer to newly created service builder
     */
    AXIS2_EXTERN axis2_svc_builder_t *AXIS2_CALL

    axis2_svc_builder_create_with_file_and_dep_engine_and_svc(
        const axutil_env_t * env,
        axis2_char_t * file_name,
        struct axis2_dep_engine *dep_engine,
        axis2_svc_t * svc);

    /**
     * Creates svc builder struct
     * @param env pointer to environment struct
     * @param dep_engine pointer to deployment engine
     * @param svc pointer to service
     * @return pointer to newly created service builder
     */
    AXIS2_EXTERN axis2_svc_builder_t *AXIS2_CALL

    axis2_svc_builder_create_with_dep_engine_and_svc(
        const axutil_env_t * env,
        struct axis2_dep_engine *dep_engine,
        axis2_svc_t * svc);

    /** @} */

#ifdef __cplusplus
}
#endif
#endif                          /* AXIS2_SVC_BUILDER_H */