1 /*
   2  * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.ws.soap;
  27 
  28 import java.lang.annotation.Documented;
  29 import java.lang.annotation.Target;
  30 import java.lang.annotation.ElementType;
  31 import java.lang.annotation.Retention;
  32 import java.lang.annotation.RetentionPolicy;
  33 
  34 import javax.xml.ws.spi.WebServiceFeatureAnnotation;
  35 import javax.xml.ws.WebServiceRef;
  36 import javax.xml.ws.WebServiceProvider;
  37 
  38 /**
  39  * This feature represents the use of MTOM with a
  40  * web service.
  41  * <p>
  42  * This annotation MUST only be used in conjunction the
  43  * {@code javax.jws.WebService}, {@link WebServiceProvider},
  44  * {@link WebServiceRef} annotations.
  45  * When used with the {@code javax.jws.WebService} annotation this
  46  * annotation MUST only be used on the service endpoint implementation
  47  * class.
  48  * When used with a {@code WebServiceRef} annotation, this annotation
  49  * MUST only be used when a proxy instance is created. The injected SEI
  50  * proxy, and endpoint MUST honor the values of the {@code MTOM}
  51  * annotation.
  52  * <p>
  53  *
  54  * This annotation's behaviour is defined by the corresponding feature
  55  * {@link MTOMFeature}.
  56  *
  57  * @since 1.6, JAX-WS 2.1
  58  */
  59 @Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
  60 @Retention(RetentionPolicy.RUNTIME)
  61 @Documented
  62 @WebServiceFeatureAnnotation(id=MTOMFeature.ID,bean=MTOMFeature.class)
  63 public @interface MTOM {
  64     /**
  65      * Specifies if this feature is enabled or disabled.


  66      */
  67     boolean enabled() default true;
  68 
  69     /**
  70      * Property for MTOM threshold value. When MTOM is enabled, binary data above this
  71      * size in bytes will be XOP encoded or sent as attachment. The value of this property
  72      * MUST always be {@literal >=} 0. Default value is 0.


  73      */
  74     int threshold() default 0;
  75 }
--- EOF ---