/usr/include/axis2-1.6.0/axis2_conf.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 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 | /*
* 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_CONFIG_H
#define AXIS2_CONFIG_H
/**
* @defgroup axis2_engine engine
* @ingroup axis2
* @{
* @}
*/
/**
* @defgroup axis2_config configuration
* @ingroup axis2_engine
* Axis2 configuration captures all configuration information. Configuration
* information includes user preferences along with module and
* service information that is either statically configured using axis2.xml
* file, service.xml files and module.xml files or dynamically using the
* functions defined in the ops struct related to this conf struct.
* @{
*/
/**
* @file axis2_config.h
*/
#include <axutil_param_container.h>
#include <axis2_svc_grp.h>
#include <axis2_transport_in_desc.h>
#include <axis2_transport_out_desc.h>
#include <axutil_qname.h>
#include <axutil_hash.h>
#include <axis2_phases_info.h>
#include <axis2_msg_recv.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_conf */
typedef struct axis2_conf axis2_conf_t;
struct axis2_msg_recv;
struct axis2_phases_info;
struct axis2_svc_grp;
struct axis2_svc;
struct axis2_op;
struct axis2_dep_engine;
struct axis2_desp;
/**
* Frees conf struct.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_conf_free(
axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Adds a service group to the configuration.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param svc_grp pointer to service group, conf takes over the
* ownership of the service group
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_add_svc_grp(
axis2_conf_t * conf,
const axutil_env_t * env,
struct axis2_svc_grp *svc_grp);
/**
* Gets a named service group.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param svc_grp_name name of the service group to be accessed
* @return pointer to service group with the given name if exists,
* else NULL. Returns a reference, not a cloned copy
*/
AXIS2_EXTERN struct axis2_svc_grp *AXIS2_CALL
axis2_conf_get_svc_grp(
const axis2_conf_t * conf,
const axutil_env_t * env,
const axis2_char_t * svc_grp_name);
/**
* Gets all service group added to conf.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return pointer to hash table containing the service groups, returns
* a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_conf_get_all_svc_grps(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Adds a service to configuration.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param svc pointer to service, conf takes over the ownership of the
* service
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_add_svc(
axis2_conf_t * conf,
const axutil_env_t * env,
struct axis2_svc *svc);
/**
* Gets a service with given name.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param svc_name service name string
* @return pointer to service with the given name if exists, else NULL.
* Returns a reference, not a cloned copy
*/
AXIS2_EXTERN struct axis2_svc *AXIS2_CALL
axis2_conf_get_svc(
const axis2_conf_t * conf,
const axutil_env_t * env,
const axis2_char_t * svc_name);
/**
* Removes the named service from configuration.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param name name of service to be removed
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_remove_svc(
axis2_conf_t * conf,
const axutil_env_t * env,
const axis2_char_t * name);
/**
* Adds a parameter to configuration.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param param pointer to parameter struct to be added
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_add_param(
axis2_conf_t * conf,
const axutil_env_t * env,
axutil_param_t * param);
/**
* Gets a parameter with the given name.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param name name of the parameter to be accessed
* @return pointer to parameter with the given name if exists, else NULL.
* Returns a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_param_t *AXIS2_CALL
axis2_conf_get_param(
const axis2_conf_t * conf,
const axutil_env_t * env,
const axis2_char_t * name);
/**
* Gets all the parameters added to the configuration.
* @param conf pointer to conf struct
* @param env pointer to environment
* @return pointer to array list containing parameters if exists,
* else NULL. Returns a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_conf_get_all_params(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Checks if the named parameter is locked.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param param_name name of the parameter
* @return AXIS2_TRUE if parameter is locked, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_conf_is_param_locked(
const axis2_conf_t * conf,
const axutil_env_t * env,
const axis2_char_t * param_name);
/**
* Gets in transport corresponding to the given transport QName.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param qname QName of transport
* @return pointer to transport in description if exists,
* else NULL. Returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_transport_in_desc_t *AXIS2_CALL
axis2_conf_get_transport_in(
const axis2_conf_t * conf,
const axutil_env_t * env,
const AXIS2_TRANSPORT_ENUMS trans_enum);
/**
* Adds a transport in description.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param transport pointer to transport in description. conf assumes
* ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_add_transport_in(
axis2_conf_t * conf,
const axutil_env_t * env,
axis2_transport_in_desc_t * transport,
const AXIS2_TRANSPORT_ENUMS trans_enum);
/**
* Gets out transport corresponding to the given transport QName.
* @param conf pointer to conf struct
* @param env pointer to environment strcut
* @param qname pointer to transport qname
* @return pointer to transport out description if exists,
* else NULL. Returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_transport_out_desc_t *AXIS2_CALL
axis2_conf_get_transport_out(
const axis2_conf_t * conf,
const axutil_env_t * env,
const AXIS2_TRANSPORT_ENUMS trans_enum);
/**
* Adds a transport out description.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param transport pointer to transport out description. conf assumes
* ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_add_transport_out(
axis2_conf_t * conf,
const axutil_env_t * env,
axis2_transport_out_desc_t * transport,
const AXIS2_TRANSPORT_ENUMS trans_enum);
/**
* Gets all in transports.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return hash table containing all transport in descriptions.
* Returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_transport_in_desc_t **AXIS2_CALL
axis2_conf_get_all_in_transports(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Gets all out transports.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return hash table containing all transport out descriptions.
* Returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_transport_out_desc_t **AXIS2_CALL
axis2_conf_get_all_out_transports(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Gets a module with given QName.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param qname pointer to qname
* @return module description corresponding to the given qname
*/
AXIS2_EXTERN struct axis2_module_desc *AXIS2_CALL
axis2_conf_get_module(
const axis2_conf_t * conf,
const axutil_env_t * env,
const axutil_qname_t * qname);
/**
* Gets the list of engaged modules.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return a pointer to the array list of engaged modules. Returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_conf_get_all_engaged_modules(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Gets the in phases up to and including port dispatch phase.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return a pointer to the array list of in phases up to post dispatch
* inclusive. Returns a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_conf_get_in_phases_upto_and_including_post_dispatch(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Gets the out flow. Out flow is a list of phases invoked in the out
* path of execution of the engine.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return a pointer to the array list of out flow phases. Returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_conf_get_out_flow(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Gets the in fault flow. In fault flow is a list of phases invoked in
* the in path of execution, if some fault happens.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return a pointer to the array list of in fault flow phases. Returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_conf_get_in_fault_flow(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Gets the out fault flow. Out fault flow is a list of phases invoked in
* the out path of execution, if some fault happens.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return a pointer to the array list of out fault flow phases. Returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_conf_get_out_fault_flow(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Gets faulty services. A faulty service is a service that does not
* meet the service configuration criteria or a service with errors in
* the service dynamic link library.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return a pointer to the hash table of faulty services. Returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_conf_get_all_faulty_svcs(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Gets faulty modules. A faulty module is a module that does not
* meet the module configuration criteria or a module with errors in
* the service dynamic link library.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return a pointer to the hash table of faulty modules. Returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_conf_get_all_faulty_modules(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Gets all the list of services loaded into configuration.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return a pointer to the hash table of services. Returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_conf_get_all_svcs(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Gets all the list of services that need to be loaded into configuration
* at the start up of the axis2 engine.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return a pointer to the hash table of services. Returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_conf_get_all_svcs_to_load(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Checks is the named module is engaged.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param module_name pointer to QName representing the module name
* @return AXIS2_TRUE if named module is engaged, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_conf_is_engaged(
axis2_conf_t * conf,
const axutil_env_t * env,
const axutil_qname_t * module_name);
/**
* Gets phases information struct.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return a pointer to the struct containing phases information.
* Returns a reference, not a cloned copy
*/
AXIS2_EXTERN struct axis2_phases_info *AXIS2_CALL
axis2_conf_get_phases_info(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Sets phases information struct.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param phases_info pointer to phases_info struct. conf assumes
* ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_phases_info(
axis2_conf_t * conf,
const axutil_env_t * env,
struct axis2_phases_info *phases_info);
/**
* Adds message receiver with the given key.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param key key string with which the message receive is to be added
* @param msg_recv pointer to message receiver
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_add_msg_recv(
axis2_conf_t * conf,
const axutil_env_t * env,
const axis2_char_t * key,
struct axis2_msg_recv *msg_recv);
/**
* Gets message receiver with the given key.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param key key string corresponding to the message receiver to
* be retrieved
* @return pointer to the message receiver with the given key if it
* exists, else null. Returns a reference, not a cloned copy
*/
AXIS2_EXTERN struct axis2_msg_recv *AXIS2_CALL
axis2_conf_get_msg_recv(
const axis2_conf_t * conf,
const axutil_env_t * env,
axis2_char_t * key);
/**
* Sets the list of out phases.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param out_phases pointer to array list of the phases. conf assumes
* ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_out_phases(
axis2_conf_t * conf,
const axutil_env_t * env,
axutil_array_list_t * out_phases);
/**
* Gets the list of out phases.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return pointer to array list of out phases. Returns a reference,
* not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_conf_get_out_phases(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Sets fault phases for in path.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param list pointer to array list of phases
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_in_fault_phases(
axis2_conf_t * conf,
const axutil_env_t * env,
axutil_array_list_t * list);
/**
* Sets fault phases for out path.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param list pointer to array list of phases
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_out_fault_phases(
axis2_conf_t * conf,
const axutil_env_t * env,
axutil_array_list_t * list);
/**
* Gets all modules configured,
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return a pointer to hash table containing the list of modules.
* Returns a reference, not a cloned copy
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_conf_get_all_modules(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Adds a module.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param module pointer to module struct to be added
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_add_module(
axis2_conf_t * conf,
const axutil_env_t * env,
struct axis2_module_desc *module);
/**
* Sets the default dispatchers.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_default_dispatchers(
axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Sets a custom dispatching phase.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param dispatch pointer to phase to be dispatched
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_dispatch_phase(
axis2_conf_t * conf,
const axutil_env_t * env,
axis2_phase_t * dispatch);
/**
* Gets the repository location.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return returns repository location as a string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_conf_get_repo(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Sets the repository location.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param axis2_repo repository location as a string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_repo(
axis2_conf_t * conf,
const axutil_env_t * env,
axis2_char_t * axis2_repo);
/**
* Gets the axis2.xml location.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @return returns repository location as a string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_conf_get_axis2_xml(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Sets the axis2.xml location.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param axis2_xml repository location as a string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_axis2_xml(
axis2_conf_t * conf,
const axutil_env_t * env,
axis2_char_t * axis2_xml);
/**
* Engages the named module.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param module_ref pointer to the QName of the module to be engaged
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_engage_module(
axis2_conf_t * conf,
const axutil_env_t * env,
const axutil_qname_t * module_ref);
/**
* Sets the deployment engine.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param dep_engine pointer to dep_engine struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_dep_engine(
axis2_conf_t * conf,
const axutil_env_t * env,
struct axis2_dep_engine *dep_engine);
/**
* Gets the default module version for the named module.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param module_name module name string
* @return default module version as a string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_conf_get_default_module_version(
const axis2_conf_t * conf,
const axutil_env_t * env,
const axis2_char_t * module_name);
/**
* Gets the default module reference for the named module.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param module_name module name string
* @return pointer to the module description struct corresponding to
* the given name
*/
AXIS2_EXTERN struct axis2_module_desc *AXIS2_CALL
axis2_conf_get_default_module(
const axis2_conf_t * conf,
const axutil_env_t * env,
const axis2_char_t * module_name);
/**
* Adds a default module version for the named module.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param module_name name of the module
* @param module_version default version for the module
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_add_default_module_version(
axis2_conf_t * conf,
const axutil_env_t * env,
const axis2_char_t * module_name,
const axis2_char_t * module_version);
/**
* Engages the module with the given version.
* @param conf pointer to conf struct
* @param env pointer to environment struct
* @param module_name name of the module to be engaged
* @param version_id version of the module to be engaged
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_engage_module_with_version(
axis2_conf_t * conf,
const axutil_env_t * env,
const axis2_char_t * module_name,
const axis2_char_t * version_id);
/**
* Creates configuration struct.
* @param env pointer to environment struct
* @return pointer to newly created configuration
*/
AXIS2_EXTERN axis2_conf_t *AXIS2_CALL
axis2_conf_create(
const axutil_env_t * env);
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_conf_get_enable_mtom(
axis2_conf_t * conf,
const axutil_env_t * env);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_enable_mtom(
axis2_conf_t * conf,
const axutil_env_t * env,
axis2_bool_t enable_mtom);
/**
* set a flag to mark conf created by axis2.xml
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_conf_get_axis2_flag(
axis2_conf_t * conf,
const axutil_env_t * env);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_axis2_flag(
axis2_conf_t * conf,
const axutil_env_t * env,
axis2_bool_t axis2_flag);
/*The following two methods are used in Rampart to
*check whether security is engaed. */
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_conf_get_enable_security(
axis2_conf_t * conf,
const axutil_env_t * env);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_enable_security(
axis2_conf_t * conf,
const axutil_env_t * env,
axis2_bool_t enable_security);
AXIS2_EXTERN void *AXIS2_CALL
axis2_conf_get_security_context(
axis2_conf_t * conf,
const axutil_env_t * env);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_conf_set_security_context(
axis2_conf_t * conf,
const axutil_env_t * env,
void *security_context);
AXIS2_EXTERN axutil_param_container_t *AXIS2_CALL
axis2_conf_get_param_container(
const axis2_conf_t * conf,
const axutil_env_t * env);
/**
* Gets base description.
* @param conf pointer to message
* @param env pointer to environment struct
* @return pointer to base description struct
*/
AXIS2_EXTERN axis2_desc_t *AXIS2_CALL
axis2_conf_get_base(
const axis2_conf_t * conf,
const axutil_env_t * env);
AXIS2_EXTERN axutil_array_list_t * AXIS2_CALL
axis2_conf_get_handlers(const axis2_conf_t * conf,
const axutil_env_t * env);
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_CONFIG_H */
|