soap-addressing.h File Reference

Go to the source code of this file.

Defines

#define WSA_NAMESPACE   "http://www.w3.org/2005/08/addressing"
#define WSA_NAMESPACE_PREFIX   "wsa"
#define WSA_ANONYMOUS   WSA_NAMESPACE "/anonymous"
#define WSA_NONE   WSA_NAMESPACE "/none"
#define WSA_REPLY   WSA_NAMESPACE "/reply"
#define WSA_ENDPOINT_REFERENCE_TYPE   "EndpointReferenceType"
#define WSA_ENDPOINT_REFERENCE   "EndpointReference"
#define WSA_REFERENCE_PROPERTIES   "ReferenceProperties"
#define WSA_METADATA   "Metadata"
#define WSA_MESSAGE_ID   "MessageID"
#define WSA_RELATES_TO   "RelatesTo"
#define WSA_RELATIONSHIP_TYPE   "RelationshipType"
#define WSA_REPLY_TO   "ReplyTo"
#define WSA_FROM   "From"
#define WSA_FAULT_TO   "FaultTo"
#define WSA_TO   "To"
#define WSA_ACTION   "Action"
#define WSA_ADDRESS   "Address"

Functions

xmlURI * soap_addressing_get_address (xmlNodePtr endpoint_reference)
xmlNodePtr soap_addressing_set_address (xmlNodePtr endpoint_reference, xmlURI *address)
xmlNodePtr soap_addressing_get_reference_properties (xmlNodePtr endpoint_reference)
xmlNodePtr soap_addressing_set_reference_properties (xmlNodePtr endpoint_reference, xmlNodePtr property)
xmlNodePtr soap_addressing_get_metadata (xmlNodePtr endpoint_reference)
xmlNodePtr soap_addressing_set_metadata (xmlNodePtr endpoint_reference, xmlNodePtr parameter)
xmlURI * soap_addressing_get_message_id (struct SoapEnv *envelope)
xmlChar * soap_addressing_get_message_id_string (struct SoapEnv *envelope)
xmlNodePtr soap_addressing_set_message_id (struct SoapEnv *envelope, xmlURI *id)
xmlNodePtr soap_addressing_set_message_id_string (struct SoapEnv *envelope, xmlChar *id)
xmlNodePtr soap_addressing_get_relates_to (struct SoapEnv *envelope)
xmlNodePtr soap_addressing_add_relates_to (struct SoapEnv *envelope, xmlURI *id, xmlURI *type)
xmlNodePtr soap_addressing_get_reply_to (struct SoapEnv *envelope)
xmlNodePtr soap_addressing_set_reply_to (struct SoapEnv *envelope, xmlNodePtr address)
xmlURI * soap_addressing_get_reply_to_address (struct SoapEnv *envelope)
xmlNodePtr soap_addressing_set_reply_to_address (struct SoapEnv *envelope, xmlURI *address)
xmlNodePtr soap_addressing_get_from (struct SoapEnv *envelope)
xmlURI * soap_addressing_get_from_address (struct SoapEnv *envelope)
xmlChar * soap_addressing_get_from_address_string (struct SoapEnv *envelope)
xmlNodePtr soap_addressing_set_from (struct SoapEnv *envelope, xmlNodePtr address)
xmlNodePtr soap_addressing_set_from_address (struct SoapEnv *envelope, xmlURI *address)
xmlNodePtr soap_addressing_set_from_address_string (struct SoapEnv *envelope, const char *from)
xmlNodePtr soap_addressing_get_fault_to (struct SoapEnv *envelope)
xmlURI * soap_addressing_get_fault_to_address (struct SoapEnv *envelope)
xmlNodePtr soap_addressing_set_fault_to (struct SoapEnv *envelope, xmlNodePtr address)
xmlNodePtr soap_addressing_set_fault_to_address (struct SoapEnv *envelope, xmlURI *address)
xmlNodePtr soap_addressing_set_fault_to_string (struct SoapEnv *envelope, const char *fault_to)
xmlNodePtr soap_addressing_get_to (struct SoapEnv *envelope)
xmlURI * soap_addressing_get_to_address (struct SoapEnv *envelope)
xmlChar * soap_addressing_get_to_address_string (struct SoapEnv *envelope)
xmlNodePtr soap_addressing_set_to (struct SoapEnv *envelope, xmlNodePtr address)
xmlNodePtr soap_addressing_set_to_address (struct SoapEnv *envelope, xmlURI *address)
xmlNodePtr soap_addressing_set_to_address_string (struct SoapEnv *envelope, const char *to)
xmlURI * soap_addressing_get_action (struct SoapEnv *envelope)
xmlChar * soap_addressing_get_action_string (struct SoapEnv *envelope)
xmlNodePtr soap_addressing_set_action (struct SoapEnv *envelope, xmlURI *action)
xmlNodePtr soap_addressing_set_action_string (struct SoapEnv *envelope, const char *action)


