org.apache.axis2.addressing
Class EndpointReferenceHelper

java.lang.Object
  extended byorg.apache.axis2.addressing.EndpointReferenceHelper

public class EndpointReferenceHelper
extends java.lang.Object

The methods in this class are used to process EndpointReference objects according to the rules of the 2005/08 (Final) and 2004/08 (submission) WS-Addressing specifications.


Constructor Summary
EndpointReferenceHelper()
           
 
Method Summary
static void fromOM(EndpointReference epr, org.apache.axiom.om.OMElement eprOMElement, java.lang.String addressingNamespace)
          Populates an endpoint reference based on the OMElement and WS-Addressing namespace that is passed in.
static EndpointReference fromOM(org.apache.axiom.om.OMElement eprOMElement)
          Populates an endpoint reference based on the OMElement that is passed in.
static EndpointReference fromOM(java.lang.String eprString)
          Populates an endpoint reference based on the String that is passed in.
static org.apache.axiom.om.OMElement toOM(org.apache.axiom.om.OMFactory factory, EndpointReference epr, javax.xml.namespace.QName qname, java.lang.String addressingNamespace)
          Creates an OMElement based on the properties of the endpoint reference.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EndpointReferenceHelper

public EndpointReferenceHelper()
Method Detail

fromOM

public static void fromOM(EndpointReference epr,
                          org.apache.axiom.om.OMElement eprOMElement,
                          java.lang.String addressingNamespace)
                   throws AxisFault
Populates an endpoint reference based on the OMElement and WS-Addressing namespace that is passed in. If the string passed in is not recognized as a valid WS-Addressing namespace then this method behaves as if http://www.w3.org/2005/08/addressing has been passed in.

Parameters:
epr - an endpoint reference instance to hold the info.
eprOMElement - an element of endpoint reference type
addressingNamespace - the namespace of the WS-Addressing spec to comply with.
Throws:
AxisFault - if unable to locate an address element
See Also:
fromOM(OMElement)

fromOM

public static EndpointReference fromOM(java.lang.String eprString)
                                throws AxisFault
Populates an endpoint reference based on the String that is passed in. If the http://schemas.xmlsoap.org/ws/2004/08/addressing namespace is in effect then any reference properties will be saved as reference parameters. Regardless of the addressing namespace in effect, any elements present in the String that are not recognised are saved as extensibility elements.

Parameters:
eprString - string from the element of endpoint reference type
Throws:
AxisFault - if unable to locate an address element

fromOM

public static EndpointReference fromOM(org.apache.axiom.om.OMElement eprOMElement)
                                throws AxisFault
Populates an endpoint reference based on the OMElement that is passed in. If the http://schemas.xmlsoap.org/ws/2004/08/addressing namespace is in effect then any reference properties will be saved as reference parameters. Regardless of the addressing namespace in effect, any elements present in the OMElement that are not recognised are saved as extensibility elements.

Parameters:
eprOMElement - an element of endpoint reference type
Throws:
AxisFault - if unable to locate an address element

toOM

public static org.apache.axiom.om.OMElement toOM(org.apache.axiom.om.OMFactory factory,
                                                 EndpointReference epr,
                                                 javax.xml.namespace.QName qname,
                                                 java.lang.String addressingNamespace)
                                          throws AxisFault
Creates an OMElement based on the properties of the endpoint reference. The output may differ based on the addressing namespace that is in effect when this method is called. If the http://www.w3.org/2005/08/addressing namespace is in effect, and a metadata property has been defined for the endpoint reference, then there will be a metadata element to contain the property in the output. If the http://schemas.xmlsoap.org/ws/2004/08/addressing namespace is in effect, however, then no metadata element will be included in the output, even if a metadata property element has been defined.

Parameters:
factory -
epr -
qname -
addressingNamespace -
Returns:
Throws:
AxisFault


Copyright © 2004-2007 Apache Software Foundation. All Rights Reserved.