AbstractAddressingVersion (Spring Web Services 2.3.1.RELEASE API)

java.lang.Object
- org.springframework.xml.transform.TransformerObjectSupport
- - org.springframework.ws.soap.addressing.version.AbstractAddressingVersion

All Implemented Interfaces:

AddressingVersion

Direct Known Subclasses:

Addressing10, Addressing200408
```
public abstract class AbstractAddressingVersion
extends TransformerObjectSupport
implements AddressingVersion
```
Abstract base class for AddressingVersion implementations. Uses XPathExpressions to retrieve addressing information.

Since:

1.5.0

Author:

Arjen Poutsma

Field Summary
- Fields inherited from class org.springframework.xml.transform.TransformerObjectSupport
  logger

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAddressingVersion()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAddressingVersion()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAddressingHeaders(SoapMessage message, MessageAddressingProperties map)` Adds addressing SOAP headers to the given message, using the given `MessageAddressingProperties`.
`protected void`	`addEndpointReference(SoapHeaderElement headerElement, EndpointReference epr)` Adds ReplyTo, FaultTo, or From EPR to the given header Element.
`SoapFault`	`addInvalidAddressingHeaderFault(SoapMessage message)` Adds a Invalid Addressing Header fault to the given message.
`SoapFault`	`addMessageAddressingHeaderRequiredFault(SoapMessage message)` Adds a Message Addressing Header Required fault to the given message.
`protected void`	`addReferenceNodes(Result result, List<Node> nodes)`
`protected QName`	`getActionName()` Returns the qualified name of the `Action` addressing header.
`protected QName`	`getAddressName()` The qualified name of the `Address` in `EndpointReference`.
`protected abstract URI`	`getAnonymous()` Returns the anonymous URI.
`protected abstract EndpointReference`	`getDefaultReplyTo(EndpointReference from)` Returns the default ReplyTo EPR.
`protected abstract URI`	`getDefaultTo()` Returns the default To URI.
`protected QName`	`getFaultToName()` Returns the qualified name of the `FaultTo` addressing header.
`protected QName`	`getFromName()` Returns the qualified name of the `From` addressing header.
`protected abstract String`	`getInvalidAddressingHeaderFaultReason()` Returns the reason of the fault that indicates that a header is invalid.
`protected abstract QName`	`getInvalidAddressingHeaderFaultSubcode()` Returns the qualified name of the fault subcode that indicates that a header is invalid.
`protected abstract String`	`getMessageAddressingHeaderRequiredFaultReason()` Returns the reason of the fault that indicates that a header is missing.
`protected abstract QName`	`getMessageAddressingHeaderRequiredFaultSubcode()` Returns the qualified name of the fault subcode that indicates that a header is missing.
`MessageAddressingProperties`	`getMessageAddressingProperties(SoapMessage message)` Returns the `MessageAddressingProperties` for the given message.
`protected QName`	`getMessageIdName()` Returns the qualified name of the `MessageID` addressing header.
`protected String`	`getNamespacePrefix()` Returns the prefix associated with the WS-Addressing namespace handled by this specification.
`protected abstract String`	`getNamespaceUri()` Returns the WS-Addressing namespace handled by this specification.
`protected abstract URI`	`getNone()` Returns the none URI, or `null` if the spec does not define it.
`protected QName`	`getReferenceParametersName()` Returns the qualified name of the `ReferenceParameters` in the endpoint reference.
`protected QName`	`getReferencePropertiesName()` Returns the qualified name of the `ReferenceProperties` in the endpoint reference.
`protected QName`	`getRelatesToName()` Returns the qualified name of the `RelatesTo` addressing header.
`protected QName`	`getRelationshipTypeName()` Returns the qualified name of the `RelatesTo` addressing header.
`protected QName`	`getReplyToName()` Returns the qualified name of the `ReplyTo` addressing header.
`protected QName`	`getToName()` Returns the qualified name of the `To` addressing header.
`boolean`	`hasAnonymousAddress(EndpointReference epr)` Indicates whether the given endpoint reference has a Anonymous address.
`boolean`	`hasNoneAddress(EndpointReference epr)` Indicates whether the given endpoint reference has a None address.
`boolean`	`understands(SoapHeaderElement headerElement)` Given a `SoapHeaderElement`, return whether or not this version understands it.

Methods inherited from class org.springframework.xml.transform.TransformerObjectSupport
createTransformer, getTransformerFactory, newTransformerFactory, setTransformerFactoryClass, transform

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.ws.soap.addressing.version.AddressingVersion
hasRequiredProperties

- Constructor Detail
  - AbstractAddressingVersion
```
protected AbstractAddressingVersion()
```
- Method Detail
  - getMessageAddressingProperties
```
public MessageAddressingProperties getMessageAddressingProperties(SoapMessage message)
```
    Description copied from interface: AddressingVersion
    
    Returns the MessageAddressingProperties for the given message.
    
    Specified by:
    
    getMessageAddressingProperties in interface AddressingVersion
    
    Parameters:
    
    message - the message to find the map for
    
    Returns:
    
    the message addressing properties
    
    See Also:
    
    Message Addressing Properties
  - addAddressingHeaders
```
public void addAddressingHeaders(SoapMessage message,
                                 MessageAddressingProperties map)