Detailed Description

WS-Addressing

WS-Addressing provides transport-neutral mechanisms to address Web services and messages. Specifically, this specification defines XML [XML 1.0, XML Namespaces] elements to identify Web service endpoints and to secure end-to-end endpoint identification in messages. This specification enables messaging systems to support message transmission through networks that include processing nodes such as endpoint managers, firewalls, and gateways in a transport-neutral manner.

Author:
H. Ronsdorf
Version:
Revision
1.9
See also:
http://www.w3.org/TR/ws-addr-core/, http://www.w3.org/TR/REC-xml-names/

Definition in file soap-addressing.h.


Define Documentation

#define WSA_ACTION   "Action"
 

This REQUIRED element of type xs:anyURI conveys the [action] property. The [children] of this element convey the value of this property.

Definition at line 194 of file soap-addressing.h.

Referenced by soap_addressing_get_action(), and soap_addressing_set_action().

#define WSA_ADDRESS   "Address"
 

An address URI that identifies the endpoint. This may be a network address or a logical address.

Definition at line 202 of file soap-addressing.h.

Referenced by soap_addressing_get_address(), and soap_addressing_set_address().

#define WSA_ANONYMOUS   WSA_NAMESPACE "/anonymous"
 

Some endpoints cannot be located with a meaningful IRI; this URI is used to allow such endpoints to send and receive messages. The precise meaning of this URI is defined by the binding of Addressing to a specific protocol and/or the context in which the EPR is used.

Definition at line 71 of file soap-addressing.h.

#define WSA_ENDPOINT_REFERENCE   "EndpointReference"
 

This represents some element of type wsa:EndpointReferenceType. Any element of type wsa:EndpointReferenceType may be used. There is an extensibility mechanism to allow additional elements to be specified.

Definition at line 106 of file soap-addressing.h.

#define WSA_ENDPOINT_REFERENCE_TYPE   "EndpointReferenceType"
 

The wsa:EndpointReferenceType type is used wherever a Web service endpoint is referenced.

Definition at line 97 of file soap-addressing.h.

#define WSA_FAULT_TO   "FaultTo"
 

This OPTIONAL element (of type wsa:EndpointReferenceType) provides the value for the [fault endpoint] property. If this element is present, wsa:MessageID MUST be present.

Definition at line 178 of file soap-addressing.h.

Referenced by soap_addressing_get_fault_to(), soap_addressing_set_fault_to(), and soap_addressing_set_fault_to_address().

#define WSA_FROM   "From"
 

This OPTIONAL element (of type wsa:EndpointReferenceType) provides the value for the [source endpoint] property.

Definition at line 169 of file soap-addressing.h.

Referenced by soap_addressing_get_from(), soap_addressing_set_from(), and soap_addressing_set_from_address().

#define WSA_MESSAGE_ID   "MessageID"
 

This OPTIONAL element (of type xs:anyURI) conveys the [message id] property. This element MUST be present if wsa:ReplyTo or wsa:FaultTo is present.

Definition at line 131 of file soap-addressing.h.

Referenced by soap_addressing_get_message_id(), soap_addressing_set_message_id(), and soap_addressing_set_message_id_string().

#define WSA_METADATA   "Metadata"
 

This OPTIONAL element may contain elements from any namespace. Such elements form the metadata that is relevant to the interaction with the endpoint.

Definition at line 123 of file soap-addressing.h.

Referenced by soap_addressing_get_metadata().

#define WSA_NAMESPACE   "http://www.w3.org/2005/08/addressing"
 

