Top Description Inners Fields Constructors Methods
jakarta.xml.ws.wsaddressing

public final Class W3CEndpointReference

extends EndpointReference
Class Inheritance
Annotations
@XmlRootElement
name:EndpointReference
namespace:http://www.w3.org/2005/08/addressing
@XmlType
name:EndpointReferenceType
namespace:http://www.w3.org/2005/08/addressing
Imports
org.w3c.dom.Element, jakarta.xml.bind.JAXBContext, .JAXBException, .Marshaller, jakarta.xml.bind.annotation.XmlAnyAttribute, .XmlAnyElement, .XmlElement, .XmlRootElement, .XmlType, .XmlValue, jakarta.xml.ws.EndpointReference, .WebServiceException, java.util.List, .Map, javax.xml.namespace.QName, javax.xml.transform.Result, .Source
This class represents a W3C Addressing EndpointReferece which is a remote reference to a web service endpoint that supports the W3C WS-Addressing 1.0 - Core Recommendation.

Developers should use this class in their SEIs if they want to pass/return endpoint references that represent the W3C WS-Addressing recommendation.

Jakarta XML Binding will use the Jakarta XML Binding annotations and bind this class to XML infoset that is consistent with that defined by WS-Addressing. See WS-Addressing for more information on WS-Addressing EndpointReferences.

Since
1.6, JAX-WS 2.1

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
W3CEndpointReference.Address

private static class
W3CEndpointReference.Elements

Field Summary

Modifier and TypeField and Description
private W3CEndpointReference.Address
address

pack-priv Map<QName, String>
attributes

pack-priv List<Element>
elements

private W3CEndpointReference.Elements
metadata

pack-priv static final String
NS

Addressing namespace.

private W3CEndpointReference.Elements
referenceParameters

private final JAXBContext
w3cjc

Constructor Summary

AccessConstructor and Description
private
W3CEndpointReference()

Default constructor.

public
W3CEndpointReference(Source
A source object containing valid XmlInfoset instance consistent with the W3C WS-Addressing Core recommendation.
source)

Creates an EPR from infoset representation

Method Summary

Modifier and TypeMethod and Description
pack-priv Map<QName, String>

Returns:

The extension attributes of the wsa:Address element.
getAddressAttributes()

Returns a list of extension attributes of the W3CEndpointReference instance's wsa:Address element.

pack-priv String

Returns:

The address of the wsa:Address.
getAddressUri()

Returns the address of the W3CEndpointReference instance's wsa:Address element.

pack-priv Map<QName, String>

Returns:

The extension attributes of the W3CEndpointReference.
getAttributes()

Returns a list of extension attributes of the W3CEndpointReference instance's wsa:EndpointReference element.

pack-priv List<Element>

Returns:

Extension elements of the W3CEndpointReference instance.
getElements()

Returns a list of an extension elements of the W3CEndpointReference instance's wsa:EndpointReference element.

pack-priv List<Element>

Returns:

The metadataElements of the wsa:Metadata element.
getMetadata()

Returns the list of metadataElements of the W3CEndpointReference instance's of the wsa:Metadata element.

pack-priv List<Element>

Returns:

The referenceParameters of the wsa:ReferenceParameters element.
getReferenceParameters()

Returns a list of the referenceParameters of the W3CEndpointReference instance's wsa:ReferenceParameters element.

private static JAXBContext
getW3CJaxbContext()

public void
writeTo(Result
for writing infoset
result)

Implements abstract jakarta.xml.ws.EndpointReference.writeTo.

write this EndpointReference to the specified infoset format
Inherited from jakarta.xml.ws.EndpointReference:
getPortreadFromtoString

Field Detail

addressback to summary
private W3CEndpointReference.Address address
Annotations
@XmlElement
name:Address
namespace:http://www.w3.org/2005/08/addressing
attributesback to summary
pack-priv Map<QName, String> attributes
Annotations
@XmlAnyAttribute
elementsback to summary
pack-priv List<Element> elements
Annotations
@XmlAnyElement
metadataback to summary
private W3CEndpointReference.Elements metadata
Annotations
@XmlElement
name:Metadata
namespace:http://www.w3.org/2005/08/addressing
NSback to summary
pack-priv static final String NS

