javax.xml.ws.soap
Class MTOMFeature
- java.lang.Object
-
- javax.xml.ws.WebServiceFeature
-
- javax.xml.ws.soap.MTOMFeature
-
public final class MTOMFeature extends WebServiceFeature
This feature represents the use of MTOM with a web service. This feature can be used during the creation of SEI proxy, andDispatchinstances on the client side andEndpointinstances on the server side. This feature cannot be used forServiceinstance creation on the client side.The following describes the affects of this feature with respect to being enabled or disabled:
- ENABLED: In this Mode, MTOM will be enabled. A receiver MUST accept both a non-optimized and an optimized message, and a sender MAY send an optimized message, or a non-optimized message. The heuristics used by a sender to determine whether to use optimization or not are implementation-specific.
- DISABLED: In this Mode, MTOM will be disabled
The
thresholdproperty can be used to set the threshold value used to determine when binary data should be XOP encoded.- Since:
- JAX-WS 2.1
-
-
Field Summary
Fields Modifier and Type Field and Description static StringIDConstant value identifying the MTOMFeatureprotected intthresholdProperty for MTOM threshold value.-
Fields inherited from class javax.xml.ws.WebServiceFeature
enabled
-
-
Constructor Summary
Constructors Constructor and Description MTOMFeature()Create anMTOMFeature.MTOMFeature(boolean enabled)Creates anMTOMFeature.MTOMFeature(boolean enabled, int threshold)Creates anMTOMFeature.MTOMFeature(int threshold)Creates anMTOMFeature.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description StringgetID()Get the unique identifier for this WebServiceFeature.intgetThreshold()Gets the threshold value used to determine when binary data should be sent as an attachment.-
Methods inherited from class javax.xml.ws.WebServiceFeature
isEnabled
-
-
-
-
Field Detail
ID
public static final String ID
Constant value identifying the MTOMFeature- See Also:
- Constant Field Values
threshold
protected int threshold
Property for MTOM threshold value. This property serves as a hint when MTOM is enabled, binary data above this size in bytes SHOULD be sent as attachment. The value of this property MUST always be >= 0. Default value is 0.
-
Constructor Detail
MTOMFeature
public MTOMFeature()
Create anMTOMFeature. The instance created will be enabled.
MTOMFeature
public MTOMFeature(boolean enabled)
Creates anMTOMFeature.- Parameters:
-
enabled- specifies if this feature should be enabled or not
MTOMFeature
public MTOMFeature(int threshold)
Creates anMTOMFeature. The instance created will be enabled.- Parameters:
-
threshold- the size in bytes that binary data SHOULD be before being sent as an attachment. - Throws:
-
WebServiceException- if threshold is < 0
MTOMFeature
public MTOMFeature(boolean enabled, int threshold)Creates anMTOMFeature.- Parameters:
-
enabled- specifies if this feature should be enabled or not -
threshold- the size in bytes that binary data SHOULD be before being sent as an attachment. - Throws:
-
WebServiceException- if threshold is < 0
-
Method Detail
getID
public String getID()
Get the unique identifier for this WebServiceFeature.- Specified by:
-
getIDin classWebServiceFeature - Returns:
- the unique identifier for this feature.
getThreshold
public int getThreshold()
Gets the threshold value used to determine when binary data should be sent as an attachment.- Returns:
- the current threshold size in bytes
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
