/* * 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 AXIOM_SOAP_HEADER_H #define AXIOM_SOAP_HEADER_H /** * @file axiom_soap_header.h * @brief axiom_soap_header struct */ #include #include #include #include #include #include #include #include #ifdef __cplusplus extern "C" { #endif typedef struct axiom_soap_header axiom_soap_header_t; struct axiom_soap_header_block; struct axiom_soap_builder; /** * @defgroup axiom_soap_header soap header * @ingroup axiom_soap * @{ */ AXIS2_EXTERN axiom_soap_header_t *AXIS2_CALL axiom_soap_header_create_with_parent( const axutil_env_t * env, struct axiom_soap_envelope *envelope); /** * Free an axiom_soap_header * @param header pointer to soap_header struct * @param env Environment. MUST NOT be NULL * @return satus of the op. AXIS2_SUCCESS on success * else AXIS2_FAILURE */ AXIS2_EXTERN void AXIS2_CALL axiom_soap_header_free( axiom_soap_header_t * header, const axutil_env_t * env); /** * create a new axiom_soap_header_block_t struct initialized with the * specified name and adds it to passed axiom_soap_header_t struct. * @param header pointer to soap_header struct * @param env Environment. MUST NOT be NULL * @param localName the localname of the SOAP header block * @param ns the namespace of the SOAP header block * @return The newly created axiom_soap_header_block_t struct */ AXIS2_EXTERN struct axiom_soap_header_block *AXIS2_CALL axiom_soap_header_add_header_block( axiom_soap_header_t * header, const axutil_env_t * env, const axis2_char_t * localname, axiom_namespace_t * ns); /** * 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. * @param header pointer to soap_header struct * @param env Environment. MUST NOT be NULL * @param role the role value for the examination * * @return hash_table of all the soap_header_block_t struct */ AXIS2_EXTERN axutil_hash_t *AXIS2_CALL axiom_soap_header_examine_header_blocks( axiom_soap_header_t * header, const axutil_env_t * env, axis2_char_t * param_role); /** * returns an arraylist of header_blocks which has a given namesapce uri * @param header pointer to soap_header struct * @param env Environment. MUST NOT be NULL * @param ns_uri namespace uri * @return pointer to axutil_array_list_t, or null if no header_blocks with * given namespace uri exists * The returned array_list must be freed by the user. */ AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL axiom_soap_header_get_header_blocks_with_namespace_uri( axiom_soap_header_t * header, const axutil_env_t * env, const axis2_char_t * ns_uri); /** * returns an iterator to iterate through all soap header block's om nodes * @param header pointer to soap_header struct * @param env Environment. MUST NOT be NULL * @returns axiom_children_qname_iterator_t or null if no header blocks * present */ AXIS2_EXTERN axiom_children_qname_iterator_t *AXIS2_CALL axiom_soap_header_examine_all_header_blocks( axiom_soap_header_t * header, const axutil_env_t * env); /** * returns an iterator to iterate through all header blocks om_nodes * with the matching role attribute * @param header pointer to soap_header struct * @param env Environment. MUST NOT be NULL * @param role * @returns iterator or null if no header blocks present with matching * role attribute */ AXIS2_EXTERN axiom_children_with_specific_attribute_iterator_t *AXIS2_CALL axiom_soap_header_extract_header_blocks( axiom_soap_header_t * header, const axutil_env_t * env, axis2_char_t * role); /** * returns the axiom_node_t struct wrapped in soap_header * @param header pointer to soap_header struct * @param env Environment. MUST NOT be NULL * * @return the base node of the SOAP header */ AXIS2_EXTERN axiom_node_t *AXIS2_CALL axiom_soap_header_get_base_node( axiom_soap_header_t * header, const axutil_env_t * env); /** * return the soap_version of this soap_header * @param header pointer to soap_header struct * @param env Environment. MUST NOT be NULL * * @return AXIOM_SOAP11 or AXIOM_SOAP12 */ AXIS2_EXTERN int AXIS2_CALL axiom_soap_header_get_soap_version( axiom_soap_header_t * header, const axutil_env_t * env); /** * Get all the SOAP headers * @param header pointer to soap_header struct * @param env Environment. MUST NOT be NULL * * @returns a hash table of all header_blocks in this header * the returned hash is a readonly hash should not be modified */ AXIS2_EXTERN axutil_hash_t *AXIS2_CALL axiom_soap_header_get_all_header_blocks( axiom_soap_header_t * header, const axutil_env_t * env); /** * remove header block that matches to the given qname * qname should not be null * @param header pointer to soap_header struct * @param env Environment. MUST NOT be NULL * * @return status of the op. AXIS2_SUCCESS on success * else AXIS2_FAILURE */ AXIS2_EXTERN axis2_status_t AXIS2_CALL axiom_soap_header_remove_header_block( axiom_soap_header_t * header, const axutil_env_t * env, axutil_qname_t * qname); /** @} */ #ifdef __cplusplus } #endif #endif /* AXIOM_SOAP_HEADER_H */