/usr/include/axis2-1.6.0/axis2_module_desc.h is in libaxis2c-dev 1.6.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 | /*
* 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_MODULE_DESC_H
#define AXIS2_MODULE_DESC_H
/**
* @defgroup axis2_module_desc module description
* @ingroup axis2_desc
* module holds information about a module. This information includes module
* parameters and handler information.
* Modules are available to all services if axis2.xml has a module reference
* entry. Alternatively, a module could be made available to selected services
* by including a module reference entry in services.xml.
* @{
*/
/**
* @file axis2_module_desc.h
*/
#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 <axutil_param_container.h>
#include <axis2_flow_container.h>
#include <axutil_param.h>
#include <axis2_op.h>
#include <axis2_conf.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_module_desc */
typedef struct axis2_module_desc axis2_module_desc_t;
struct axis2_op;
struct axis2_conf;
/**
* Frees module description.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_module_desc_free(
axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* Gets flow representing in flow.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return pointer to flow that represents in flow, returns a reference
* not a cloned copy
*/
AXIS2_EXTERN axis2_flow_t *AXIS2_CALL
axis2_module_desc_get_in_flow(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* Sets flow representing in flow.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @param in_flow pointer to flow representing in flow, module assumes
* ownership of flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_module_desc_set_in_flow(
axis2_module_desc_t * module_desc,
const axutil_env_t * env,
axis2_flow_t * in_flow);
/**
* Gets flow representing out flow.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return pointer to flow that represents out flow, returns a reference
* not a cloned copy
*/
AXIS2_EXTERN axis2_flow_t *AXIS2_CALL
axis2_module_desc_get_out_flow(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* Sets flow representing out flow.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @param out_flow pointer to flow representing out flow, module assumes
* ownership of flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_module_desc_set_out_flow(
axis2_module_desc_t * module_desc,
const axutil_env_t * env,
axis2_flow_t * out_flow);
/**
* Gets flow representing fault in flow.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return pointer to flow that represents fault in flow, returns a reference
* not a cloned copy
*/
AXIS2_EXTERN axis2_flow_t *AXIS2_CALL
axis2_module_desc_get_fault_in_flow(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* Sets flow representing fault in flow.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @param falut_in_flow pointer to flow representing fault in flow,
* module assumes ownership of flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_module_desc_set_fault_in_flow(
axis2_module_desc_t * module_desc,
const axutil_env_t * env,
axis2_flow_t * falut_in_flow);
/**
* Gets flow representing fault out flow.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return pointer to flow that represents fault out flow, returns a
* reference not a cloned copy
*/
AXIS2_EXTERN axis2_flow_t *AXIS2_CALL
axis2_module_desc_get_fault_out_flow(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* Sets flow representing fault out flow.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @param fault_out_flow pointer to flow representing fault out flow,
* module assumes ownership of flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_module_desc_set_fault_out_flow(
axis2_module_desc_t * module_desc,
const axutil_env_t * env,
axis2_flow_t * fault_out_flow);
/**
* Gets module QName.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return pointer to QName
*/
AXIS2_EXTERN const axutil_qname_t *AXIS2_CALL
axis2_module_desc_get_qname(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* Sets module QName.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @param qname pointer to qname
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_module_desc_set_qname(
axis2_module_desc_t * module_desc,
const axutil_env_t * env,
const axutil_qname_t * qname);
/**
* Adds given operation to module.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @param op pointer to operation, module assumes ownership of operation
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_module_desc_add_op(
axis2_module_desc_t * module_desc,
const axutil_env_t * env,
struct axis2_op *op);
/**
* Gets all operations associated with module.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return pointer to hash map containing the operations
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_module_desc_get_all_ops(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* Gets parent which is of type configuration.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return pointer to configuration, returns a reference not a
* cloned copy
*/
AXIS2_EXTERN struct axis2_conf *AXIS2_CALL
axis2_module_desc_get_parent(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* Sets parent which is of type configuration.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @param parent pointer to parent configuration, module does not assume
* the ownership of configuration
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_module_desc_set_parent(
axis2_module_desc_t * module_desc,
const axutil_env_t * env,
struct axis2_conf *parent);
/**
* Adds parameter to module description.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @param param pointer to parameter struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_module_desc_add_param(
axis2_module_desc_t * module_desc,
const axutil_env_t * env,
axutil_param_t * param);
/**
* Gets parameter with given name.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @param name parameter name string
* @return pointer to parameter corresponding to given name
*/
AXIS2_EXTERN axutil_param_t *AXIS2_CALL
axis2_module_desc_get_param(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env,
const axis2_char_t * name);
/**
* Gets all parameters associated with module.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return pointer to array list containing all parameters
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_module_desc_get_all_params(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* Checks if a given parameter is locked.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @param param_name parameter name string
* @return AXIS2_TRUE if named parameter is locked, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_module_desc_is_param_locked(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env,
const axis2_char_t * param_name);
/**
* Gets module associated with module description.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return pointer to module
*/
AXIS2_EXTERN struct axis2_module *AXIS2_CALL
axis2_module_desc_get_module(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @param module pointer to module, module description assumes ownership
* of module
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_module_desc_set_module(
axis2_module_desc_t * module_desc,
const axutil_env_t * env,
struct axis2_module *module);
/**
* Gets the container having all params.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return pointer to param container
* @sa axutil_param_container
*/
AXIS2_EXTERN axutil_param_container_t *AXIS2_CALL
axis2_module_desc_get_param_container(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* Gets the container having all flows.
* @param module_desc pointer to module description
* @param env pointer to environment struct
* @return pointer to param container
* @sa axis2_flow_container
*/
AXIS2_EXTERN axis2_flow_container_t *AXIS2_CALL
axis2_module_desc_get_flow_container(
const axis2_module_desc_t * module_desc,
const axutil_env_t * env);
/**
* Creates module description struct instance.
* @param env pointer to environment struct
* @return pointer to newly created module description
*/
AXIS2_EXTERN axis2_module_desc_t *AXIS2_CALL
axis2_module_desc_create(
const axutil_env_t * env);
/**
* Creates module description struct instance with given QName.
* @param env pointer to environment struct
* @param qname pointer to QName
* @return pointer to newly created module description
*/
AXIS2_EXTERN axis2_module_desc_t *AXIS2_CALL
axis2_module_desc_create_with_qname(
const axutil_env_t * env,
const axutil_qname_t * qname);
/**
* Frees module description passed as void pointer. This method will cast
* the void pointer parameter into appropriate type and then call module
* description free method on top of that pointer.
* @param module_desc pointer to module description as a void pointer
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_module_desc_free_void_arg(
void *module_desc,
const axutil_env_t * env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_MODULE_DESC_H */
|