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/

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.

#define WSA_ADDRESS   "Address"
 

An address URI that identifies the endpoint. This may be a network address or a logical 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.

#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.

#define WSA_ENDPOINT_REFERENCE_TYPE   "EndpointReferenceType"
 

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

#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.

#define WSA_FROM   "From"
 

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

#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.

#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.

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

Namespace used for the addressing elements.

#define WSA_NAMESPACE_PREFIX   "wsa"
 

Prefix for the WSA namespace used internally.

See also:
WSA_NAMESPACE

#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.

#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].

#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.

#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.

#define WSA_REPLY   WSA_NAMESPACE "/reply"
 

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

#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.

#define WSA_TO   "To"
 

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

Function Documentation

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

xmlURI* soap_addressing_get_action (  struct SoapEnv *  envelope  ) 
 

xmlChar* soap_addressing_get_action_string (  struct SoapEnv *  envelope  ) 
 

xmlURI* soap_addressing_get_address (  xmlNodePtr  endpoint_reference  ) 
 

xmlNodePtr soap_addressing_get_fault_to (  struct SoapEnv *  envelope  ) 
 

xmlURI* soap_addressing_get_fault_to_address (  struct SoapEnv *  envelope  ) 
 

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  ) 
 

xmlURI* soap_addressing_get_message_id (  struct SoapEnv *  envelope  ) 
 

xmlChar* soap_addressing_get_message_id_string (  struct SoapEnv *  envelope  ) 
 

xmlNodePtr soap_addressing_get_metadata (  xmlNodePtr  endpoint_reference  ) 
 

xmlNodePtr soap_addressing_get_reference_properties (  xmlNodePtr  endpoint_reference  ) 
 

xmlNodePtr soap_addressing_get_relates_to (  struct SoapEnv *  envelope  ) 
 

xmlNodePtr soap_addressing_get_reply_to (  struct SoapEnv *  envelope  ) 
 

xmlURI* soap_addressing_get_reply_to_address (  struct SoapEnv *  envelope  ) 
 

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_action (  struct SoapEnv *  envelope,
xmlURI *  action
) 
 

xmlNodePtr soap_addressing_set_action_string (  struct SoapEnv *  envelope,
const char *  action
) 
 

xmlNodePtr soap_addressing_set_address (  xmlNodePtr  endpoint_reference,
xmlURI *  address
) 
 

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_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_set_message_id (  struct SoapEnv *  envelope,
xmlURI *  id
) 
 

xmlNodePtr soap_addressing_set_message_id_string (  struct SoapEnv *  envelope,
xmlChar *  id
) 
 

xmlNodePtr soap_addressing_set_metadata (  xmlNodePtr  endpoint_reference,
xmlNodePtr  parameter
) 
 

xmlNodePtr soap_addressing_set_reference_properties (  xmlNodePtr  endpoint_reference,
xmlNodePtr  property
) 
 

xmlNodePtr soap_addressing_set_reply_to (  struct SoapEnv *  envelope,
xmlNodePtr  address
) 
 

xmlNodePtr soap_addressing_set_reply_to_address (  struct SoapEnv *  envelope,
xmlURI *  address
) 
 

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
) 
 

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