Package 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:
Serializable
,Comparable<AddressingVersion>
public enum AddressingVersion extends Enum<AddressingVersion>
'Traits' object that absorbs differences of WS-Addressing versions.- Author:
- Arun Gupta
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AddressingVersion.EPR
-
Field Summary
Fields Modifier and Type Field Description QName
actionMismatchTag
Represents the QName of the fault code when Action is not supported at this endpoint.QName
actionNotSupportedTag
Represents the QName of the fault code when Action is not supported at this endpoint.String
actionNotSupportedText
Represents the text of the fault when Action is not supported at this endpoint.QName
actionTag
Represents the Action QName in the SOAP message for a specific WS-Addressing Version.WSEndpointReference
anonymousEpr
Represents the anonymous EPR.String
anonymousUri
Gets the anonymous URI value associated with this WS-Addressing version.AddressingVersion.EPR
eprType
Representing eitherW3CEndpointReference
orMemberSubmissionEndpointReference
.static QName
fault_duplicateAddressInEpr
Fault sub-sub-code that represents duplicate <Address> element in EPR.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]."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.QName
faultToTag
Represents the FaultTo QName for a specific WS-Addressing Version.QName
fromTag
Represents the From QName in the SOAP message for a specific WS-Addressing Version.QName
invalidAddressTag
Represents the QName of the fault code when a header representing an address is not valid.QName
invalidCardinalityTag
Represents the QName of the fault code when a header representing a WS-Addressing Message Addressing Property occurs greater than expected number.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.QName
isReferenceParameterTag
Represents the QName of the reference parameter in a SOAP message.QName
mapRequiredTag
Represents the QName of the fault code when a required header representing a WS-Addressing Message Addressing Property is not present.QName
messageIDTag
Represents the MessageID QName in the SOAP message for a specific WS-Addressing Version.String
noneUri
Gets the none URI value associated with this WS-Addressing version.String
nsUri
Namespace URIString
policyNsUri
Namespace URI for the WSDL BindingQName
problemActionTag
Represents the QName of the element that conveys additional information if Action is not matching with that expected.QName
problemHeaderQNameTag
Represents the QName of the element that conveys additional information on the pre-defined WS-Addressing faults.QName
relatesToTag
Represents the RelatesTo QName in the SOAP message for a specific WS-Addressing Version.QName
replyToTag
Represents the ReplyTo QName in the SOAP message for a specific WS-Addressing Version.QName
toTag
Represents the To QName in the SOAP message for a specific WS-Addressing Version.static String
UNSET_INPUT_ACTION
static String
UNSET_OUTPUT_ACTION
QName
wsdlActionTag
Represents the Action QName in the WSDL for a specific WS-Addressing Version.QName
wsdlAnonymousTag
Represents the WSDL anonymous QName for a specific WS-Addressing Version.QName
wsdlExtensionTag
Represents the WSDL extension QName for a specific WS-Addressing Version.String
wsdlNsUri
Namespace URI for the WSDL Binding
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static AddressingVersion
fromBinding(WSBinding binding)
Gets theAddressingVersion
from aWSBinding
static AddressingVersion
fromFeature(javax.xml.ws.WebServiceFeature af)
static AddressingVersion
fromNsUri(String nsUri)
ReturnsAddressingVersion
whosensUri
equals to the given string.static AddressingVersion
fromPort(WSDLPort port)
Gets theAddressingVersion
from aWSDLPort
static AddressingVersion
fromSpecClass(Class<? extends javax.xml.ws.EndpointReference> eprClass)
Gets the correspondingAddressingVersion
instance from the EPR class.String
getAnonymousUri()
Deprecated.UseanonymousUri
String
getDefaultFaultAction()
Gets the default fault Action value associated with this WS-Addressing version.static javax.xml.ws.WebServiceFeature
getFeature(String nsUri, boolean enabled, boolean required)
Gets theWebServiceFeature
corresponding to the namespace URI of WS-Addressing policy assertion in the WSDL.abstract Class<? extends javax.xml.ws.WebServiceFeature>
getFeatureClass()
abstract String
getInvalidMapText()
Gets the description text when a header representing a WS-Addressing Message Addressing Property is invalid and cannot be processed.abstract String
getMapRequiredText()
Gets the description text when a required WS-Addressing header representing a Message Addressing Property is absent.String
getNoneUri()
Deprecated.UsenoneUri
.String
getNsUri()
Deprecated.UsensUri
.abstract 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 String
getWsdlPrefix()
static boolean
isEnabled(WSBinding binding)
Returns true ifbinding
contains either aAddressingFeature
orMemberSubmissionAddressingFeature
and is enabled.abstract boolean
isReferenceParameter(String localName)
Returns true if the given local name is considered as a reference parameter in EPR.static boolean
isRequired(WSBinding binding)
Returns true ifbinding
contains either aAddressingFeature
orMemberSubmissionAddressingFeature
and is required.static boolean
isRequired(javax.xml.ws.WebServiceFeature wsf)
Returns true if the WebServiceFeature is either aAddressingFeature
orMemberSubmissionAddressingFeature
and is required.static AddressingVersion
valueOf(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.
-
-
-
Enum Constant Detail
-
W3C
public static final AddressingVersion W3C
-
MEMBER
public static final AddressingVersion MEMBER
-
-
Field Detail
-
nsUri
public final String nsUri
Namespace URI
-
wsdlNsUri
public final String wsdlNsUri
Namespace URI for the WSDL Binding
-
eprType
public final AddressingVersion.EPR eprType
Representing eitherW3CEndpointReference
orMemberSubmissionEndpointReference
.
-
policyNsUri
public final String policyNsUri
Namespace URI for the WSDL Binding
-
anonymousUri
@NotNull public final String anonymousUri
Gets the anonymous URI value associated with this WS-Addressing version.
-
noneUri
@NotNull public final 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 QName toTag
Represents the To QName in the SOAP message for a specific WS-Addressing Version.
-
fromTag
public final QName fromTag
Represents the From QName in the SOAP message for a specific WS-Addressing Version.
-
replyToTag
public final QName replyToTag
Represents the ReplyTo QName in the SOAP message for a specific WS-Addressing Version.
-
faultToTag
public final QName faultToTag
Represents the FaultTo QName for a specific WS-Addressing Version.
-
actionTag
public final QName actionTag
Represents the Action QName in the SOAP message for a specific WS-Addressing Version.
-
messageIDTag
public final QName messageIDTag
Represents the MessageID QName in the SOAP message for a specific WS-Addressing Version.
-
relatesToTag
public final QName relatesToTag
Represents the RelatesTo QName in the SOAP message for a specific WS-Addressing Version.
-
mapRequiredTag
public final 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 QName actionMismatchTag
Represents the QName of the fault code when Action is not supported at this endpoint.
-
actionNotSupportedTag
public final QName actionNotSupportedTag
Represents the QName of the fault code when Action is not supported at this endpoint.
-
actionNotSupportedText
public final String actionNotSupportedText
Represents the text of the fault when Action is not supported at this endpoint.
-
invalidMapTag
public final 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 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 QName invalidAddressTag
Represents the QName of the fault code when a header representing an address is not valid.
-
problemHeaderQNameTag
public final QName problemHeaderQNameTag
Represents the QName of the element that conveys additional information on the pre-defined WS-Addressing faults.
-
problemActionTag
public final QName problemActionTag
Represents the QName of the element that conveys additional information if Action is not matching with that expected.
-
faultDetailTag
public final 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 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 QName wsdlActionTag
Represents the Action QName in the WSDL for a specific WS-Addressing Version.
-
wsdlExtensionTag
public final QName wsdlExtensionTag
Represents the WSDL extension QName for a specific WS-Addressing Version.
-
wsdlAnonymousTag
public final QName wsdlAnonymousTag
Represents the WSDL anonymous QName for a specific WS-Addressing Version.
-
isReferenceParameterTag
public final 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 String UNSET_OUTPUT_ACTION
- See Also:
- Constant Field Values
-
UNSET_INPUT_ACTION
public static final String UNSET_INPUT_ACTION
- See Also:
- Constant Field Values
-
fault_duplicateAddressInEpr
public static final 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(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
fromNsUri
public static AddressingVersion fromNsUri(String nsUri)
ReturnsAddressingVersion
whosensUri
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 theAddressingVersion
from aWSBinding
- Parameters:
binding
- WSDL binding- Returns:
- addresing version enabled, or null if none is enabled.
-
fromPort
public static AddressingVersion fromPort(WSDLPort port)
Gets theAddressingVersion
from aWSDLPort
- Parameters:
port
- WSDL port- Returns:
- addresing version
-
getNsUri
public String getNsUri()
Deprecated.UsensUri
.ReturnsnsUri
associated with thisAddressingVersion
- Returns:
- namespace URI
-
isReferenceParameter
public abstract boolean isReferenceParameter(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 bybinding
WSBinding
and for theWSDLPort
port.- Returns:
- WS-A version specific helper
-
getNoneUri
public final String getNoneUri()
Deprecated.UsenoneUri
.Gets the none URI value associated with this WS-Addressing version.- Returns:
- none URI value
-
getAnonymousUri
public final String getAnonymousUri()
Deprecated.UseanonymousUri
Gets the anonymous URI value associated with this WS-Addressing version.
-
getDefaultFaultAction
public String getDefaultFaultAction()
Gets the default fault Action value associated with this WS-Addressing version.- Returns:
- default fault Action value
-
getMapRequiredText
public abstract 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 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 String getPrefix()
-
getWsdlPrefix
public abstract String getWsdlPrefix()
-
getFeatureClass
public abstract 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(String nsUri, boolean enabled, boolean required)
Gets theWebServiceFeature
corresponding to the namespace URI of WS-Addressing policy assertion in the WSDL.enabled
andrequired
are used to initialize the value of the feature.- Parameters:
nsUri
- namespace URI of the WS-Addressing policy assertion in the WSDLenabled
- true if feature is to be enabled, false otherwiserequired
- 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(Class<? extends javax.xml.ws.EndpointReference> eprClass)
Gets the correspondingAddressingVersion
instance from the EPR class.
-
isRequired
public static boolean isRequired(javax.xml.ws.WebServiceFeature wsf)
Returns true if the WebServiceFeature is either aAddressingFeature
orMemberSubmissionAddressingFeature
and is required.- Parameters:
wsf
- The WebServiceFeature encaps- Returns:
- true if
wsf
requires WS-Addressing - Throws:
javax.xml.ws.WebServiceException
- ifwsf
does not contain eitherAddressingFeature
orMemberSubmissionAddressingFeature
-
isRequired
public static boolean isRequired(WSBinding binding)
Returns true ifbinding
contains either aAddressingFeature
orMemberSubmissionAddressingFeature
and is required.- Parameters:
binding
- The binding- Returns:
- true if
binding
requires WS-Addressing
-
isEnabled
public static boolean isEnabled(WSBinding binding)
Returns true ifbinding
contains either aAddressingFeature
orMemberSubmissionAddressingFeature
and is enabled.- Parameters:
binding
- The binding- Returns:
- true if WS-Addressing is enabled for
binding
.
-
-