This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.xml.ws.soap
class MTOMFeature

java.lang.Object extended by javax.xml.ws.WebServiceFeature extended by javax.xml.ws.soap.MTOMFeature

Most common way to construct:

MTOMFeature feature = new MTOMFeature();

Based on 10 examples


public final class MTOMFeature
extends WebServiceFeature

This feature represents the use of MTOM with a web service.

The following describes the affects of this feature with respect to being enabled or disabled:

The {@link #threshold} property can be used to set the threshold value used to determine when binary data should be XOP encoded.


Field Summary
static String ID
          Constant value identifying the MTOMFeature
protected int threshold
          Property for MTOM threshold value.
 
Fields inherited from class javax.xml.ws.WebServiceFeature
enabled
 
Constructor Summary

          Create an MTOMFeature.
MTOMFeature(boolean enabled)

          Creates an MTOMFeature.
MTOMFeature(boolean enabled, int threshold)

          Creates an MTOMFeature.
MTOMFeature(int threshold)

          Creates an MTOMFeature.
 
Method Summary
 String

          Get the unique identifier for this WebServiceFeature.
 int

          Gets the threshold value used to determine when binary data should be sent as an attachment.
 
Methods inherited from class javax.xml.ws.WebServiceFeature
getID, isEnabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

public static final String ID
Constant value identifying the MTOMFeature

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 an MTOMFeature. The instance created will be enabled.


MTOMFeature

public MTOMFeature(boolean enabled)
Creates an MTOMFeature.

Parameters:
enabled - specifies if this feature should be enabled or not

MTOMFeature

public MTOMFeature(boolean enabled,
                   int threshold)
Creates an MTOMFeature.

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.

MTOMFeature

public MTOMFeature(int threshold)
Creates an MTOMFeature. The instance created will be enabled.

Parameters:
threshold - the size in bytes that binary data SHOULD be before being sent as an attachment.
Method Detail

getID

public String getID()
{@inheritDoc}

Overrides:
getID in class WebServiceFeature

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


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.