Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/ws/soap/MTOMFeature.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/javax/xml/ws/soap/MTOMFeature.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 368
- 0989ad8c0860
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package javax.xml.ws.soap; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import javax.xml.ws.WebServiceFeature; |
| aoqi@0 | 29 | import javax.xml.ws.WebServiceException; |
| aoqi@0 | 30 | import javax.xml.ws.Endpoint; |
| aoqi@0 | 31 | import javax.xml.ws.Service; |
| aoqi@0 | 32 | |
| aoqi@0 | 33 | /** |
| aoqi@0 | 34 | * This feature represents the use of MTOM with a |
| aoqi@0 | 35 | * web service. |
| aoqi@0 | 36 | * |
| aoqi@0 | 37 | * This feature can be used during the creation of SEI proxy, and |
| aoqi@0 | 38 | * {@link javax.xml.ws.Dispatch} instances on the client side and {@link Endpoint} |
| aoqi@0 | 39 | * instances on the server side. This feature cannot be used for {@link Service} |
| aoqi@0 | 40 | * instance creation on the client side. |
| aoqi@0 | 41 | * |
| aoqi@0 | 42 | * <p> |
| aoqi@0 | 43 | * The following describes the affects of this feature with respect |
| aoqi@0 | 44 | * to being enabled or disabled: |
| aoqi@0 | 45 | * <ul> |
| aoqi@0 | 46 | * <li> ENABLED: In this Mode, MTOM will be enabled. A receiver MUST accept |
| aoqi@0 | 47 | * both a non-optimized and an optimized message, and a sender MAY send an |
| aoqi@0 | 48 | * optimized message, or a non-optimized message. The heuristics used by a |
| aoqi@0 | 49 | * sender to determine whether to use optimization or not are |
| aoqi@0 | 50 | * implementation-specific. |
| aoqi@0 | 51 | * <li> DISABLED: In this Mode, MTOM will be disabled |
| aoqi@0 | 52 | * </ul> |
| aoqi@0 | 53 | * <p> |
| aoqi@0 | 54 | * The {@link #threshold} property can be used to set the threshold |
| aoqi@0 | 55 | * value used to determine when binary data should be XOP encoded. |
| aoqi@0 | 56 | * |
| aoqi@0 | 57 | * @since JAX-WS 2.1 |
| aoqi@0 | 58 | */ |
| aoqi@0 | 59 | public final class MTOMFeature extends WebServiceFeature { |
| aoqi@0 | 60 | /** |
| aoqi@0 | 61 | * Constant value identifying the MTOMFeature |
| aoqi@0 | 62 | */ |
| aoqi@0 | 63 | public static final String ID = "http://www.w3.org/2004/08/soap/features/http-optimization"; |
| aoqi@0 | 64 | |
| aoqi@0 | 65 | |
| aoqi@0 | 66 | /** |
| aoqi@0 | 67 | * Property for MTOM threshold value. This property serves as a hint when |
| aoqi@0 | 68 | * MTOM is enabled, binary data above this size in bytes SHOULD be sent |
| aoqi@0 | 69 | * as attachment. |
| aoqi@0 | 70 | * The value of this property MUST always be >= 0. Default value is 0. |
| aoqi@0 | 71 | */ |
| aoqi@0 | 72 | // should be changed to private final, keeping original modifier to keep backwards compatibility |
| aoqi@0 | 73 | protected int threshold; |
| aoqi@0 | 74 | |
| aoqi@0 | 75 | |
| aoqi@0 | 76 | /** |
| aoqi@0 | 77 | * Create an <code>MTOMFeature</code>. |
| aoqi@0 | 78 | * The instance created will be enabled. |
| aoqi@0 | 79 | */ |
| aoqi@0 | 80 | public MTOMFeature() { |
| aoqi@0 | 81 | this.enabled = true; |
| aoqi@0 | 82 | this.threshold = 0; |
| aoqi@0 | 83 | } |
| aoqi@0 | 84 | |
| aoqi@0 | 85 | /** |
| aoqi@0 | 86 | * Creates an <code>MTOMFeature</code>. |
| aoqi@0 | 87 | * |
| aoqi@0 | 88 | * @param enabled specifies if this feature should be enabled or not |
| aoqi@0 | 89 | */ |
| aoqi@0 | 90 | public MTOMFeature(boolean enabled) { |
| aoqi@0 | 91 | this.enabled = enabled; |
| aoqi@0 | 92 | this.threshold = 0; |
| aoqi@0 | 93 | } |
| aoqi@0 | 94 | |
| aoqi@0 | 95 | |
| aoqi@0 | 96 | /** |
| aoqi@0 | 97 | * Creates an <code>MTOMFeature</code>. |
| aoqi@0 | 98 | * The instance created will be enabled. |
| aoqi@0 | 99 | * |
| aoqi@0 | 100 | * @param threshold the size in bytes that binary data SHOULD be before |
| aoqi@0 | 101 | * being sent as an attachment. |
| aoqi@0 | 102 | * |
| aoqi@0 | 103 | * @throws WebServiceException if threshold is < 0 |
| aoqi@0 | 104 | */ |
| aoqi@0 | 105 | public MTOMFeature(int threshold) { |
| aoqi@0 | 106 | if (threshold < 0) |
| aoqi@0 | 107 | throw new WebServiceException("MTOMFeature.threshold must be >= 0, actual value: "+threshold); |
| aoqi@0 | 108 | this.enabled = true; |
| aoqi@0 | 109 | this.threshold = threshold; |
| aoqi@0 | 110 | } |
| aoqi@0 | 111 | |
| aoqi@0 | 112 | /** |
| aoqi@0 | 113 | * Creates an <code>MTOMFeature</code>. |
| aoqi@0 | 114 | * |
| aoqi@0 | 115 | * @param enabled specifies if this feature should be enabled or not |
| aoqi@0 | 116 | * @param threshold the size in bytes that binary data SHOULD be before |
| aoqi@0 | 117 | * being sent as an attachment. |
| aoqi@0 | 118 | * |
| aoqi@0 | 119 | * @throws WebServiceException if threshold is < 0 |
| aoqi@0 | 120 | */ |
| aoqi@0 | 121 | public MTOMFeature(boolean enabled, int threshold) { |
| aoqi@0 | 122 | if (threshold < 0) |
| aoqi@0 | 123 | throw new WebServiceException("MTOMFeature.threshold must be >= 0, actual value: "+threshold); |
| aoqi@0 | 124 | this.enabled = enabled; |
| aoqi@0 | 125 | this.threshold = threshold; |
| aoqi@0 | 126 | } |
| aoqi@0 | 127 | |
| aoqi@0 | 128 | /** |
| aoqi@0 | 129 | * {@inheritDoc} |
| aoqi@0 | 130 | */ |
| aoqi@0 | 131 | public String getID() { |
| aoqi@0 | 132 | return ID; |
| aoqi@0 | 133 | } |
| aoqi@0 | 134 | |
| aoqi@0 | 135 | /** |
| aoqi@0 | 136 | * Gets the threshold value used to determine when binary data |
| aoqi@0 | 137 | * should be sent as an attachment. |
| aoqi@0 | 138 | * |
| aoqi@0 | 139 | * @return the current threshold size in bytes |
| aoqi@0 | 140 | */ |
| aoqi@0 | 141 | public int getThreshold() { |
| aoqi@0 | 142 | return threshold; |
| aoqi@0 | 143 | } |
| aoqi@0 | 144 | } |