Namespace used for the addressing elements.

Definition at line 52 of file soap-addressing.h.

#define WSA_NAMESPACE_PREFIX   "wsa"
 

Prefix for the WSA namespace used internally.

See also:
WSA_NAMESPACE

Definition at line 61 of file soap-addressing.h.

#define WSA_NONE   WSA_NAMESPACE "/none"
 

Messages sent to EPRs whose [address] is this value MUST be discarded (i.e. not sent). This URI is typically used in EPRs that designate a reply or fault endpoint (see section 3.1 Abstract Property Definitions) to indicate that no reply or fault message should be sent.

Definition at line 81 of file soap-addressing.h.

#define WSA_REFERENCE_PROPERTIES   "ReferenceProperties"
 

This OPTIONAL element contains the elements that convey the [reference properties] of the reference. Each child element of ReferenceProperties represents an individual [reference property].

Definition at line 115 of file soap-addressing.h.

Referenced by soap_addressing_get_reference_properties().

#define WSA_RELATES_TO   "RelatesTo"
 

This OPTIONAL (repeating) element information item contributes one abstract [relationship] property value, in the form of a (URI, QName) pair. The [children] property of this element (which is of type xs:anyURI) conveys the [message id] of the related message. This element MUST be present if the message is a reply.

Definition at line 142 of file soap-addressing.h.

Referenced by soap_addressing_add_relates_to(), and soap_addressing_get_relates_to().

#define WSA_RELATIONSHIP_TYPE   "RelationshipType"
 

This OPTIONAL attribute of <wsa:RelatesTo> (of type xs:QName) conveys the relationship type as a QName. When absent, the implied value of this attribute is wsa:Reply.

Definition at line 151 of file soap-addressing.h.

Referenced by soap_addressing_add_relates_to().

#define WSA_REPLY   WSA_NAMESPACE "/reply"
 

Indicates that this is a reply to the message identified by the [message id] IRI.

Definition at line 89 of file soap-addressing.h.

#define WSA_REPLY_TO   "ReplyTo"
 

This OPTIONAL element (of type wsa:EndpointReferenceType) provides the value for the [reply endpoint] property. This element MUST be present if a reply is expected. If this element is present, wsa:MessageID MUST be present.

Definition at line 161 of file soap-addressing.h.

Referenced by soap_addressing_get_reply_to(), soap_addressing_set_reply_to(), and soap_addressing_set_reply_to_address().

#define WSA_TO   "To"
 

This REQUIRED element (of type xs:anyURI) provides the value for the [destination] property.

Definition at line 186 of file soap-addressing.h.

Referenced by soap_addressing_get_to(), soap_addressing_set_to(), and soap_addressing_set_to_address().


Function Documentation

xmlNodePtr soap_addressing_add_relates_to struct SoapEnv envelope,
xmlURI *  id,
xmlURI *  type
 

Definition at line 376 of file soap-addressing.c.

References SoapEnv::header, soap_addressing_get_relates_to(), WSA_RELATES_TO, and WSA_RELATIONSHIP_TYPE.

xmlURI* soap_addressing_get_action struct SoapEnv envelope  ) 
 

Definition at line 684 of file soap-addressing.c.

References SoapEnv::header, and WSA_ACTION.

Referenced by soap_addressing_get_action_string().

xmlChar* soap_addressing_get_action_string struct SoapEnv envelope  ) 
 

Definition at line 696 of file soap-addressing.c.

References soap_addressing_get_action().

xmlURI* soap_addressing_get_address xmlNodePtr  endpoint_reference  ) 
 

Definition at line 233 of file soap-addressing.c.

References WSA_ADDRESS.

Referenced by soap_addressing_get_fault_to_address(), soap_addressing_get_from_address(), soap_addressing_get_reply_to_address(), and soap_addressing_get_to_address().

xmlNodePtr soap_addressing_get_fault_to struct SoapEnv envelope  ) 
 

Definition at line 539 of file soap-addressing.c.

References SoapEnv::header, and WSA_FAULT_TO.

Referenced by soap_addressing_get_fault_to_address(), soap_addressing_set_fault_to(), and soap_addressing_set_fault_to_address().

xmlURI* soap_addressing_get_fault_to_address struct SoapEnv envelope  ) 
 

