com.sun.xml.ws.api.addressing
Enum AddressingVersion

java.lang.Object
  java.lang.Enum<AddressingVersion>
      com.sun.xml.ws.api.addressing.AddressingVersion

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AddressingVersion>

public enum AddressingVersion
extends java.lang.Enum<AddressingVersion>

'Traits' object that absorbs differences of WS-Addressing versions.

Nested Class Summary

static class

AddressingVersion.EPR

Enum Constant Summary

MEMBER

W3C

Field Summary

javax.xml.namespace.QName	actionMismatchTag Represents the QName of the fault code when Action is not supported at this endpoint.
javax.xml.namespace.QName	actionNotSupportedTag Represents the QName of the fault code when Action is not supported at this endpoint.
java.lang.String	actionNotSupportedText Represents the text of the fault when Action is not supported at this endpoint.
javax.xml.namespace.QName	actionTag Represents the Action QName in the SOAP message for a specific WS-Addressing Version.
WSEndpointReference	anonymousEpr Represents the anonymous EPR.
java.lang.String	anonymousUri Gets the anonymous URI value associated with this WS-Addressing version.
AddressingVersion.EPR	eprType Representing either W3CEndpointReference or MemberSubmissionEndpointReference.
static javax.xml.namespace.QName	fault_duplicateAddressInEpr Fault sub-sub-code that represents duplicate <Address> element in EPR.
javax.xml.namespace.QName	fault_missingAddressInEpr Fault sub-sub-code that represents "Specifies that the invalid header was expected to be an EPR but did not contain an [address]."
javax.xml.namespace.QName	faultDetailTag Represents the QName of the header element that is used to capture the fault detail if there is a fault processing WS-Addressing Message Addressing Property.
javax.xml.namespace.QName	faultToTag Represents the FaultTo QName for a specific WS-Addressing Version.
javax.xml.namespace.QName	fromTag Represents the From QName in the SOAP message for a specific WS-Addressing Version.
javax.xml.namespace.QName	invalidAddressTag Represents the QName of the fault code when a header representing an address is not valid.
javax.xml.namespace.QName	invalidCardinalityTag Represents the QName of the fault code when a header representing a WS-Addressing Message Addressing Property occurs greater than expected number.
javax.xml.namespace.QName	invalidMapTag Represents the QName of the fault code when a header representing a WS-Addressing Message Addressing Property is invalid and cannot be processed.
javax.xml.namespace.QName	isReferenceParameterTag Represents the QName of the reference parameter in a SOAP message.
javax.xml.namespace.QName	mapRequiredTag Represents the QName of the fault code when a required header representing a WS-Addressing Message Addressing Property is not present.
javax.xml.namespace.QName	messageIDTag Represents the MessageID QName in the SOAP message for a specific WS-Addressing Version.
java.lang.String	noneUri Gets the none URI value associated with this WS-Addressing version.
java.lang.String	nsUri Namespace URI
java.lang.String	policyNsUri Namespace URI for the WSDL Binding
javax.xml.namespace.QName	problemActionTag Represents the QName of the element that conveys additional information if Action is not matching with that expected.
javax.xml.namespace.QName	problemHeaderQNameTag Represents the QName of the element that conveys additional information on the pre-defined WS-Addressing faults.
javax.xml.namespace.QName	relatesToTag Represents the RelatesTo QName in the SOAP message for a specific WS-Addressing Version.
javax.xml.namespace.QName	replyToTag Represents the ReplyTo QName in the SOAP message for a specific WS-Addressing Version.
javax.xml.namespace.QName	toTag Represents the To QName in the SOAP message for a specific WS-Addressing Version.
static java.lang.String	UNSET_INPUT_ACTION
static java.lang.String	UNSET_OUTPUT_ACTION
javax.xml.namespace.QName	wsdlActionTag Represents the Action QName in the WSDL for a specific WS-Addressing Version.
javax.xml.namespace.QName	wsdlAnonymousTag Represents the WSDL anonymous QName for a specific WS-Addressing Version.
javax.xml.namespace.QName	wsdlExtensionTag Represents the WSDL extension QName for a specific WS-Addressing Version.
java.lang.String	wsdlNsUri Namespace URI for the WSDL Binding

