/usr/include/axis2-1.6.0/axis2_svc.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 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 | /*
* 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_H
#define AXIS2_SVC_H
/** @defgroup axis2_svc service
* @ingroup axis2_desc
* service represents the static structure of a service in a service group.
* In Axis2 description hierarchy, a service lives inside the service group to
* which it belongs.
* services are configured in services.xml files located in the respective
* service group folders of the services folder in the repository.
* In services.xml file, services are declared in association with a given
* service group or at top level as a stand alone service. In cases where a
* service is configured without an associated service group, a service group
* with the same name as that of the service would be created by the deployment
* engine and the service would be associated with that newly created service
* group. The deployment engine would create service instances to represent
* those configured services in services.xml files and would associate them with
* the respective service group in the configuration.
* service encapsulates data on engaged module information, the XML schema
* defined in WSDL that is associated with the service and the operations of
* the service.
* @{
*/
/**
* @file axis2_svc.h
*/
#include <axutil_param_container.h>
#include <axis2_flow_container.h>
#include <axis2_op.h>
#include <axis2_svc_grp.h>
#include <axutil_qname.h>
#include <axutil_error.h>
#include <axutil_array_list.h>
#include <axis2_const.h>
#include <axis2_phase_resolver.h>
#include <axis2_module_desc.h>
#include <axis2_conf.h>
#include <axutil_string.h>
#include <axutil_stream.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_svc */
typedef struct axis2_svc axis2_svc_t;
struct axis2_svc_grp;
struct axis2_flow_container;
struct axutil_param_container;
struct axis2_module_desc;
struct axis2_conf;
/**
* Frees service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_svc_free(
axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Adds operation.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param op pointer to operation struct, service assumes ownership of
* operation
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_add_op(
axis2_svc_t * svc,
const axutil_env_t * env,
struct axis2_op *op);
/**
* Gets operation corresponding to the given QName.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param op_qname pointer to QName representing operation QName
* @return pointer to operation corresponding to given QName
*/
AXIS2_EXTERN struct axis2_op *AXIS2_CALL
axis2_svc_get_op_with_qname(
const axis2_svc_t * svc,
const axutil_env_t * env,
const axutil_qname_t * op_qname);
/**
* Gets the RESTful operation list corresponding to the given method
* and first constant part of location.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param http_method HTTPMethod
* @param http_location HTTPLocation
* @return pointer to operation corresponding to given method and
* location
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_svc_get_rest_op_list_with_method_and_location(
const axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * http_method,
const axis2_char_t * http_location);
/**
* Gets the RESTful operation map for a given service
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to hash with the information
* (method, url)=> processing structure for each ops
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_svc_get_rest_map(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Gets operation corresponding to the name.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param op_name operation name string
* @return pointer to operation corresponding to given name
*/
AXIS2_EXTERN struct axis2_op *AXIS2_CALL
axis2_svc_get_op_with_name(
const axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * op_name);
/**
* Gets all operations of service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to hash map containing all operations of the service
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_svc_get_all_ops(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Sets parent which is of type service group.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param svc_grp pointer to parent service group
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_parent(
axis2_svc_t * svc,
const axutil_env_t * env,
struct axis2_svc_grp *svc_grp);
/**
* Gets parent which is of type service group.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to parent service group
*/
AXIS2_EXTERN struct axis2_svc_grp *AXIS2_CALL
axis2_svc_get_parent(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Sets QName.
* @param svc pointer to service struct
* @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_svc_set_qname(
axis2_svc_t * svc,
const axutil_env_t * env,
const axutil_qname_t * qname);
/**
* Gets QName.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to QName
*/
AXIS2_EXTERN const axutil_qname_t *AXIS2_CALL
axis2_svc_get_qname(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Adds given parameter to operation.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param param pointer to parameter, service assumes ownership of
* parameter
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_add_param(
axis2_svc_t * svc,
const axutil_env_t * env,
axutil_param_t * param);
/**
* Gets named parameter.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param name name string
* @return pointer to named parameter if exists, else NULL. Returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_param_t *AXIS2_CALL
axis2_svc_get_param(
const axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * name);
/**
* Gets all parameters stored within service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to array list of parameters, returns a reference,
* not a cloned copy
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_svc_get_all_params(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Checks if the named parameter is locked.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param param_name parameter name
* @return AXIS2_TRUE if the named parameter is locked, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_svc_is_param_locked(
axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * param_name);
/**
* Engages given module to service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param module_desc pointer to module description to be engaged,
* service does not assume the ownership of module
* @param conf pointer to configuration, it is configuration that holds
* module information
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_engage_module(
axis2_svc_t * svc,
const axutil_env_t * env,
struct axis2_module_desc *module_desc,
struct axis2_conf *conf);
/**
* Disengages given module from service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param module_desc pointer to module description to be engaged,
* service does not assume the ownership of module
* @param conf pointer to configuration, it is configuration that holds
* module information
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_disengage_module(
axis2_svc_t * svc,
const axutil_env_t * env,
struct axis2_module_desc *module_desc,
struct axis2_conf *conf);
/**
* Check whether a given module is engaged to the service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param module_qname pointer to module qname to be engaged,
* @return AXIS2_TRUE if module is engaged, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_svc_is_module_engaged(
axis2_svc_t * svc,
const axutil_env_t * env,
axutil_qname_t * module_qname);
/**
* Return the engaged module list.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return engaged module list
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_svc_get_engaged_module_list(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Adds operations defined in a module to this service. It is possible
* to define operations that are associated to a module in a module.xml
* file. These operations in turn could be invoked in relation to a
* service. This method allows those module related operation to be
* added to a service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param module_desc pointer to module description containing module
* related operation information. service does not assume the ownership
* of module description
* @param conf pointer to configuration, it is configuration that stores
* the modules
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_add_module_ops(
axis2_svc_t * svc,
const axutil_env_t * env,
struct axis2_module_desc *module_desc,
struct axis2_conf *axis2_config);
/**
* Adds given module description to engaged module list.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param module_desc pointer to module description, service does not
* assume the ownership of module description
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_add_to_engaged_module_list(axis2_svc_t *svc,
const axutil_env_t *env,
struct axis2_module_desc *module_desc); */
/**
* Gets all engaged modules.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to array list containing all engaged modules
*/
/*AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_svc_get_all_engaged_modules(const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Sets style. Style can be either RPC or document literal.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param style style of service as defined in WSDL
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_style(
axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * style);
/**
* Gets style. Style can be either RPC or document literal.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return string representing the style of service
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_style(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Gets in flow. In flow is the list of phases invoked
* along in path.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to flow representing in flow
*/
/*AXIS2_EXTERN struct axis2_flow *AXIS2_CALL
axis2_svc_get_in_flow(const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Sets in flow. In flow is the list of phases invoked
* along in path.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param in_flow pointer to flow representing in flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_in_flow(axis2_svc_t *svc,
const axutil_env_t *env,
struct axis2_flow *in_flow); */
/**
* Gets out flow. Out flow is the list of phases invoked
* along out path.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to flow representing out flow
*/
/*AXIS2_EXTERN struct axis2_flow *AXIS2_CALL
axis2_svc_get_out_flow(
const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Sets out flow. Out flow is the list of phases invoked
* along out path.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return out_flow pointer to flow representing out flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_out_flow(
axis2_svc_t *svc,
const axutil_env_t *env,
struct axis2_flow *out_flow); */
/**
* Gets fault in flow. Fault in flow is the list of phases invoked
* along in path if a fault happens.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to flow representing fault in flow
*/
/*AXIS2_EXTERN struct axis2_flow *AXIS2_CALL
axis2_svc_get_fault_in_flow(
const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Sets fault in flow. Fault in flow is the list of phases invoked
* along in path if a fault happens.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param fault_flow pointer to flow representing fault in flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_fault_in_flow(
axis2_svc_t *svc,
const axutil_env_t *env,
struct axis2_flow *fault_flow); */
/**
* Gets fault out flow. Fault out flow is the list of phases invoked
* along out path if a fault happens.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to flow representing fault out flow
*/
/*AXIS2_EXTERN struct axis2_flow *AXIS2_CALL
axis2_svc_get_fault_out_flow(
const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Sets fault out flow. Fault out flow is the list of phases invoked
* along out path if a fault happens.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param fault_flow pointer to flow representing fault out flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_fault_out_flow(
axis2_svc_t *svc,
const axutil_env_t *env,
struct axis2_flow *fault_flow); */
/**
* Gets operation corresponding to given SOAP Action.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param soap_action SOAP action string
* @return pointer to operation corresponding to given SOAP action if
* one exists, else NULL. Returns a reference, not a cloned copy
*/
AXIS2_EXTERN struct axis2_op *AXIS2_CALL
axis2_svc_get_op_by_soap_action(
const axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * soap_action);
/**
* Gets operation corresponding to given SOAP Action and endpoint QName.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param soap_action SOAP action string
* @param endpoint pointer QName representing endpoint URI
* @return pointer operation corresponding to given SOAP Action and
* endpoint QName.
*/
/*AXIS2_EXTERN struct axis2_op *AXIS2_CALL
axis2_svc_get_op_by_soap_action_and_endpoint(
const axis2_svc_t *svc,
const axutil_env_t *env,
const axis2_char_t *soap_action,
const axutil_qname_t *endpoint); */
/**
* Gets service name.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return service name string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_name(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Sets service name.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param svc_name service name string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_name(
axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * svc_name);
/**
* Sets current time as last update time of the service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_last_update(
axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Gets last update time of the service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return last updated time in seconds
*/
AXIS2_EXTERN long AXIS2_CALL
axis2_svc_get_last_update(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Get the description of the services, which is in the
* service.xml, <description> tag
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return services description string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_svc_desc(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Set the description of the service which is in service.xml
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_svc_desc(
axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * svc_desc);
/**
* Get the static wsdl file of the services, which is in the
* service.xml, wsdl_path parameter
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return static wsdl file location
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_svc_wsdl_path(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Set the wsdl path of the service which is in service.xml
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_svc_wsdl_path(
axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * wsdl_path);
/**
* Get the folder path on disk of the services, which is in the
* service.xml
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return folder path on disk
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_svc_folder_path(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Set the folder path of the service which is in service.xml
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_svc_folder_path(
axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * folder_path);
/**
* Gets the name of the file that holds the implementation of the
* service. service implementation is compiled into shared libraries
* and is placed in the respective sub folder in the services folder
* of Axis2 repository.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return file name string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_file_name(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Sets the name of the file that holds the implementation of the
* service. service implementation is compiled into shared libraries
* and is placed in the respective sub folder in the services folder
* of Axis2 repository.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param file_name file name string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_file_name(
axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * file_name);
/**
* Gets all endpoints associated with the service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to hash map containing all endpoints
*/
/*AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_svc_get_all_endpoints(
const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Sets the list of endpoints associated with the service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param endpoints pointer to hash map containing all endpoints
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_all_endpoints(
axis2_svc_t *svc,
const axutil_env_t *env,
axutil_hash_t *endpoints); */
/**
* Gets namespace.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return namespace URI string
*/
/*AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_namespace(
const axis2_svc_t *svc,
const axutil_env_t *env);
*/
/**
* Adds WS-Addressing mapping for a given operation. The services.xml
* configuration file could specify a SOAP action that would map to
* one of the service operations. This method could be used to register
* that mapping against operations. WS-Addressing based dispatcher
* makes use of this mapping to identify the operation to be invoked,
* given WSA action.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param wsa_action WSA action string
* @param op pointer to operation that maps to the given WSA action
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_add_mapping(
axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * wsa_action,
struct axis2_op *axis2_op);
/**
* Adds a REST mapping for a given RESTful operation. The services.xml
* configuration file could specify a HTTP Method and Location that would
* map to one of the service operations. This method could be used to register
* that mapping against operations. The REST based dispatcher makes use
* of this mapping to identify the operation to be invoked, given the URL.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param method REST HTTP Method
* @param location REST HTTP Location
* @param op pointer to operation that maps to the given WSA action
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_add_rest_mapping(
axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * method,
const axis2_char_t * location,
struct axis2_op *axis2_op);
/**
* Adds a module qname to list of module QNames associated with service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param module_qname pointer to QName to be added, this method clones
* the QName
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_add_module_qname(
axis2_svc_t * svc,
const axutil_env_t * env,
const axutil_qname_t * module_qname);
/**
* Gets all module QNames associated with the service as a list.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to array list containing QNames
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_svc_get_all_module_qnames(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Checks if the XML schema location is adjusted.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return AXIS2_TRUE if XML schema is adjusted, else AXIS2_FALSE
*/
/*AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_svc_is_schema_location_adjusted(
axis2_svc_t *svc,
const axutil_env_t *env);
*/
/**
* Sets the bool value indicating if the XML schema location is adjusted.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param adjusted AXIS2_TRUE if XML schema is adjusted, else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_schema_location_adjusted(
axis2_svc_t *svc,
const axutil_env_t *env,
const axis2_bool_t adjusted); */
/**
* Gets XML schema mapping table for service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to hash map with XML schema mappings, returns a
* reference, not a cloned copy
*/
/*
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_svc_axis2_svc_get_schema_mapping_table(
const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Sets XML schema mapping table for service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param table pointer to hash map with XML schema mappings, service
* assumes ownership of the map
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_schema_mapping_table(
axis2_svc_t *svc,
const axutil_env_t *env,
axutil_hash_t *table); */
/**
* Gets custom schema prefix.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return custom schema prefix string
*/
/*
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_custom_schema_prefix(
const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Sets custom schema prefix.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param prefix custom schema prefix string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_custom_schema_prefix(
axis2_svc_t *svc,
const axutil_env_t *env,
const axis2_char_t *prefix); */
/**
* Gets custom schema suffix.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return custom schema suffix string
*/
/*
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_custom_schema_suffix(
const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Sets custom schema suffix.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param suffix custom schema suffix string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_custom_schema_suffix(
axis2_svc_t *svc,
const axutil_env_t *env,
const axis2_char_t *suffix); */
/**
* Prints the schema to given stream.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param out_stream stream to print to
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_print_schema(
axis2_svc_t *svc,
const axutil_env_t *env,
axutil_stream_t *out_stream); */
/**
* Gets the XML schema at the given index of XML schema array list.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param index index of the XML schema to be retrieved
* @return pointer to XML schema, returns a reference, not a cloned copy
*/
/*AXIS2_EXTERN xml_schema_t *AXIS2_CALL
axis2_svc_get_schema(
const axis2_svc_t *svc,
const axutil_env_t *env,
const int index); */
/**
* Adds all namespaces in the namespace map to the XML schema at
* the given index of the XML schema array list.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param index index of the XML schema to be processed
* @return pointer to XML schema with namespaces added,
* returns a reference, not a cloned copy
*/
/* AXIS2_EXTERN xml_schema_t *AXIS2_CALL
axis2_svc_add_all_namespaces(
axis2_svc_t *svc,
const axutil_env_t *env,
int index);*/
/**
* Gets the list of XML schemas associated with service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to array list of XML schemas, returns a reference,
* not a cloned copy
*/
/*
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_svc_get_all_schemas(
const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Adds the given XML schema to the list of XML schemas associated
* with the service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param schema pointer to XML schema struct, service assumes the
* ownership of struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_add_schema(
axis2_svc_t *svc,
const axutil_env_t *env,
xml_schema_t *schema); */
/**
* Adds the list of all XML schemas to service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param schemas pointer to array list containing XML schemas
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_add_all_schemas(
axis2_svc_t *svc,
const axutil_env_t *env,
axutil_array_list_t *schemas); */
/**
* Gets XML schema's target namespace.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return XML schema target namespace string
*/
/*
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_schema_target_ns(
const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Sets XML schema's target namespace.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param ns namespace string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_schema_target_ns(
axis2_svc_t *svc,
const axutil_env_t *env,
const axis2_char_t *ns); */
/**
* Gets XML schema's target namespace prefix.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return XML schema target namespace prefix string
*/
/*
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_schema_target_ns_prefix(
const axis2_svc_t *svc,
const axutil_env_t *env); */
/**
* Sets XML schema's target namespace prefix.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param prefix namespace prefix string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_schema_target_ns_prefix(
axis2_svc_t *svc,
const axutil_env_t *env,
const axis2_char_t *prefix); */
/**
* Gets target namespace.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return target namespace as a string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_target_ns(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Sets target namespace.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param ns target namespace as a string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
saxis2_svc_et_target_ns(
axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * ns);
/**
* Gets target namespace prefix.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return target namespace prefix string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_svc_get_target_ns_prefix(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Sets target namespace prefix.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param prefix target namespace prefix string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_target_ns_prefix(
axis2_svc_t * svc,
const axutil_env_t * env,
const axis2_char_t * prefix);
/**
* Gets XML schemas element corresponding to the given QName.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param qname QName of the XML schema element to be retrieved
* @return pointer to XML schema element, returns a reference, not a
* cloned copy
*/
/*AXIS2_EXTERN xml_schema_element_t *AXIS2_CALL
axis2_svc_get_schema_element(
const axis2_svc_t *svc,
const axutil_env_t *env,
const axutil_qname_t *qname); */
/**
* Gets the namespace map with all namespaces related to service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return pointer to hash map containing all namespaces, returns a
* reference, not a cloned copy
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
gaxis2_svc_et_ns_map(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Sets the namespace map with all namespaces related to service.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @param ns_map pointer to hash map containing all namespaces
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_ns_map(
axis2_svc_t * svc,
const axutil_env_t * env,
axutil_hash_t * ns_map);
/**
* Populates the schema mappings. This method is used in code generation
* and WSDL generation (WSDL2C and C2WSDL). This method deals with the
* imported schemas that would be there in the WSDL.
* @param svc pointer to service struct
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
/*AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_populate_schema_mappings(
axis2_svc_t *svc,
const axutil_env_t *env); */
AXIS2_EXTERN axutil_param_container_t *AXIS2_CALL
axis2_svc_get_param_container(
const axis2_svc_t * svc,
const axutil_env_t * env);
AXIS2_EXTERN axis2_flow_container_t *AXIS2_CALL
axis2_svc_get_flow_container(
const axis2_svc_t * svc,
const axutil_env_t * env);
/**
* Creates a service struct instance.
* @param env pointer to environment struct
* @return pointer to newly created service
*/
AXIS2_EXTERN axis2_svc_t *AXIS2_CALL
axis2_svc_create(
const axutil_env_t * env);
/**
* Creates a service struct with given QName.
* @param env pointer to environment struct
* @param qname service QName
* @return pointer to newly created service
*/
AXIS2_EXTERN axis2_svc_t *AXIS2_CALL
axis2_svc_create_with_qname(
const axutil_env_t * env,
const axutil_qname_t * qname);
AXIS2_EXTERN void *AXIS2_CALL
axis2_svc_get_impl_class(
const axis2_svc_t * svc,
const axutil_env_t * env);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_set_impl_class(
axis2_svc_t * svc,
const axutil_env_t * env,
void *impl_class);
/**
* Gets base description.
* @param svc pointer to message
* @param env pointer to environment struct
* @return pointer to base description struct
*/
AXIS2_EXTERN axis2_desc_t *AXIS2_CALL
axis2_svc_get_base(
const axis2_svc_t * svc,
const axutil_env_t * env);
/* Get the mutex associated with this service
* @param svc pointer to message
* @param env pointer to environment struct
* @return pointer to a axutil_thread_mutext_t
*/
AXIS2_EXTERN axutil_thread_mutex_t * AXIS2_CALL
axis2_svc_get_mutex(
const axis2_svc_t * svc,
const axutil_env_t * env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_SVC_H */
|