axiom_soap_header_ops Struct Reference
[soap header]

soap_header operations struct ops Encapsulator struct of axiom_soap header More...

#include <axiom_soap_header.h>

List of all members.

Public Attributes

axis2_status_t(* free_fn )(axiom_soap_header_t *header, const axis2_env_t *env)
axiom_soap_header_block *(* add_header_block )(axiom_soap_header_t *header, const axis2_env_t *env, const axis2_char_t *localname, axiom_namespace_t *ns)
axis2_hash_t *(* examine_header_blocks )(axiom_soap_header_t *header, const axis2_env_t *env, axis2_char_t *param_role)
axis2_array_list_t *(* get_header_blocks_with_namespace_uri )(axiom_soap_header_t *header, const axis2_env_t *env, const axis2_char_t *ns_uri)
axiom_children_qname_iterator_t *(* examine_all_header_blocks )(axiom_soap_header_t *header, const axis2_env_t *env)
axiom_children_with_specific_attribute_iterator_t *(* extract_header_blocks )(axiom_soap_header_t *header, const axis2_env_t *env, axis2_char_t *role)
axiom_node_t *(* get_base_node )(axiom_soap_header_t *header, const axis2_env_t *env)
int(* get_soap_version )(axiom_soap_header_t *header, const axis2_env_t *env)
axis2_hash_t *(* get_all_header_blocks )(axiom_soap_header_t *header, const axis2_env_t *env)
axis2_status_t(* remove_header_block )(axiom_soap_header_t *header, const axis2_env_t *env, axis2_qname_t *qname)


Detailed Description

soap_header operations struct ops Encapsulator struct of axiom_soap header


Member Data Documentation

struct axiom_soap_header_block*( * axiom_soap_header_ops::add_header_block)(axiom_soap_header_t *header, const axis2_env_t *env, const axis2_char_t *localname, axiom_namespace_t *ns)

create a new axiom_soap_header_block_t struct initialized with the specified name and adds it to passed axiom_soap_header_t struct.

Parameters:
env environment must not be null
localName 
ns 
Returns:
The newly created axiom_soap_header_block_t struct

axiom_children_qname_iterator_t*( * axiom_soap_header_ops::examine_all_header_blocks)(axiom_soap_header_t *header, const axis2_env_t *env)

returns an iterator to iterate through all soap header block's om nodes

Parameters:
header 
env environment
Returns:
axiom_children_qname_iterator_t or null if no header blocks present

axis2_hash_t*( * axiom_soap_header_ops::examine_header_blocks)(axiom_soap_header_t *header, const axis2_env_t *env, axis2_char_t *param_role)

returns a hash_table of all the soap_header_block_t struct in this soap_header_t object that have the the specified actor. An actor is a global attribute that indicates the intermediate parties to whom the message should be sent. An actor receives the message and then sends it to the next actor. The default actor is the ultimate intended recipient for the message, so if no actor attribute is set in a axiom_soap_header_t struct the message is sent to its ultimate destination.

axiom_children_with_specific_attribute_iterator_t*( * axiom_soap_header_ops::extract_header_blocks)(axiom_soap_header_t *header, const axis2_env_t *env, axis2_char_t *role)

returns an iterator to iterate through all header blocks om_nodes with the matching role attribute

Parameters:
header soap_header
env environment
role 
Returns:
iterator or null if no header blocks present with matching role attribute

axis2_status_t( * axiom_soap_header_ops::free_fn)(axiom_soap_header_t *header, const axis2_env_t *env)

Free an axiom_soap_header

Parameters:
header pointer to soap_header struct
env Environment. MUST NOT be NULL
Returns:
satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_hash_t*( * axiom_soap_header_ops::get_all_header_blocks)(axiom_soap_header_t *header, const axis2_env_t *env)

Returns:
a hash table of all header_blocks in this header the returned hash is a readonly hash should not be modified

axiom_node_t*( * axiom_soap_header_ops::get_base_node)(axiom_soap_header_t *header, const axis2_env_t *env)

returns the axiom_node_t struct wrapped in soap_header

Parameters:
header soap_header_t
env environment must not be null
Returns:
axiom_node_t

axis2_array_list_t*( * axiom_soap_header_ops::get_header_blocks_with_namespace_uri)(axiom_soap_header_t *header, const axis2_env_t *env, const axis2_char_t *ns_uri)

returns an arraylist of header_blocks which has a given namesapce uri

Parameters:
header 
env envirbonment must not be null
ns_uri namespace uri
Returns:
pointer to axis2_array_list_t, or null if no header_blocks with given namespace uri exists The returned array_list must be freed by the user.

int( * axiom_soap_header_ops::get_soap_version)(axiom_soap_header_t *header, const axis2_env_t *env)

return the soap_version of this soap_header

Parameters:
header soap_header
env environment must not be null
Returns:
AXIOM_SOAP11 or AXIOM_SOAP12

axis2_status_t( * axiom_soap_header_ops::remove_header_block)(axiom_soap_header_t *header, const axis2_env_t *env, axis2_qname_t *qname)

remove header block that matches to the given qname qname should not be null


The documentation for this struct was generated from the following file:
Generated on Tue Oct 3 20:48:18 2006 for Axis2/C by  doxygen 1.4.7