Moving axis svn, part of TLP move INFRA-2441

git-svn-id: http://svn.apache.org/repos/asf/axis/axis2/c/core/trunk@909681 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 848 insertions, 0 deletions

diff --git a/include/axis2_options.h b/include/axis2_options.h
new file mode 100644
index 0000000..4ed2185
--- /dev/null
+++ b/include/axis2_options.h
@@ -0,0 +1,848 @@
+
+/*
+* 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_OPTIONS_H
+#define AXIS2_OPTIONS_H
+
+/** @defgroup axis2_options options
+  * @ingroup axis2_client_api
+  * The options struct holds user options to be used by client when invocation
+  * services. In addition to the end point reference information, options
+  * struct also hold addressing, transport and timeout related information.
+  * User specific properties could also set on top of options.
+  * @{
+  */
+
+/**
+  * @file axis2_options.h
+  */
+
+#include <axis2_defines.h>
+#include <axutil_env.h>
+#include <axis2_transport_in_desc.h>
+#include <axis2_endpoint_ref.h>
+#include <axutil_hash.h>
+#include <axis2_relates_to.h>
+#include <axis2_transport_out_desc.h>
+#include <axis2_transport_receiver.h>
+#include <axiom_element.h>
+#include <axis2_msg_info_headers.h>
+
+/** Default timeout */
+#define AXIS2_DEFAULT_TIMEOUT_MILLISECONDS 30000
+
+/** Timeout in seconds waiting for a response envelope */
+#define AXIS2_TIMEOUT_IN_SECONDS "time_out"
+
+/** Copy properties */
+#define AXIS2_COPY_PROPERTIES   "copy_properties"
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+    /** Type name for struct axis2_options */
+    typedef struct axis2_options axis2_options_t;
+
+    /**
+     * Gets Web Services Addressing (WSA) action.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return WSA action string if set, else NULL
+     */
+    AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
+    axis2_options_get_action(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets WSA fault to address.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to endpoint reference struct representing fault to 
+     * address if set, else NULL
+     */
+    AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
+    axis2_options_get_fault_to(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets WSA from address.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to endpoint reference struct representing from 
+     * address if set, else NULL
+     */
+    AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
+    axis2_options_get_from(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets transport receiver.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to transport receiver struct if set, else NULL
+     */
+    AXIS2_EXTERN axis2_transport_receiver_t *AXIS2_CALL
+    axis2_options_get_transport_receiver(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets transport in.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to transport in struct if set, else NULL
+     */
+    AXIS2_EXTERN axis2_transport_in_desc_t *AXIS2_CALL
+    axis2_options_get_transport_in(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets transport in protocol.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to transport in protocol string if set, else NULL
+     */
+    AXIS2_EXTERN AXIS2_TRANSPORT_ENUMS AXIS2_CALL
+    axis2_options_get_transport_in_protocol(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets message ID.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to message ID string if set, else NULL
+     */
+    AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
+    axis2_options_get_message_id(
+        const axis2_options_t * options_t,
+        const axutil_env_t * env);
+
+    /**
+     * Gets the properties hash map.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to properties hash map if set, else NULL
+     */
+    AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
+    axis2_options_get_properties(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets a property corresponding to the given key.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param key key of the property to be returned
+     * @return value corresponding to the given key
+     */
+    AXIS2_EXTERN void *AXIS2_CALL
+    axis2_options_get_property(
+        const axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_char_t * key);
+
+    /**
+     * Gets relates to information.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to relates to struct if set, else NULL
+     */
+    AXIS2_EXTERN axis2_relates_to_t *AXIS2_CALL
+    axis2_options_get_relates_to(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets WSA reply to address.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to endpoint reference struct representing reply to
+     * address if set, else NULL
+     */
+    AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
+    axis2_options_get_reply_to(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets transport out.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to transport out struct if set, else NULL
+     */
+    AXIS2_EXTERN axis2_transport_out_desc_t *AXIS2_CALL
+    axis2_options_get_transport_out(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets transport out protocol.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to transport out protocol string if set, else NULL
+     */
+    AXIS2_EXTERN AXIS2_TRANSPORT_ENUMS AXIS2_CALL
+    axis2_options_get_sender_transport_protocol(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets SOAP version URI.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return string representing SOAP version URI
+     */
+    AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
+    axis2_options_get_soap_version_uri(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets the wait time after which a client times out in a blocking scenario.
+     * The default is AXIS2_DEFAULT_TIMEOUT_MILLISECONDS.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return timeout in milliseconds
+     */
+    AXIS2_EXTERN long AXIS2_CALL
+    axis2_options_get_timeout_in_milli_seconds(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets WSA to address.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to endpoint reference struct representing to
+     * address if set, else NULL
+     */
+    AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
+    axis2_options_get_to(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets use separate listener status.
+     * @param options pointer to options struct 
+     * @param env pointer to environment struct
+     * @return AXIS2_TRUE if using separate listener, else AXIS2_FALSE
+     */
+    AXIS2_EXTERN axis2_bool_t AXIS2_CALL
+    axis2_options_get_use_separate_listener(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets the parent options.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to the parent options struct if set, else NULL
+     */
+    AXIS2_EXTERN axis2_options_t *AXIS2_CALL
+    axis2_options_get_parent(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Sets the parent options.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param parent pointer to parent options struct
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_parent(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_options_t * parent);
+
+    /**
+     * Sets WSA action
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param action pointer to action string
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_action(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_char_t * action);
+
+    /**
+     * Sets fault to address.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param fault_to pointer to endpoint reference struct representing
+     * fault to address. options takes over the ownership of the struct.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_fault_to(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axis2_endpoint_ref_t * fault_to);
+
+    /**
+     * Sets from address.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param from pointer to endpoint reference struct representing
+     * from to address. options takes over the ownership of the struct.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_from(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axis2_endpoint_ref_t * from);
+
+    /**
+     * sets from address.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param to pointer to endpoint reference struct representing
+     * to address. Options takes over the ownership of the struct.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_to(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axis2_endpoint_ref_t * to);
+
+    /**
+     * Sets transport receiver.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param receiver pointer to transport receiver struct. options takes 
+     * over the ownership of the struct.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_transport_receiver(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axis2_transport_receiver_t * receiver);
+
+    /**
+     * Sets transport in description.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param transport_in pointer to transport_in struct. options takes 
+     * over the ownership of the struct.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_transport_in(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axis2_transport_in_desc_t * transport_in);
+
+    /**
+     * Sets transport in protocol.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param in_protocol pointer to in_protocol struct
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_transport_in_protocol(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const AXIS2_TRANSPORT_ENUMS transport_in_protocol);
+
+    /**
+     * Sets message ID.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param message_id pointer to message_id struct
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_message_id(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_char_t * message_id);
+
+    /**
+     * Sets the properties hash map. 
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param properties pointer to properties hash map. options takes 
+     * over the ownership of the hash struct.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_properties(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axutil_hash_t * properties);
+
+    /**
+     * Sets a property with the given key value.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param property_key property key string
+     * @param property pointer to property to be set
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_property(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_char_t * property_key,
+        const void *property);
+
+    /**
+     * Sets relates to.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param relates_to pointer to relates_to struct. options takes 
+     * over the ownership of the struct.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_relates_to(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axis2_relates_to_t * relates_to);
+
+    /**
+     * Sets reply to address.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param reply_to pointer to endpoint reference struct representing 
+     * reply to address. options takes over the ownership of the struct.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_reply_to(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axis2_endpoint_ref_t * reply_to);
+
+    /**
+     * Sets the transport out description.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param transport_out pointer to transport out description struct. 
+     * options takes over the ownership of the struct.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE 
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_transport_out(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axis2_transport_out_desc_t * transport_out);
+
+    /**
+     * Sets the sender transport.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param sender_transport name of the sender transport to be set
+     * @param conf pointer to conf struct, it is from the conf that the 
+     * transport is picked with the given name
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_sender_transport(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const AXIS2_TRANSPORT_ENUMS sender_transport,
+        axis2_conf_t * conf);
+
+    /**
+     * Sets the SOAP version URI.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param soap_version_uri URI of the SOAP version to be set, can be 
+     * either AXIOM_SOAP11_SOAP_ENVELOPE_NAMESPACE_URI or 
+     * AXIOM_SOAP12_SOAP_ENVELOPE_NAMESPACE_URI
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_soap_version_uri(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_char_t * soap_version_uri);
+
+    /**
+     * Sets timeout in Milli seconds.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param timeout_in_milli_seconds timeout in milli seconds
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_timeout_in_milli_seconds(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const long timeout_in_milli_seconds);
+
+    /**
+     * Sets transport information. Transport information includes the name 
+     * of the sender transport, name of the receiver transport and if a 
+     * separate listener to be used to receive response. 
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param sender_transport name of sender transport to be used
+     * @param receiver_transport name of receiver transport to be used
+     * @param use_separate_listener bool value indicating whether to use
+     * a separate listener or not.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_transport_info(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const AXIS2_TRANSPORT_ENUMS sender_transport,
+        const AXIS2_TRANSPORT_ENUMS receiver_transport,
+        const axis2_bool_t use_separate_listener);
+
+    /**
+     * Sets the bool value indicating whether to use a separate listener or not.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param use_separate_listener bool value indicating whether to use
+     * a separate listener or not.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_use_separate_listener(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_bool_t use_separate_listener);
+
+    /**
+     * Adds a WSA reference parameter.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param reference_parameter pointer to reference parameter in the form 
+     * of an AXIOM tree. options takes over the ownership of the struct.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_add_reference_parameter(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axiom_node_t * reference_parameter);
+
+    /**
+     * Gets manage session bool value.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return AXIS2_TRUE if session is managed, else AXIS2_FALSE
+     */
+    AXIS2_EXTERN axis2_bool_t AXIS2_CALL
+    axis2_options_get_manage_session(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Sets manage session bool value.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param manage_session manage session bool value
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_manage_session(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_bool_t manage_session);
+
+    /**
+     * Sets WSA message information headers.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param pointer to message information headers struct
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_msg_info_headers(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axis2_msg_info_headers_t * msg_info_headers);
+
+    /**
+     * Gets WSA message information headers.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return pointer to message information headers struct if set, 
+     * else NULL
+     */
+    AXIS2_EXTERN axis2_msg_info_headers_t *AXIS2_CALL
+    axis2_options_get_msg_info_headers(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets SOAP version.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return AXIOM_SOAP11 if SOAP version 1.1 is in use, else AXIOM_SOAP12
+     */
+    AXIS2_EXTERN int AXIS2_CALL
+    axis2_options_get_soap_version(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Sets SOAP version.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param soap_version soap version, either AXIOM_SOAP11 or AXIOM_SOAP12
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_soap_version(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const int soap_version);
+
+    /**
+     * Enable/disable MTOM handling.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param enable_mtom AXIS2_TRUE if MTOM is to be enabled, AXIS2_FALSE
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_enable_mtom(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axis2_bool_t enable_mtom);
+
+    /**
+     * Gets Enable/disable MTOM status.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return AXIS2_TRUE if MTOM enabled, else AXIS2_FALSE
+     */
+    AXIS2_EXTERN axis2_bool_t AXIS2_CALL
+    axis2_options_get_enable_mtom(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Gets SOAP action.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return SOAP Action string if set, else NULL
+     */
+    AXIS2_EXTERN axutil_string_t *AXIS2_CALL
+    axis2_options_get_soap_action(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Sets SOAP action
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param action pointer to SOAP action string
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_soap_action(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axutil_string_t * soap_action);
+
+    /**
+     * Sets xml parser reset
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param reset flag is a boolean value
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_xml_parser_reset(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_bool_t paser_reset_flag);
+
+    /**
+     * Gets xml parser reset value,
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return xml parser reset boolean value
+     */
+    AXIS2_EXTERN axis2_bool_t AXIS2_CALL
+    axis2_options_get_xml_parser_reset(
+        const axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Frees options struct.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @return void
+     */
+    AXIS2_EXTERN void AXIS2_CALL
+    axis2_options_free(
+        axis2_options_t * options,
+        const axutil_env_t * env);
+
+    /**
+     * Sets the bool value indicating whether to enable REST or not.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param enable_rest bool value indicating whether to enable REST 
+     * or not, AXIS2_TRUE to enable, AXIS2_FALSE to disable
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_enable_rest(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_bool_t enable_rest);
+
+    /**
+     * Sets the bool value indicating whether to test whether HTTP
+     * Authentication is required or not.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param test_http_auth bool value indicating whether to test
+     * or not, AXIS2_TRUE to enable, AXIS2_FALSE to disable
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_test_http_auth(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_bool_t test_http_auth);
+
+    /**
+     * Sets the bool value indicating whether to test whether Proxy
+     * Authentication is required or not.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param test_proxy_auth bool value indicating whether to test
+     * or not, AXIS2_TRUE to enable, AXIS2_FALSE to disable
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_test_proxy_auth(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_bool_t test_proxy_auth);
+    
+    /**
+     * Sets the HTTP method to be used
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param http_method string representing HTTP method to use, 
+     * can be either AXIS2_HTTP_GET or AXIS2_HTTP_POST
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_http_method(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_char_t * http_method);
+
+    /**
+     * Sets the Additional HTTP Headers to be sent.
+     * @param options pointer to options struct
+     * @param env pointer to environment struct
+     * @param http_header_list array list containing
+     * HTTP Headers.
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_http_headers(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        axutil_array_list_t * http_header_list);
+
+    /**
+     * Creates the options struct.
+     * @param env pointer to environment struct
+     * @return a pointer to newly created options struct, or NULL on error 
+     * with error code set in environment's error.
+     */
+    AXIS2_EXTERN axis2_options_t *AXIS2_CALL
+    axis2_options_create(
+        const axutil_env_t * env);
+
+    /**
+     * Creates the options struct with given parent.
+     * @param env pointer to environment struct
+     * @param parent pointer to parent struct
+     * @return a pointer to newly created options struct. Newly created options 
+     * assumes ownership of the parent 
+     * or NULL on error with error code set in environment's error.
+     */
+    AXIS2_EXTERN axis2_options_t *AXIS2_CALL
+    axis2_options_create_with_parent(
+        const axutil_env_t * env,
+        axis2_options_t * parent);
+
+    /**
+     * Sets HTTP authentication information.
+     * @param env pointer to environment struct
+     * @param parent pointer to parent struct
+     * @param username string representing username
+     * @param password string representing password
+     * @param auth_type use "Basic" to force basic authentication
+     * and "Digest" to force digest authentication or NULL for not
+     * forcing authentication
+     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+     */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_http_auth_info(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_char_t * username,
+        const axis2_char_t * password,
+        const axis2_char_t * auth_type);
+
+    /**
+      * Sets proxy authentication information.
+      * @param env pointer to environment struct
+      * @param parent pointer to parent struct
+      * @param username string representing username
+      * @param password string representing password
+      * @param auth_type use "Basic" to force basic authentication
+      * and "Digest" to force digest authentication or NULL for not
+      * forcing authentication
+      * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+      */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axis2_options_set_proxy_auth_info(
+        axis2_options_t * options,
+        const axutil_env_t * env,
+        const axis2_char_t * username,
+        const axis2_char_t * password,
+        const axis2_char_t * auth_type);
+
+    /** @} */
+#ifdef __cplusplus
+}
+#endif
+
+#endif                          /* AXIS2_OPTIONS_H */