javax.xml.ws.soap

Class MTOMFeature

Contents

  • 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, and 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.

    Since:
    JAX-WS 2.1

    • Field Detail

      • 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(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.
        Throws:
        WebServiceException - if threshold is < 0

      • 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.
        Throws:
        WebServiceException - if threshold is < 0

    • Method Detail

      • getID

        public String getID()
        Get the unique identifier for this WebServiceFeature.
        Specified by:
        getID in class WebServiceFeature
        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

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/xml/ws/soap/mtomfeature.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut