EE4J 10.0.0 · jakarta.xml.ws.soap.MTOMFeature

This feature represents the use of MTOM with a web service. This feature can be used during the creation of SEI proxy, and jakarta.xml.ws.Dispatch instances on the client side and Endpoint instances on the server side. This feature cannot be used for Service instance 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 threshold property can be used to set the threshold value used to determine when binary data should be XOP encoded.

Field Summary

Modifier and Type	Field and Description
public static final String	ID Constant value identifying the MTOMFeature
private int	threshold Property for MTOM threshold value.

Inherited from jakarta.xml.ws.WebServiceFeature:: enabled

Constructor Summary

Access	Constructor and Description
public	MTOMFeature() Create an `MTOMFeature`.
public	MTOMFeature(boolean specifies if this feature should be enabled or not enabled) Creates a `MTOMFeature`.
public	MTOMFeature(int the size in bytes that binary data SHOULD be before being sent as an attachment. threshold) Creates a `MTOMFeature`.
public	MTOMFeature(boolean specifies if this feature should be enabled or not enabled, int the size in bytes that binary data SHOULD be before being sent as an attachment. threshold) Creates a `MTOMFeature`.

Method Summary

Modifier and Type	Method and Description
public String	getID() Implements abstract jakarta.xml.ws.WebServiceFeature.getID. Get the unique identifier for this WebServiceFeature.
public int	Returns: the current threshold size in bytes getThreshold() Gets the threshold value used to determine when binary data should be sent as an attachment.

Inherited from jakarta.xml.ws.WebServiceFeature:: isEnabled

Field Detail

ID	back to summary
public static final String ID Constant value identifying the MTOMFeature

threshold	back to summary
private 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	back to summary
public MTOMFeature() Create an `MTOMFeature`. The instance created will be enabled.

MTOMFeature back to summary

MTOMFeature	back to summary
public MTOMFeature(boolean enabled) Creates a `MTOMFeature`. Parameters enabled:boolean specifies if this feature should be enabled or not

public MTOMFeature(boolean enabled)

Creates a MTOMFeature.

Parameters

enabled:boolean: specifies if this feature should be enabled or not

MTOMFeature back to summary

MTOMFeature	back to summary
public MTOMFeature(int threshold) Creates a `MTOMFeature`. The instance created will be enabled. Parameters threshold:int the size in bytes that binary data SHOULD be before being sent as an attachment. Exceptions WebServiceException: if threshold is < 0

public MTOMFeature(int threshold)

Creates a MTOMFeature. The instance created will be enabled.

Parameters

threshold:int: the size in bytes that binary data SHOULD be before being sent as an attachment.

Exceptions

WebServiceException:: if threshold is < 0

MTOMFeature back to summary

MTOMFeature	back to summary
public MTOMFeature(boolean enabled, int threshold) Creates a `MTOMFeature`. Parameters enabled:boolean specifies if this feature should be enabled or not threshold:int the size in bytes that binary data SHOULD be before being sent as an attachment. Exceptions WebServiceException: if threshold is < 0

public MTOMFeature(boolean enabled, int threshold)

Creates a MTOMFeature.

Parameters

enabled:boolean: specifies if this feature should be enabled or not
threshold:int: the size in bytes that binary data SHOULD be before being sent as an attachment.

Exceptions

WebServiceException:: if threshold is < 0

Method Detail

getID	back to summary
public String getID() Implements abstract jakarta.xml.ws.WebServiceFeature.getID. Doc from jakarta.xml.ws.WebServiceFeature.getID. Get the unique identifier for this WebServiceFeature. Returns:String the unique identifier for this feature. Annotations @Override

getID

back to summary

public String getID()

Implements abstract jakarta.xml.ws.WebServiceFeature.getID.

Doc from jakarta.xml.ws.WebServiceFeature.getID.

Get the unique identifier for this WebServiceFeature.

Returns:String

the unique identifier for this feature.

Annotations

@Override

getThreshold	back to summary
public int getThreshold() Gets the threshold value used to determine when binary data should be sent as an attachment. Returns:int the current threshold size in bytes

getThreshold

back to summary

public int getThreshold()

Gets the threshold value used to determine when binary data should be sent as an attachment.

Returns:int: the current threshold size in bytes

public final Class MTOMFeature

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail