src/share/jaxws_classes/javax/xml/ws/soap/MTOMFeature.java

Print this page
rev 507 : 8047724: @since tag cleanup in jaxws
Reviewed-by:


  37  * This feature can be used during the creation of SEI proxy, and
  38  * {@link javax.xml.ws.Dispatch} instances on the client side and {@link Endpoint}
  39  * instances on the server side. This feature cannot be used for {@link Service}
  40  * instance creation on the client side.
  41  *
  42  * <p>
  43  * The following describes the affects of this feature with respect
  44  * to being enabled or disabled:
  45  * <ul>
  46  *  <li> ENABLED: In this Mode, MTOM will be enabled. A receiver MUST accept
  47  * both a non-optimized and an optimized message, and a sender MAY send an
  48  * optimized message, or a non-optimized message. The heuristics used by a
  49  * sender to determine whether to use optimization or not are
  50  * implementation-specific.
  51  *  <li> DISABLED: In this Mode, MTOM will be disabled
  52  * </ul>
  53  * <p>
  54  * The {@link #threshold} property can be used to set the threshold
  55  * value used to determine when binary data should be XOP encoded.
  56  *
  57  * @since JAX-WS 2.1
  58  */
  59 public final class MTOMFeature extends WebServiceFeature {
  60     /**
  61      * Constant value identifying the MTOMFeature
  62      */
  63     public static final String ID = "http://www.w3.org/2004/08/soap/features/http-optimization";
  64 
  65 
  66     /**
  67      * Property for MTOM threshold value. This property serves as a hint when
  68      * MTOM is enabled, binary data above this size in bytes SHOULD be sent
  69      * as attachment.
  70      * The value of this property MUST always be >= 0. Default value is 0.
  71      */
  72     // should be changed to private final, keeping original modifier to keep backwards compatibility
  73     protected int threshold;
  74 
  75 
  76     /**
  77      * Create an <code>MTOMFeature</code>.




  37  * This feature can be used during the creation of SEI proxy, and
  38  * {@link javax.xml.ws.Dispatch} instances on the client side and {@link Endpoint}
  39  * instances on the server side. This feature cannot be used for {@link Service}
  40  * instance creation on the client side.
  41  *
  42  * <p>
  43  * The following describes the affects of this feature with respect
  44  * to being enabled or disabled:
  45  * <ul>
  46  *  <li> ENABLED: In this Mode, MTOM will be enabled. A receiver MUST accept
  47  * both a non-optimized and an optimized message, and a sender MAY send an
  48  * optimized message, or a non-optimized message. The heuristics used by a
  49  * sender to determine whether to use optimization or not are
  50  * implementation-specific.
  51  *  <li> DISABLED: In this Mode, MTOM will be disabled
  52  * </ul>
  53  * <p>
  54  * The {@link #threshold} property can be used to set the threshold
  55  * value used to determine when binary data should be XOP encoded.
  56  *
  57  * @since 1.6, JAX-WS 2.1
  58  */
  59 public final class MTOMFeature extends WebServiceFeature {
  60     /**
  61      * Constant value identifying the MTOMFeature
  62      */
  63     public static final String ID = "http://www.w3.org/2004/08/soap/features/http-optimization";
  64 
  65 
  66     /**
  67      * Property for MTOM threshold value. This property serves as a hint when
  68      * MTOM is enabled, binary data above this size in bytes SHOULD be sent
  69      * as attachment.
  70      * The value of this property MUST always be >= 0. Default value is 0.
  71      */
  72     // should be changed to private final, keeping original modifier to keep backwards compatibility
  73     protected int threshold;
  74 
  75 
  76     /**
  77      * Create an <code>MTOMFeature</code>.