ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.api.client;
ohair@286: 
ohair@286: import com.sun.xml.internal.ws.api.FeatureConstructor;
ohair@286: 
ohair@286: import javax.xml.ws.WebServiceFeature;
ohair@286: 
ohair@286: import com.sun.org.glassfish.gmbal.ManagedAttribute;
ohair@286: import com.sun.org.glassfish.gmbal.ManagedData;
ohair@286: 
ohair@286: /**
ohair@286:  * Client side feature to enable or disable the selection of the optimal
ohair@286:  * encoding by the client when sending outbound messages.
ohair@286:  * <p>
ohair@286:  * The following describes the affects of this feature with respect
ohair@286:  * to being enabled or disabled:
ohair@286:  * <ul>
ohair@286:  *  <li> ENABLED: In this Mode, the most optimal encoding will be selected
ohair@286:  *       depending on the configuration and capabilities of the client
ohair@286:  *       the capabilities of the Web service.
ohair@286:  *  <li> DISABLED: In this Mode, the default encoding will be selected.
ohair@286:  * </ul>
ohair@286:  * <p>
ohair@286:  * If this feature is not present on a Web service then the default behaviour
ohair@286:  * is equivalent to this feature being present and disabled.
ohair@286:  * <p>
ohair@286:  * If this feature is enabled by the client and the Service supports the
alanb@368:  * Fast Infoset encoding, as specified by the {@link com.sun.xml.internal.ws.api.fastinfoset.FastInfosetFeature},
ohair@286:  * and Fast Infoset is determined to be the most optimal encoding, then the
ohair@286:  * Fast Infoset encoding will be automatically selected by the client.
ohair@286:  * <p>
ohair@286:  * TODO: Still not sure if a feature is a server side only thing or can
ohair@286:  * also be a client side thing. If the former then this class should be
ohair@286:  * removed.
ohair@286:  * @author Paul.Sandoz@Sun.Com
ohair@286:  */
ohair@286: @ManagedData
ohair@286: public class SelectOptimalEncodingFeature extends WebServiceFeature {
ohair@286:     /**
ohair@286:      * Constant value identifying the {@link SelectOptimalEncodingFeature}
ohair@286:      */
ohair@286:     public static final String ID = "http://java.sun.com/xml/ns/jaxws/client/selectOptimalEncoding";
ohair@286: 
ohair@286:     /**
ohair@286:      * Create a {@link SelectOptimalEncodingFeature}.
ohair@286:      * The instance created will be enabled.
ohair@286:      */
ohair@286:     public SelectOptimalEncodingFeature() {
ohair@286:         this.enabled = true;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Create a {@link SelectOptimalEncodingFeature}
ohair@286:      *
ohair@286:      * @param enabled specifies whether this feature should
ohair@286:      *                be enabled or not.
ohair@286:      */
ohair@286:     @FeatureConstructor({"enabled"})
ohair@286:     public SelectOptimalEncodingFeature(boolean enabled) {
ohair@286:         this.enabled = enabled;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * {@inheritDoc}
ohair@286:      */
ohair@286:     @ManagedAttribute
ohair@286:     public String getID() {
ohair@286:         return ID;
ohair@286:     }
ohair@286: }