src/share/jaxws_classes/com/sun/xml/internal/ws/api/client/SelectOptimalEncodingFeature.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) 1997, 2012, 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 com.sun.xml.internal.ws.api.client;
aoqi@0 27
aoqi@0 28 import com.sun.xml.internal.ws.api.FeatureConstructor;
aoqi@0 29
aoqi@0 30 import javax.xml.ws.WebServiceFeature;
aoqi@0 31
aoqi@0 32 import com.sun.org.glassfish.gmbal.ManagedAttribute;
aoqi@0 33 import com.sun.org.glassfish.gmbal.ManagedData;
aoqi@0 34
aoqi@0 35 /**
aoqi@0 36 * Client side feature to enable or disable the selection of the optimal
aoqi@0 37 * encoding by the client when sending outbound messages.
aoqi@0 38 * <p>
aoqi@0 39 * The following describes the affects of this feature with respect
aoqi@0 40 * to being enabled or disabled:
aoqi@0 41 * <ul>
aoqi@0 42 * <li> ENABLED: In this Mode, the most optimal encoding will be selected
aoqi@0 43 * depending on the configuration and capabilities of the client
aoqi@0 44 * the capabilities of the Web service.
aoqi@0 45 * <li> DISABLED: In this Mode, the default encoding will be selected.
aoqi@0 46 * </ul>
aoqi@0 47 * <p>
aoqi@0 48 * If this feature is not present on a Web service then the default behaviour
aoqi@0 49 * is equivalent to this feature being present and disabled.
aoqi@0 50 * <p>
aoqi@0 51 * If this feature is enabled by the client and the Service supports the
aoqi@0 52 * Fast Infoset encoding, as specified by the {@link com.sun.xml.internal.ws.api.fastinfoset.FastInfosetFeature},
aoqi@0 53 * and Fast Infoset is determined to be the most optimal encoding, then the
aoqi@0 54 * Fast Infoset encoding will be automatically selected by the client.
aoqi@0 55 * <p>
aoqi@0 56 * TODO: Still not sure if a feature is a server side only thing or can
aoqi@0 57 * also be a client side thing. If the former then this class should be
aoqi@0 58 * removed.
aoqi@0 59 * @author Paul.Sandoz@Sun.Com
aoqi@0 60 */
aoqi@0 61 @ManagedData
aoqi@0 62 public class SelectOptimalEncodingFeature extends WebServiceFeature {
aoqi@0 63 /**
aoqi@0 64 * Constant value identifying the {@link SelectOptimalEncodingFeature}
aoqi@0 65 */
aoqi@0 66 public static final String ID = "http://java.sun.com/xml/ns/jaxws/client/selectOptimalEncoding";
aoqi@0 67
aoqi@0 68 /**
aoqi@0 69 * Create a {@link SelectOptimalEncodingFeature}.
aoqi@0 70 * The instance created will be enabled.
aoqi@0 71 */
aoqi@0 72 public SelectOptimalEncodingFeature() {
aoqi@0 73 this.enabled = true;
aoqi@0 74 }
aoqi@0 75
aoqi@0 76 /**
aoqi@0 77 * Create a {@link SelectOptimalEncodingFeature}
aoqi@0 78 *
aoqi@0 79 * @param enabled specifies whether this feature should
aoqi@0 80 * be enabled or not.
aoqi@0 81 */
aoqi@0 82 @FeatureConstructor({"enabled"})
aoqi@0 83 public SelectOptimalEncodingFeature(boolean enabled) {
aoqi@0 84 this.enabled = enabled;
aoqi@0 85 }
aoqi@0 86
aoqi@0 87 /**
aoqi@0 88 * {@inheritDoc}
aoqi@0 89 */
aoqi@0 90 @ManagedAttribute
aoqi@0 91 public String getID() {
aoqi@0 92 return ID;
aoqi@0 93 }
aoqi@0 94 }

mercurial