You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by ka...@apache.org on 2008/03/30 17:48:29 UTC
svn commit: r642762 -
/webservices/axis2/trunk/c/axiom/include/axiom_soap_header_block.h
Author: kaushalye
Date: Sun Mar 30 08:48:28 2008
New Revision: 642762
URL: http://svn.apache.org/viewvc?rev=642762&view=rev
Log:
Hackathon : OM SOAP header block
Modified:
webservices/axis2/trunk/c/axiom/include/axiom_soap_header_block.h
Modified: webservices/axis2/trunk/c/axiom/include/axiom_soap_header_block.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_soap_header_block.h?rev=642762&r1=642761&r2=642762&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_soap_header_block.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_soap_header_block.h Sun Mar 30 08:48:28 2008
@@ -46,9 +46,10 @@
* creates a soap struct
* @param env Environment. MUST NOT be NULL
* this is an internal function.
+ *
+ * @return the created SOAP header block
*/
AXIS2_EXTERN axiom_soap_header_block_t *AXIS2_CALL
-
axiom_soap_header_block_create_with_parent(
const axutil_env_t * env,
const axis2_char_t * localname,
@@ -67,51 +68,111 @@
axiom_soap_header_block_t * header_block,
const axutil_env_t * env);
+ /**
+ * Set the SOAP role
+ * @param header_block pointer to soap_header_block struct
+ * @param env Environment. MUST NOT be NULL
+ * @param uri the role URI
+ * @return satus of the op. AXIS2_SUCCESS on success
+ * else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_soap_header_block_set_role(
axiom_soap_header_block_t * header_block,
const axutil_env_t * env,
axis2_char_t * uri);
+ /**
+ * Set the mustunderstand attribute of the SOAP header
+ * If must_understand=TRUE its set to 1, otherwise set to 0
+ * @param header_block pointer to soap_header_block struct
+ * @param env Environment. MUST NOT be NULL
+ * @param must_understand SOAP mustunderstand attribute value
+ * @return satus of the op. AXIS2_SUCCESS on success
+ * else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_soap_header_block_set_must_understand_with_bool(
axiom_soap_header_block_t * header_block,
const axutil_env_t * env,
axis2_bool_t must_understand);
+ /**
+ * Set the SOAP mustunderstand attribute
+ * @param header_block pointer to soap_header_block struct
+ * @param env Environment. MUST NOT be NULL
+ * @param must_understand SOAP mustunderstand attribute
+ * @return satus of the op. AXIS2_SUCCESS on success
+ * else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_soap_header_block_set_must_understand_with_string(
axiom_soap_header_block_t * header_block,
const axutil_env_t * env,
axis2_char_t * must_understand);
+ /**
+ * To check the SOAP mustunderstand attribute
+ * If must_understand=TRUE its set to 1, otherwise set to 0
+ * @param header_block pointer to soap_header_block struct
+ * @param env Environment. MUST NOT be NULL
+ *
+ * @return AXIS2_TRUE if mustunderstand is set true. AXIS2_FALSE otherwise
+ */
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
-
axiom_soap_header_block_get_must_understand(
axiom_soap_header_block_t * header_block,
const axutil_env_t * env);
+ /**
+ * To chk if the SOAP header is processed or not
+ * @param header_block pointer to soap_header_block struct
+ * @param env Environment. MUST NOT be NULL
+ *
+ * @return AXIS2_TRUE if checked AXIS2_FALSE otherwise
+ */
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
-
axiom_soap_header_block_is_processed(
axiom_soap_header_block_t * header_block,
const axutil_env_t * env);
+ /**
+ * Set the SOAP header as processed
+ * @param header_block pointer to soap_header_block struct
+ * @param env Environment. MUST NOT be NULL
+ *
+ * @return satus of the op. AXIS2_SUCCESS on success
+ * else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_soap_header_block_set_processed(
axiom_soap_header_block_t * header_block,
const axutil_env_t * env);
+ /**
+ * Get the SOAP role of the header block
+ * @param header_block pointer to soap_header_block struct
+ * @param env Environment. MUST NOT be NULL
+ *
+ * @return the SOAP role of the header block
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_soap_header_block_get_role(
axiom_soap_header_block_t * header_block,
const axutil_env_t * env);
+ /**
+ * Set the attribute of the header block
+ * @param header_block pointer to soap_header_block struct
+ * @param env Environment. MUST NOT be NULL
+ * @param attr_name the attribute name
+ * @param attr_value the attribute value
+ * @param soap_envelope_namespace_uri the namsepace URI value
+ *
+ * @return satus of the op. AXIS2_SUCCESS on success
+ * else AXIS2_FAILURE
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
axiom_soap_header_block_set_attribute(
axiom_soap_header_block_t * header_block,
const axutil_env_t * env,
@@ -119,20 +180,41 @@
const axis2_char_t * attr_value,
const axis2_char_t * soap_envelope_namespace_uri);
+ /**
+ * Get the attribute of the header block
+ * @param header_block pointer to soap_header_block struct
+ * @param env Environment. MUST NOT be NULL
+ * @param attr_name the attribute name
+ * @param the namespace URI of the SOAP envelope
+ *
+ * @return the attribute of the header block
+ */
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
axiom_soap_header_block_get_attribute(
axiom_soap_header_block_t * header_block,
const axutil_env_t * env,
const axis2_char_t * attr_name,
const axis2_char_t * soap_envelope_namespace_uri);
+ /**
+ * Get the base node of the header block
+ * @param header_block pointer to soap_header_block struct
+ * @param env Environment. MUST NOT be NULL
+ *
+ * @return the base node of the of the header block
+ */
AXIS2_EXTERN axiom_node_t *AXIS2_CALL
-
axiom_soap_header_block_get_base_node(
axiom_soap_header_block_t * header_block,
const axutil_env_t * env);
+ /**
+ * Get the SOAP version of the header block
+ * @param header_block pointer to soap_header_block struct
+ * @param env Environment. MUST NOT be NULL
+ *
+ * @return the SOAP version of the header block
+ */
AXIS2_EXTERN int AXIS2_CALL
axiom_soap_header_block_get_soap_version(
axiom_soap_header_block_t * header_block,
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org