```
    Description copied from interface: AddressingVersion
    
    Adds addressing SOAP headers to the given message, using the given MessageAddressingProperties.
    
    Specified by:
    
    addAddressingHeaders in interface AddressingVersion
    
    Parameters:
    
    message - the message to add the headers to
    
    map - the message addressing properties
  - understands
```
public final boolean understands(SoapHeaderElement headerElement)
```
    Description copied from interface: AddressingVersion
    
    Given a SoapHeaderElement, return whether or not this version understands it.
    
    Specified by:
    
    understands in interface AddressingVersion
    
    Parameters:
    
    headerElement - the header
    
    Returns:
    
    true if understood, false otherwise
  - addEndpointReference
```
protected void addEndpointReference(SoapHeaderElement headerElement,
                                    EndpointReference epr)
```
    Adds ReplyTo, FaultTo, or From EPR to the given header Element.
  - addReferenceNodes
```
protected void addReferenceNodes(Result result,
                                 List<Node> nodes)
```
  - addInvalidAddressingHeaderFault
```
public final SoapFault addInvalidAddressingHeaderFault(SoapMessage message)
```
    Description copied from interface: AddressingVersion
    
    Adds a Invalid Addressing Header fault to the given message.
    
    Specified by:
    
    addInvalidAddressingHeaderFault in interface AddressingVersion
    
    See Also:
    
    Invalid Addressing Header
  - addMessageAddressingHeaderRequiredFault
```
public final SoapFault addMessageAddressingHeaderRequiredFault(SoapMessage message)
```
    Description copied from interface: AddressingVersion
    
    Adds a Message Addressing Header Required fault to the given message.
    
    Specified by:
    
    addMessageAddressingHeaderRequiredFault in interface AddressingVersion
    
    See Also:
    
    Message Addressing Header Required
  - hasAnonymousAddress
```
public final boolean hasAnonymousAddress(EndpointReference epr)
```
    Description copied from interface: AddressingVersion
    
    Indicates whether the given endpoint reference has a Anonymous address. This address is used to indicate that a message should be sent in-band.
    
    Specified by:
    
    hasAnonymousAddress in interface AddressingVersion
    
    See Also:
    
    Formulating a Reply Message
  - hasNoneAddress
```
public final boolean hasNoneAddress(EndpointReference epr)
```
    Description copied from interface: AddressingVersion
    
    Indicates whether the given endpoint reference has a None address. Messages to be sent to this address will not be sent.
    
    Specified by:
    
    hasNoneAddress in interface AddressingVersion
    
    See Also:
    
    Sending a Message to an EPR
  - getNamespacePrefix
```
protected String getNamespacePrefix()
```
    Returns the prefix associated with the WS-Addressing namespace handled by this specification.
  - getNamespaceUri
```
protected abstract String getNamespaceUri()
```
    Returns the WS-Addressing namespace handled by this specification.
  - getToName
```
protected QName getToName()
```
    Returns the qualified name of the To addressing header.
  - getFromName
```
protected QName getFromName()
```
    Returns the qualified name of the From addressing header.
  - getReplyToName
```
protected QName getReplyToName()
```
    Returns the qualified name of the ReplyTo addressing header.
  - getFaultToName
```
protected QName getFaultToName()
```
    Returns the qualified name of the FaultTo addressing header.
  - getActionName
```
protected QName getActionName()
```
    Returns the qualified name of the Action addressing header.
  - getMessageIdName
```
protected QName getMessageIdName()
```
    Returns the qualified name of the MessageID addressing header.
  - getRelatesToName
```
protected QName getRelatesToName()
```
    Returns the qualified name of the RelatesTo addressing header.
  - getRelationshipTypeName
```
protected QName getRelationshipTypeName()
```
    Returns the qualified name of the RelatesTo addressing header.
  - getReferencePropertiesName
```
protected QName getReferencePropertiesName()
```
    Returns the qualified name of the ReferenceProperties in the endpoint reference. Returns null when reference properties are not supported by this version of the spec.
  - getReferenceParametersName
```
protected QName getReferenceParametersName()
```
    Returns the qualified name of the ReferenceParameters in the endpoint reference. Returns null when reference parameters are not supported by this version of the spec.
  - getAddressName
```
protected QName getAddressName()
```
    The qualified name of the Address in EndpointReference.
  - getDefaultTo
```
protected abstract URI getDefaultTo()
```
    Returns the default To URI.
  - getDefaultReplyTo
```
protected abstract EndpointReference getDefaultReplyTo(EndpointReference from)
```
    Returns the default ReplyTo EPR. Can be based on the From EPR, or the anonymous URI.
  - getAnonymous
```
protected abstract URI getAnonymous()
```
    Returns the anonymous URI.
  - getNone
```
protected abstract URI getNone()
```
    Returns the none URI, or null if the spec does not define it.
  - getMessageAddressingHeaderRequiredFaultSubcode
```
protected abstract QName getMessageAddressingHeaderRequiredFaultSubcode()
```
    Returns the qualified name of the fault subcode that indicates that a header is missing.
  - getMessageAddressingHeaderRequiredFaultReason
```
protected abstract String getMessageAddressingHeaderRequiredFaultReason()
```
    Returns the reason of the fault that indicates that a header is missing.
  - getInvalidAddressingHeaderFaultSubcode
```
protected abstract QName getInvalidAddressingHeaderFaultSubcode()
```
    Returns the qualified name of the fault subcode that indicates that a header is invalid.
  - getInvalidAddressingHeaderFaultReason
```
protected abstract String getInvalidAddressingHeaderFaultReason()
```
    Returns the reason of the fault that indicates that a header is invalid.

Class AbstractAddressingVersion

Field Summary

Fields inherited from class org.springframework.xml.transform.TransformerObjectSupport

Constructor Summary

Method Summary

Methods inherited from class org.springframework.xml.transform.TransformerObjectSupport

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.ws.soap.addressing.version.AddressingVersion

Constructor Detail

AbstractAddressingVersion

Method Detail

getMessageAddressingProperties

addAddressingHeaders

understands

addEndpointReference

addReferenceNodes

addInvalidAddressingHeaderFault

addMessageAddressingHeaderRequiredFault

hasAnonymousAddress

hasNoneAddress

getNamespacePrefix

getNamespaceUri

getToName

getFromName

getReplyToName

getFaultToName

getActionName

getMessageIdName

getRelatesToName

getRelationshipTypeName

getReferencePropertiesName

getReferenceParametersName

getAddressName

getDefaultTo

getDefaultReplyTo

getAnonymous

getNone

getMessageAddressingHeaderRequiredFaultSubcode

getMessageAddressingHeaderRequiredFaultReason

getInvalidAddressingHeaderFaultSubcode

getInvalidAddressingHeaderFaultReason