001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.ws.api.client;
038:
039: import com.sun.xml.ws.api.FeatureConstructor;
040:
041: import javax.xml.ws.WebServiceFeature;
042:
043: /**
044: * Client side feature to enable or disable the selection of the optimal
045: * encoding by the client when sending outbound messages.
046: * <p>
047: * The following describes the affects of this feature with respect
048: * to being enabled or disabled:
049: * <ul>
050: * <li> ENABLED: In this Mode, the most optimal encoding will be selected
051: * depending on the configuration and capabilities of the client
052: * the capabilities of the Web service.
053: * <li> DISABLED: In this Mode, the default encoding will be selected.
054: * </ul>
055: * <p>
056: * If this feature is not present on a Web service then the default behaviour
057: * is equivalent to this feature being present and disabled.
058: * <p>
059: * If this feature is enabled by the client and the Service supports the
060: * Fast Infoset encoding, as specified by the {@link FastInfosetFeature},
061: * and Fast Infoset is determined to be the most optimal encoding, then the
062: * Fast Infoset encoding will be automatically selected by the client.
063: * <p>
064: * TODO: Still not sure if a feature is a server side only thing or can
065: * also be a client side thing. If the former then this class should be
066: * removed.
067: * @author Paul.Sandoz@Sun.Com
068: */
069: public class SelectOptimalEncodingFeature extends WebServiceFeature {
070: /**
071: * Constant value identifying the {@link SelectOptimalEncodingFeature}
072: */
073: public static final String ID = "http://java.sun.com/xml/ns/jaxws/client/selectOptimalEncoding";
074:
075: /**
076: * Create a {@link SelectOptimalEncodingFeature}.
077: * The instance created will be enabled.
078: */
079: public SelectOptimalEncodingFeature() {
080: this .enabled = true;
081: }
082:
083: /**
084: * Create a {@link SelectOptimalEncodingFeature}
085: *
086: * @param enabled specifies whether this feature should
087: * be enabled or not.
088: */
089: @FeatureConstructor({"enabled"})
090: public SelectOptimalEncodingFeature(boolean enabled) {
091: this .enabled = enabled;
092: }
093:
094: /**
095: * {@inheritDoc}
096: */
097: public String getID() {
098: return ID;
099: }
100: }
|