Module jakarta.xml.ws
Package jakarta.xml.ws.soap

Annotation Type MTOM

  • @Target({TYPE,METHOD,FIELD})
@Retention(RUNTIME)
@Documented
@WebServiceFeatureAnnotation(id="http://www.w3.org/2004/08/soap/features/http-optimization",
                             bean=MTOMFeature.class)
public @interface MTOM
    This feature represents the use of MTOM with a web service.

    This annotation MUST only be used in conjunction the jakarta.jws.WebService, WebServiceProvider, WebServiceRef annotations. When used with the jakarta.jws.WebService annotation this annotation MUST only be used on the service endpoint implementation class. When used with a WebServiceRef annotation, this annotation MUST only be used when a proxy instance is created. The injected SEI proxy, and endpoint MUST honor the values of the MTOM annotation.

    This annotation's behaviour is defined by the corresponding feature MTOMFeature.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean enabled
      Specifies if this feature is enabled or disabled.
      int threshold
      Property for MTOM threshold value.

    • Element Detail

      • enabled

        boolean enabled
        Specifies if this feature is enabled or disabled.
        Returns:
        true if MTOM is supported, false otherwise
        Default:
        true

      • threshold

        int threshold
        Property for MTOM threshold value. When MTOM is enabled, binary data above this size in bytes will be XOP encoded or sent as attachment. The value of this property MUST always be >= 0. Default value is 0.
        Returns:
        MTOM threshold in bytes
        Default:
        0