Addressing namespace.

referenceParametersback to summary
private W3CEndpointReference.Elements referenceParameters
Annotations
@XmlElement
name:ReferenceParameters
namespace:http://www.w3.org/2005/08/addressing
w3cjcback to summary
private final JAXBContext w3cjc

Constructor Detail

W3CEndpointReferenceback to summary
private W3CEndpointReference()

Default constructor.

W3CEndpointReferenceback to summary
public W3CEndpointReference(Source source)

Creates an EPR from infoset representation

Parameters
source:Source

A source object containing valid XmlInfoset instance consistent with the W3C WS-Addressing Core recommendation.

Exceptions
WebServiceException:
If the source does NOT contain a valid W3C WS-Addressing EndpointReference.
NullPointerException:
If the null source value is given

Method Detail

getAddressAttributesback to summary
pack-priv Map<QName, String> getAddressAttributes()

Returns a list of extension attributes of the W3CEndpointReference instance's wsa:Address element.

Returns:Map<QName, String>

The extension attributes of the wsa:Address element.

getAddressUriback to summary
pack-priv String getAddressUri()

Returns the address of the W3CEndpointReference instance's wsa:Address element.

Returns:String

The address of the wsa:Address.

getAttributesback to summary
pack-priv Map<QName, String> getAttributes()

Returns a list of extension attributes of the W3CEndpointReference instance's wsa:EndpointReference element.

Returns:Map<QName, String>

The extension attributes of the W3CEndpointReference.

getElementsback to summary
pack-priv List<Element> getElements()

Returns a list of an extension elements of the W3CEndpointReference instance's wsa:EndpointReference element.

Returns:List<Element>

Extension elements of the W3CEndpointReference instance.

getMetadataback to summary
pack-priv List<Element> getMetadata()

Returns the list of metadataElements of the W3CEndpointReference instance's of the wsa:Metadata element.

Returns:List<Element>

The metadataElements of the wsa:Metadata element.

getReferenceParametersback to summary
pack-priv List<Element> getReferenceParameters()

Returns a list of the referenceParameters of the W3CEndpointReference instance's wsa:ReferenceParameters element.

Returns:List<Element>

The referenceParameters of the wsa:ReferenceParameters element.

getW3CJaxbContextback to summary
private static JAXBContext getW3CJaxbContext()
writeToback to summary
public void writeTo(Result result)

Implements abstract jakarta.xml.ws.EndpointReference.writeTo.

Doc from jakarta.xml.ws.EndpointReference.writeTo.

write this EndpointReference to the specified infoset format

Parameters
result:Result

for writing infoset

Annotations
@Override
jakarta.xml.ws.wsaddressing back to summary

private Class W3CEndpointReference.Address

extends Object
Class Inheritance
Annotations
@XmlType
name:address
namespace:http://www.w3.org/2005/08/addressing

Field Summary

Modifier and TypeField and Description
pack-priv Map<QName, String>
attributes

pack-priv String
uri

Constructor Summary

AccessConstructor and Description
protected
Address()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

attributesback to summary
pack-priv Map<QName, String> attributes
Annotations
@XmlAnyAttribute
uriback to summary
pack-priv String uri
Annotations
@XmlValue

Constructor Detail

Addressback to summary
protected Address()
jakarta.xml.ws.wsaddressing back to summary

private Class W3CEndpointReference.Elements

extends Object
Class Inheritance
Annotations
@XmlType
name:elements
namespace:http://www.w3.org/2005/08/addressing

Field Summary

Modifier and TypeField and Description
pack-priv Map<QName, String>
attributes

pack-priv List<Element>
elements

Constructor Summary

AccessConstructor and Description
protected
Elements()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

attributesback to summary
pack-priv Map<QName, String> attributes
Annotations
@XmlAnyAttribute
elementsback to summary
pack-priv List<Element> elements
Annotations
@XmlAnyElement

Constructor Detail

Elementsback to summary
protected Elements()