# axis2_options.h

Go to the documentation of this file.

    00001
    00002 /*
    00003 * Licensed to the Apache Software Foundation (ASF) under one or more
    00004 * contributor license agreements.  See the NOTICE file distributed with
    00005 * this work for additional information regarding copyright ownership.
    00006 * The ASF licenses this file to You under the Apache License, Version 2.0
    00007 * (the "License"); you may not use this file except in compliance with
    00008 * the License.  You may obtain a copy of the License at
    00009 *
    00010 *      http://www.apache.org/licenses/LICENSE-2.0
    00011 *
    00012 * Unless required by applicable law or agreed to in writing, software
    00013 * distributed under the License is distributed on an "AS IS" BASIS,
    00014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    00015 * See the License for the specific language governing permissions and
    00016 * limitations under the License.
    00017 */
    00018
    00019 #ifndef AXIS2_OPTIONS_H
    00020 #define AXIS2_OPTIONS_H
    00021
    00035 #include <axis2_defines.h>
    00036 #include <axutil_env.h>
    00037 #include <axis2_transport_in_desc.h>
    00038 #include <axis2_endpoint_ref.h>
    00039 #include <axutil_hash.h>
    00040 #include <axis2_relates_to.h>
    00041 #include <axis2_transport_out_desc.h>
    00042 #include <axis2_transport_receiver.h>
    00043 #include <axiom_element.h>
    00044 #include <axis2_msg_info_headers.h>
    00045
    00047 #define AXIS2_DEFAULT_TIMEOUT_MILLISECONDS 30000
    00048
    00050 #define AXIS2_TIMEOUT_IN_SECONDS "time_out"
    00051
    00053 #define AXIS2_COPY_PROPERTIES   "copy_properties"
    00054
    00055 #ifdef __cplusplus
    00056 extern "C"
    00057 {
    00058 #endif
    00059
    00061     typedef struct axis2_options axis2_options_t;
    00062
    00069     AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
    00070     axis2_options_get_action(
    00071         const axis2_options_t * options,
    00072         const axutil_env_t * env);
    00073
    00081     AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
    00082     axis2_options_get_fault_to(
    00083         const axis2_options_t * options,
    00084         const axutil_env_t * env);
    00085
    00093     AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
    00094     axis2_options_get_from(
    00095         const axis2_options_t * options,
    00096         const axutil_env_t * env);
    00097
    00104     AXIS2_EXTERN axis2_transport_receiver_t *AXIS2_CALL
    00105     axis2_options_get_transport_receiver(
    00106         const axis2_options_t * options,
    00107         const axutil_env_t * env);
    00108
    00115     AXIS2_EXTERN axis2_transport_in_desc_t *AXIS2_CALL
    00116     axis2_options_get_transport_in(
    00117         const axis2_options_t * options,
    00118         const axutil_env_t * env);
    00119
    00126     AXIS2_EXTERN AXIS2_TRANSPORT_ENUMS AXIS2_CALL
    00127     axis2_options_get_transport_in_protocol(
    00128         const axis2_options_t * options,
    00129         const axutil_env_t * env);
    00130
    00137     AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
    00138     axis2_options_get_message_id(
    00139         const axis2_options_t * options_t,
    00140         const axutil_env_t * env);
    00141
    00148     AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
    00149     axis2_options_get_properties(
    00150         const axis2_options_t * options,
    00151         const axutil_env_t * env);
    00152
    00160     AXIS2_EXTERN void *AXIS2_CALL
    00161     axis2_options_get_property(
    00162         const axis2_options_t * options,
    00163         const axutil_env_t * env,
    00164         const axis2_char_t * key);
    00165
    00172     AXIS2_EXTERN axis2_relates_to_t *AXIS2_CALL
    00173     axis2_options_get_relates_to(
    00174         const axis2_options_t * options,
    00175         const axutil_env_t * env);
    00176
    00184     AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
    00185     axis2_options_get_reply_to(
    00186         const axis2_options_t * options,
    00187         const axutil_env_t * env);
    00188
    00195     AXIS2_EXTERN axis2_transport_out_desc_t *AXIS2_CALL
    00196     axis2_options_get_transport_out(
    00197         const axis2_options_t * options,
    00198         const axutil_env_t * env);
    00199
    00206     AXIS2_EXTERN AXIS2_TRANSPORT_ENUMS AXIS2_CALL
    00207     axis2_options_get_sender_transport_protocol(
    00208         const axis2_options_t * options,
    00209         const axutil_env_t * env);
    00210
    00217     AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
    00218     axis2_options_get_soap_version_uri(
    00219         const axis2_options_t * options,
    00220         const axutil_env_t * env);
    00221
    00229     AXIS2_EXTERN long AXIS2_CALL
    00230     axis2_options_get_timeout_in_milli_seconds(
    00231         const axis2_options_t * options,
    00232         const axutil_env_t * env);
    00233
    00241     AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
    00242     axis2_options_get_to(
    00243         const axis2_options_t * options,
    00244         const axutil_env_t * env);
    00245
    00252     AXIS2_EXTERN axis2_bool_t AXIS2_CALL
    00253     axis2_options_get_use_separate_listener(
    00254         const axis2_options_t * options,
    00255         const axutil_env_t * env);
    00256
    00263     AXIS2_EXTERN axis2_options_t *AXIS2_CALL
    00264     axis2_options_get_parent(
    00265         const axis2_options_t * options,
    00266         const axutil_env_t * env);
    00267
    00275     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00276     axis2_options_set_parent(
    00277         axis2_options_t * options,
    00278         const axutil_env_t * env,
    00279         const axis2_options_t * parent);
    00280
    00288     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00289     axis2_options_set_action(
    00290         axis2_options_t * options,
    00291         const axutil_env_t * env,
    00292         const axis2_char_t * action);
    00293
    00302     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00303     axis2_options_set_fault_to(
    00304         axis2_options_t * options,
    00305         const axutil_env_t * env,
    00306         axis2_endpoint_ref_t * fault_to);
    00307
    00316     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00317     axis2_options_set_from(
    00318         axis2_options_t * options,
    00319         const axutil_env_t * env,
    00320         axis2_endpoint_ref_t * from);
    00321
    00330     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00331     axis2_options_set_to(
    00332         axis2_options_t * options,
    00333         const axutil_env_t * env,
    00334         axis2_endpoint_ref_t * to);
    00335
    00344     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00345     axis2_options_set_transport_receiver(
    00346         axis2_options_t * options,
    00347         const axutil_env_t * env,
    00348         axis2_transport_receiver_t * receiver);
    00349
    00358     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00359     axis2_options_set_transport_in(
    00360         axis2_options_t * options,
    00361         const axutil_env_t * env,
    00362         axis2_transport_in_desc_t * transport_in);
    00363
    00371     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00372     axis2_options_set_transport_in_protocol(
    00373         axis2_options_t * options,
    00374         const axutil_env_t * env,
    00375         const AXIS2_TRANSPORT_ENUMS transport_in_protocol);
    00376
    00384     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00385     axis2_options_set_message_id(
    00386         axis2_options_t * options,
    00387         const axutil_env_t * env,
    00388         const axis2_char_t * message_id);
    00389
    00398     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00399     axis2_options_set_properties(
    00400         axis2_options_t * options,
    00401         const axutil_env_t * env,
    00402         axutil_hash_t * properties);
    00403
    00412     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00413     axis2_options_set_property(
    00414         axis2_options_t * options,
    00415         const axutil_env_t * env,
    00416         const axis2_char_t * property_key,
    00417         const void *property);
    00418
    00427     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00428     axis2_options_set_relates_to(
    00429         axis2_options_t * options,
    00430         const axutil_env_t * env,
    00431         axis2_relates_to_t * relates_to);
    00432
    00441     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00442     axis2_options_set_reply_to(
    00443         axis2_options_t * options,
    00444         const axutil_env_t * env,
    00445         axis2_endpoint_ref_t * reply_to);
    00446
    00455     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00456     axis2_options_set_transport_out(
    00457         axis2_options_t * options,
    00458         const axutil_env_t * env,
    00459         axis2_transport_out_desc_t * transport_out);
    00460
    00470     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00471     axis2_options_set_sender_transport(
    00472         axis2_options_t * options,
    00473         const axutil_env_t * env,
    00474         const AXIS2_TRANSPORT_ENUMS sender_transport,
    00475         axis2_conf_t * conf);
    00476
    00486     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00487     axis2_options_set_soap_version_uri(
    00488         axis2_options_t * options,
    00489         const axutil_env_t * env,
    00490         const axis2_char_t * soap_version_uri);
    00491
    00499     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00500     axis2_options_set_timeout_in_milli_seconds(
    00501         axis2_options_t * options,
    00502         const axutil_env_t * env,
    00503         const long timeout_in_milli_seconds);
    00504
    00517     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00518     axis2_options_set_transport_info(
    00519         axis2_options_t * options,
    00520         const axutil_env_t * env,
    00521         const AXIS2_TRANSPORT_ENUMS sender_transport,
    00522         const AXIS2_TRANSPORT_ENUMS receiver_transport,
    00523         const axis2_bool_t use_separate_listener);
    00524
    00533     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00534     axis2_options_set_use_separate_listener(
    00535         axis2_options_t * options,
    00536         const axutil_env_t * env,
    00537         const axis2_bool_t use_separate_listener);
    00538
    00547     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00548     axis2_options_add_reference_parameter(
    00549         axis2_options_t * options,
    00550         const axutil_env_t * env,
    00551         axiom_node_t * reference_parameter);
    00552
    00559     AXIS2_EXTERN axis2_bool_t AXIS2_CALL
    00560     axis2_options_get_manage_session(
    00561         const axis2_options_t * options,
    00562         const axutil_env_t * env);
    00563
    00571     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00572     axis2_options_set_manage_session(
    00573         axis2_options_t * options,
    00574         const axutil_env_t * env,
    00575         const axis2_bool_t manage_session);
    00576
    00584     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00585     axis2_options_set_msg_info_headers(
    00586         axis2_options_t * options,
    00587         const axutil_env_t * env,
    00588         axis2_msg_info_headers_t * msg_info_headers);
    00589
    00597     AXIS2_EXTERN axis2_msg_info_headers_t *AXIS2_CALL
    00598     axis2_options_get_msg_info_headers(
    00599         const axis2_options_t * options,
    00600         const axutil_env_t * env);
    00601
    00608     AXIS2_EXTERN int AXIS2_CALL
    00609     axis2_options_get_soap_version(
    00610         const axis2_options_t * options,
    00611         const axutil_env_t * env);
    00612
    00620     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00621     axis2_options_set_soap_version(
    00622         axis2_options_t * options,
    00623         const axutil_env_t * env,
    00624         const int soap_version);
    00625
    00634     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00635     axis2_options_set_enable_mtom(
    00636         axis2_options_t * options,
    00637         const axutil_env_t * env,
    00638         axis2_bool_t enable_mtom);
    00639
    00646     AXIS2_EXTERN axis2_bool_t AXIS2_CALL
    00647     axis2_options_get_enable_mtom(
    00648         const axis2_options_t * options,
    00649         const axutil_env_t * env);
    00650
    00657     AXIS2_EXTERN axutil_string_t *AXIS2_CALL
    00658     axis2_options_get_soap_action(
    00659         const axis2_options_t * options,
    00660         const axutil_env_t * env);
    00661
    00669     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00670     axis2_options_set_soap_action(
    00671         axis2_options_t * options,
    00672         const axutil_env_t * env,
    00673         axutil_string_t * soap_action);
    00674
    00682     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00683     axis2_options_set_xml_parser_reset(
    00684         axis2_options_t * options,
    00685         const axutil_env_t * env,
    00686         const axis2_bool_t paser_reset_flag);
    00687
    00694     AXIS2_EXTERN axis2_bool_t AXIS2_CALL
    00695     axis2_options_get_xml_parser_reset(
    00696         const axis2_options_t * options,
    00697         const axutil_env_t * env);
    00698
    00705     AXIS2_EXTERN void AXIS2_CALL
    00706     axis2_options_free(
    00707         axis2_options_t * options,
    00708         const axutil_env_t * env);
    00709
    00718     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00719     axis2_options_set_enable_rest(
    00720         axis2_options_t * options,
    00721         const axutil_env_t * env,
    00722         const axis2_bool_t enable_rest);
    00723
    00733     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00734     axis2_options_set_test_http_auth(
    00735         axis2_options_t * options,
    00736         const axutil_env_t * env,
    00737         const axis2_bool_t test_http_auth);
    00738
    00748     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00749     axis2_options_set_test_proxy_auth(
    00750         axis2_options_t * options,
    00751         const axutil_env_t * env,
    00752         const axis2_bool_t test_proxy_auth);
    00753
    00762     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00763     axis2_options_set_http_method(
    00764         axis2_options_t * options,
    00765         const axutil_env_t * env,
    00766         const axis2_char_t * http_method);
    00767
    00776     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00777     axis2_options_set_http_headers(
    00778         axis2_options_t * options,
    00779         const axutil_env_t * env,
    00780         axutil_array_list_t * http_header_list);
    00781
    00788     AXIS2_EXTERN axis2_options_t *AXIS2_CALL
    00789     axis2_options_create(
    00790         const axutil_env_t * env);
    00791
    00800     AXIS2_EXTERN axis2_options_t *AXIS2_CALL
    00801     axis2_options_create_with_parent(
    00802         const axutil_env_t * env,
    00803         axis2_options_t * parent);
    00804
    00816     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00817     axis2_options_set_http_auth_info(
    00818         axis2_options_t * options,
    00819         const axutil_env_t * env,
    00820         const axis2_char_t * username,
    00821         const axis2_char_t * password,
    00822         const axis2_char_t * auth_type);
    00823
    00835     AXIS2_EXTERN axis2_status_t AXIS2_CALL
    00836     axis2_options_set_proxy_auth_info(
    00837         axis2_options_t * options,
    00838         const axutil_env_t * env,
    00839         const axis2_char_t * username,
    00840         const axis2_char_t * password,
    00841         const axis2_char_t * auth_type);
    00842
    00844 #ifdef __cplusplus
    00845 }
    00846 #endif
    00847
    00848 #endif                          /* AXIS2_OPTIONS_H */