Definition at line 566 of file soap-addressing.c.

References soap_addressing_get_address(), and soap_addressing_get_fault_to().

xmlNodePtr soap_addressing_get_from struct SoapEnv envelope  ) 
 

Definition at line 487 of file soap-addressing.c.

References SoapEnv::header, and WSA_FROM.

Referenced by soap_addressing_get_from_address(), soap_addressing_set_from(), and soap_addressing_set_from_address().

xmlURI* soap_addressing_get_from_address struct SoapEnv envelope  ) 
 

Definition at line 493 of file soap-addressing.c.

References soap_addressing_get_address(), and soap_addressing_get_from().

Referenced by soap_addressing_get_from_address_string().

xmlChar* soap_addressing_get_from_address_string struct SoapEnv envelope  ) 
 

Definition at line 505 of file soap-addressing.c.

References soap_addressing_get_from_address().

xmlURI* soap_addressing_get_message_id struct SoapEnv envelope  ) 
 

Definition at line 307 of file soap-addressing.c.

References SoapEnv::header, and WSA_MESSAGE_ID.

Referenced by soap_addressing_get_message_id_string().

xmlChar* soap_addressing_get_message_id_string struct SoapEnv envelope  ) 
 

Definition at line 355 of file soap-addressing.c.

References soap_addressing_get_message_id().

Referenced by soap_client_invoke().

xmlNodePtr soap_addressing_get_metadata xmlNodePtr  endpoint_reference  ) 
 

Definition at line 282 of file soap-addressing.c.

References WSA_METADATA.

Referenced by soap_addressing_set_metadata().

xmlNodePtr soap_addressing_get_reference_properties xmlNodePtr  endpoint_reference  ) 
 

Definition at line 257 of file soap-addressing.c.

References WSA_REFERENCE_PROPERTIES.

Referenced by soap_addressing_set_reference_properties().

xmlNodePtr soap_addressing_get_relates_to struct SoapEnv envelope  ) 
 

Definition at line 370 of file soap-addressing.c.

References SoapEnv::header, and WSA_RELATES_TO.

Referenced by soap_addressing_add_relates_to().

xmlNodePtr soap_addressing_get_reply_to struct SoapEnv envelope  ) 
 

Definition at line 395 of file soap-addressing.c.

References SoapEnv::header, and WSA_REPLY_TO.

Referenced by soap_addressing_get_reply_to_address(), soap_addressing_set_reply_to(), and soap_addressing_set_reply_to_address().

xmlURI* soap_addressing_get_reply_to_address struct SoapEnv envelope  ) 
 

Definition at line 422 of file soap-addressing.c.

References soap_addressing_get_address(), and soap_addressing_get_reply_to().

xmlNodePtr soap_addressing_get_to struct SoapEnv envelope  ) 
 

Definition at line 597 of file soap-addressing.c.

References SoapEnv::header, and WSA_TO.

Referenced by soap_addressing_get_to_address(), soap_addressing_set_to(), and soap_addressing_set_to_address().

xmlURI* soap_addressing_get_to_address struct SoapEnv envelope  ) 
 

Definition at line 624 of file soap-addressing.c.

References soap_addressing_get_address(), and soap_addressing_get_to().

Referenced by soap_addressing_get_to_address_string(), soap_nudp_server_run(), soap_server_process(), soap_transport_client_invoke(), and soap_xmlsec_encrypt().

xmlChar* soap_addressing_get_to_address_string struct SoapEnv envelope  ) 
 

Definition at line 635 of file soap-addressing.c.

References soap_addressing_get_to_address().

Referenced by soap_transport_client_invoke().

xmlNodePtr soap_addressing_set_action struct SoapEnv envelope,
xmlURI *  action
 

Definition at line 711 of file soap-addressing.c.

References SoapEnv::header, and WSA_ACTION.

Referenced by soap_addressing_set_action_string().

xmlNodePtr soap_addressing_set_action_string struct SoapEnv envelope,
const char *  action
 

Definition at line 723 of file soap-addressing.c.

References soap_addressing_set_action().

Referenced by soap_client_invoke().

xmlNodePtr soap_addressing_set_address xmlNodePtr  endpoint_reference,
xmlURI *  address
 