Method Summary

static AddressingVersion	fromBinding(WSBinding binding) Gets the AddressingVersion from a WSBinding
static AddressingVersion	fromFeature(javax.xml.ws.WebServiceFeature af)
static AddressingVersion	fromNsUri(java.lang.String nsUri) Returns AddressingVersion whose nsUri equals to the given string.
static AddressingVersion	fromPort(WSDLPort port) Gets the AddressingVersion from a WSDLPort
static AddressingVersion	fromSpecClass(java.lang.Class<? extends javax.xml.ws.EndpointReference> eprClass) Gets the corresponding AddressingVersion instance from the EPR class.
java.lang.String	getAnonymousUri() Deprecated. Use anonymousUri
java.lang.String	getDefaultFaultAction() Gets the default fault Action value associated with this WS-Addressing version.
static javax.xml.ws.WebServiceFeature	getFeature(java.lang.String nsUri, boolean enabled, boolean required) Gets the WebServiceFeature corresponding to the namespace URI of WS-Addressing policy assertion in the WSDL.
abstract java.lang.Class<? extends javax.xml.ws.WebServiceFeature>	getFeatureClass()
abstract java.lang.String	getInvalidMapText() Gets the description text when a header representing a WS-Addressing Message Addressing Property is invalid and cannot be processed.
abstract java.lang.String	getMapRequiredText() Gets the description text when a required WS-Addressing header representing a Message Addressing Property is absent.
java.lang.String	getNoneUri() Deprecated. Use noneUri.
java.lang.String	getNsUri() Deprecated. Use nsUri.
abstract java.lang.String	getPrefix()
abstract WsaTubeHelper	getWsaHelper(WSDLPort wsdlPort, SEIModel seiModel, WSBinding binding) Deprecated. TODO why are we exposing implementation specificc class through api? TODO Remove it if no one elase uses it.
abstract java.lang.String	getWsdlPrefix()
static boolean	isEnabled(WSBinding binding) Returns true if binding contains either a AddressingFeature or MemberSubmissionAddressingFeature and is enabled.
abstract boolean	isReferenceParameter(java.lang.String localName) Returns true if the given local name is considered as a reference parameter in EPR.
static boolean	isRequired(javax.xml.ws.WebServiceFeature wsf) Returns true if the WebServiceFeature is either a AddressingFeature or MemberSubmissionAddressingFeature and is required.
static boolean	isRequired(WSBinding binding) Returns true if binding contains either a AddressingFeature or MemberSubmissionAddressingFeature and is required.
static AddressingVersion	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AddressingVersion[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

W3C

public static final AddressingVersion W3C

MEMBER

public static final AddressingVersion MEMBER

Field Detail

nsUri

public final java.lang.String nsUri

Namespace URI

wsdlNsUri

public final java.lang.String wsdlNsUri

Namespace URI for the WSDL Binding

eprType

public final AddressingVersion.EPR eprType

Representing either W3CEndpointReference or MemberSubmissionEndpointReference.

policyNsUri

public final java.lang.String policyNsUri

Namespace URI for the WSDL Binding

anonymousUri

@NotNull
public final java.lang.String anonymousUri

Gets the anonymous URI value associated with this WS-Addressing version.

noneUri

@NotNull
public final java.lang.String noneUri

Gets the none URI value associated with this WS-Addressing version.

anonymousEpr

public final WSEndpointReference anonymousEpr

Represents the anonymous EPR.

toTag

public final javax.xml.namespace.QName toTag

Represents the To QName in the SOAP message for a specific WS-Addressing Version.

fromTag

public final javax.xml.namespace.QName fromTag

Represents the From QName in the SOAP message for a specific WS-Addressing Version.

replyToTag

public final javax.xml.namespace.QName replyToTag

Represents the ReplyTo QName in the SOAP message for a specific WS-Addressing Version.

faultToTag

public final javax.xml.namespace.QName faultToTag

Represents the FaultTo QName for a specific WS-Addressing Version.

actionTag

public final javax.xml.namespace.QName actionTag

Represents the Action QName in the SOAP message for a specific WS-Addressing Version.

messageIDTag

public final javax.xml.namespace.QName messageIDTag

Represents the MessageID QName in the SOAP message for a specific WS-Addressing Version.

relatesToTag

public final javax.xml.namespace.QName relatesToTag

Represents the RelatesTo QName in the SOAP message for a specific WS-Addressing Version.

mapRequiredTag

public final javax.xml.namespace.QName mapRequiredTag

Represents the QName of the fault code when a required header representing a WS-Addressing Message Addressing Property is not present.

actionMismatchTag

public final javax.xml.namespace.QName actionMismatchTag

Represents the QName of the fault code when Action is not supported at this endpoint.

actionNotSupportedTag

public final javax.xml.namespace.QName actionNotSupportedTag

Represents the QName of the fault code when Action is not supported at this endpoint.

actionNotSupportedText

public final java.lang.String actionNotSupportedText

Represents the text of the fault when Action is not supported at this endpoint.

invalidMapTag

public final javax.xml.namespace.QName invalidMapTag

Represents the QName of the fault code when a header representing a WS-Addressing Message Addressing Property is invalid and cannot be processed.

invalidCardinalityTag

public final javax.xml.namespace.QName invalidCardinalityTag

Represents the QName of the fault code when a header representing a WS-Addressing Message Addressing Property occurs greater than expected number.

invalidAddressTag

public final javax.xml.namespace.QName invalidAddressTag

Represents the QName of the fault code when a header representing an address is not valid.

problemHeaderQNameTag

public final javax.xml.namespace.QName problemHeaderQNameTag

Represents the QName of the element that conveys additional information on the pre-defined WS-Addressing faults.

problemActionTag

public final javax.xml.namespace.QName problemActionTag

Represents the QName of the element that conveys additional information if Action is not matching with that expected.

faultDetailTag

public final javax.xml.namespace.QName faultDetailTag

Represents the QName of the header element that is used to capture the fault detail if there is a fault processing WS-Addressing Message Addressing Property. This is only used for SOAP 1.1.

fault_missingAddressInEpr

public final javax.xml.namespace.QName fault_missingAddressInEpr

Fault sub-sub-code that represents "Specifies that the invalid header was expected to be an EPR but did not contain an [address]."

wsdlActionTag

public final javax.xml.namespace.QName wsdlActionTag

Represents the Action QName in the WSDL for a specific WS-Addressing Version.

wsdlExtensionTag

public final javax.xml.namespace.QName wsdlExtensionTag

Represents the WSDL extension QName for a specific WS-Addressing Version.

wsdlAnonymousTag

public final javax.xml.namespace.QName wsdlAnonymousTag

Represents the WSDL anonymous QName for a specific WS-Addressing Version.

isReferenceParameterTag

public final javax.xml.namespace.QName isReferenceParameterTag

Represents the QName of the reference parameter in a SOAP message. This is only valid for W3C WS-Addressing.

UNSET_OUTPUT_ACTION

public static final java.lang.String UNSET_OUTPUT_ACTION

See Also:

Constant Field Values

UNSET_INPUT_ACTION

public static final java.lang.String UNSET_INPUT_ACTION

See Also:

Constant Field Values

fault_duplicateAddressInEpr

public static final javax.xml.namespace.QName fault_duplicateAddressInEpr

Fault sub-sub-code that represents duplicate <Address> element in EPR. This is a fault code not defined in the spec.

Method Detail

values

public static AddressingVersion[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AddressingVersion c : AddressingVersion.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AddressingVersion valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromNsUri

public static AddressingVersion fromNsUri(java.lang.String nsUri)

Returns AddressingVersion whose nsUri equals to the given string. This method does not perform input string validation.

Parameters:

nsUri - must not be null.

Returns:

always non-null.

fromBinding

@Nullable
public static AddressingVersion fromBinding(WSBinding binding)

Gets the AddressingVersion from a WSBinding

Parameters:

binding - WSDL binding

Returns:

addresing version enabled, or null if none is enabled.

fromPort

public static AddressingVersion fromPort(WSDLPort port)

Gets the AddressingVersion from a WSDLPort

Parameters:

port - WSDL port

Returns:

addresing version

getNsUri

public java.lang.String getNsUri()

Deprecated. Use nsUri.

Returns nsUri associated with this AddressingVersion

Returns:

namespace URI

isReferenceParameter

public abstract boolean isReferenceParameter(java.lang.String localName)

Returns true if the given local name is considered as a reference parameter in EPR. For W3C, this means "ReferenceParameters", and for the member submission version, this means either "ReferenceParameters" or "ReferenceProperties".

getWsaHelper

public abstract WsaTubeHelper getWsaHelper(WSDLPort wsdlPort,
                                           SEIModel seiModel,
                                           WSBinding binding)

Deprecated. TODO why are we exposing implementation specificc class through api? TODO Remove it if no one elase uses it.

Returns WsaTubeHelper for the WS-Addressing version identified by binding WSBinding and for the WSDLPort port.

Returns:

WS-A version specific helper

getNoneUri

public final java.lang.String getNoneUri()

Deprecated. Use noneUri.

Gets the none URI value associated with this WS-Addressing version.

Returns:

none URI value

getAnonymousUri

public final java.lang.String getAnonymousUri()

Deprecated. Use anonymousUri

Gets the anonymous URI value associated with this WS-Addressing version.

getDefaultFaultAction

public java.lang.String getDefaultFaultAction()

Gets the default fault Action value associated with this WS-Addressing version.

Returns:

default fault Action value

getMapRequiredText

public abstract java.lang.String getMapRequiredText()

Gets the description text when a required WS-Addressing header representing a Message Addressing Property is absent.

Returns:

description text

getInvalidMapText

public abstract java.lang.String getInvalidMapText()

Gets the description text when a header representing a WS-Addressing Message Addressing Property is invalid and cannot be processed.

Returns:

description text

getPrefix

public abstract java.lang.String getPrefix()

getWsdlPrefix

public abstract java.lang.String getWsdlPrefix()

getFeatureClass

public abstract java.lang.Class<? extends javax.xml.ws.WebServiceFeature> getFeatureClass()

fromFeature

public static AddressingVersion fromFeature(javax.xml.ws.WebServiceFeature af)

getFeature

@NotNull
public static javax.xml.ws.WebServiceFeature getFeature(java.lang.String nsUri,
                                                                boolean enabled,
                                                                boolean required)

Gets the WebServiceFeature corresponding to the namespace URI of WS-Addressing policy assertion in the WSDL. enabled and required are used to initialize the value of the feature.

Parameters:

nsUri - namespace URI of the WS-Addressing policy assertion in the WSDL

enabled - true if feature is to be enabled, false otherwise

required - true if feature is required, false otherwise. Corresponds to wsdl:required on the extension/assertion.

Returns:

WebServiceFeature corresponding to the assertion namespace URI

Throws:

javax.xml.ws.WebServiceException - if an unsupported namespace URI is passed

fromSpecClass

@NotNull
public static AddressingVersion fromSpecClass(java.lang.Class<? extends javax.xml.ws.EndpointReference> eprClass)

Gets the corresponding AddressingVersion instance from the EPR class.

isRequired

public static boolean isRequired(javax.xml.ws.WebServiceFeature wsf)

Returns true if the WebServiceFeature is either a AddressingFeature or MemberSubmissionAddressingFeature and is required.

Parameters:

wsf - The WebServiceFeature encaps

Returns:

true if wsf requires WS-Addressing

Throws:

javax.xml.ws.WebServiceException - if wsf does not contain either AddressingFeature or MemberSubmissionAddressingFeature

isRequired

public static boolean isRequired(WSBinding binding)

Returns true if binding contains either a AddressingFeature or MemberSubmissionAddressingFeature and is required.

Parameters:

binding - The binding

Returns:

true if binding requires WS-Addressing

isEnabled

public static boolean isEnabled(WSBinding binding)

Returns true if binding contains either a AddressingFeature or MemberSubmissionAddressingFeature and is enabled.

Parameters:

binding - The binding

Returns:

true if WS-Addressing is enabled for binding.