Definition at line 245 of file soap-addressing.c.

References WSA_ADDRESS.

Referenced by soap_addressing_set_fault_to_address(), soap_addressing_set_from_address(), soap_addressing_set_reply_to_address(), and soap_addressing_set_to_address().

xmlNodePtr soap_addressing_set_fault_to struct SoapEnv envelope,
xmlNodePtr  address
 

Definition at line 545 of file soap-addressing.c.

References SoapEnv::header, soap_addressing_get_fault_to(), and WSA_FAULT_TO.

xmlNodePtr soap_addressing_set_fault_to_address struct SoapEnv envelope,
xmlURI *  address
 

Definition at line 578 of file soap-addressing.c.

References SoapEnv::header, soap_addressing_get_fault_to(), soap_addressing_set_address(), and WSA_FAULT_TO.

xmlNodePtr soap_addressing_set_fault_to_string struct SoapEnv envelope,
const char *  fault_to
 

xmlNodePtr soap_addressing_set_from struct SoapEnv envelope,
xmlNodePtr  address
 

Definition at line 453 of file soap-addressing.c.

References SoapEnv::header, soap_addressing_get_from(), and WSA_FROM.

xmlNodePtr soap_addressing_set_from_address struct SoapEnv envelope,
xmlURI *  address
 

Definition at line 520 of file soap-addressing.c.

References SoapEnv::header, soap_addressing_get_from(), soap_addressing_set_address(), and WSA_FROM.

Referenced by soap_addressing_set_from_address_string().

xmlNodePtr soap_addressing_set_from_address_string struct SoapEnv envelope,
const char *  from
 

Definition at line 474 of file soap-addressing.c.

References soap_addressing_set_from_address().

Referenced by soap_client_invoke().

xmlNodePtr soap_addressing_set_message_id struct SoapEnv envelope,
xmlURI *  id
 

Definition at line 319 of file soap-addressing.c.

References SoapEnv::header, and WSA_MESSAGE_ID.

xmlNodePtr soap_addressing_set_message_id_string struct SoapEnv envelope,
xmlChar *  id
 

Definition at line 331 of file soap-addressing.c.

References SoapEnv::header, log_verbose2, and WSA_MESSAGE_ID.

Referenced by soap_client_invoke().

xmlNodePtr soap_addressing_set_metadata xmlNodePtr  endpoint_reference,
xmlNodePtr  parameter
 

Definition at line 288 of file soap-addressing.c.

References soap_addressing_get_metadata().

xmlNodePtr soap_addressing_set_reference_properties xmlNodePtr  endpoint_reference,
xmlNodePtr  property
 

Definition at line 263 of file soap-addressing.c.

References soap_addressing_get_reference_properties().

xmlNodePtr soap_addressing_set_reply_to struct SoapEnv envelope,
xmlNodePtr  address
 

Definition at line 401 of file soap-addressing.c.

References SoapEnv::header, soap_addressing_get_reply_to(), and WSA_REPLY_TO.

xmlNodePtr soap_addressing_set_reply_to_address struct SoapEnv envelope,
xmlURI *  address
 

Definition at line 434 of file soap-addressing.c.

References SoapEnv::header, soap_addressing_get_reply_to(), soap_addressing_set_address(), and WSA_REPLY_TO.

xmlNodePtr soap_addressing_set_to struct SoapEnv envelope,
xmlNodePtr  address
 

Definition at line 603 of file soap-addressing.c.

References SoapEnv::header, soap_addressing_get_to(), and WSA_TO.

xmlNodePtr soap_addressing_set_to_address struct SoapEnv envelope,
xmlURI *  address
 

Definition at line 665 of file soap-addressing.c.

References SoapEnv::header, soap_addressing_get_to(), soap_addressing_set_address(), and WSA_TO.

Referenced by soap_addressing_set_to_address_string().

xmlNodePtr soap_addressing_set_to_address_string struct SoapEnv envelope,
const char *  to
 

Definition at line 650 of file soap-addressing.c.

References soap_addressing_set_to_address().

Referenced by soap_client_invoke(), and soap_nudp_server_run().


Generated on Thu Jan 25 23:36:04 2007 for csoap by  doxygen 1.4.6