com.sun.xml.ws.api.client.SelectOptimalEncodingFeature Maven / Gradle / Ivy
Show all versions of webservices-osgi Show documentation
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.ws.api.client;
import com.sun.xml.ws.api.FeatureConstructor;
import jakarta.xml.ws.WebServiceFeature;
import org.glassfish.gmbal.ManagedAttribute;
import org.glassfish.gmbal.ManagedData;
/**
* Client side feature to enable or disable the selection of the optimal
* encoding by the client when sending outbound messages.
*
* The following describes the affects of this feature with respect
* to being enabled or disabled:
*
* - ENABLED: In this Mode, the most optimal encoding will be selected
* depending on the configuration and capabilities of the client
* the capabilities of the Web service.
*
- DISABLED: In this Mode, the default encoding will be selected.
*
*
* If this feature is not present on a Web service then the default behaviour
* is equivalent to this feature being present and disabled.
*
* If this feature is enabled by the client and the Service supports the
* Fast Infoset encoding, as specified by the {@link com.sun.xml.ws.api.fastinfoset.FastInfosetFeature},
* and Fast Infoset is determined to be the most optimal encoding, then the
* Fast Infoset encoding will be automatically selected by the client.
*
* TODO: Still not sure if a feature is a server side only thing or can
* also be a client side thing. If the former then this class should be
* removed.
* @author [email protected]
*/
@ManagedData
public class SelectOptimalEncodingFeature extends WebServiceFeature {
/**
* Constant value identifying the {@link SelectOptimalEncodingFeature}
*/
public static final String ID = "http://java.sun.com/xml/ns/jaxws/client/selectOptimalEncoding";
/**
* Create a {@link SelectOptimalEncodingFeature}.
* The instance created will be enabled.
*/
public SelectOptimalEncodingFeature() {
this.enabled = true;
}
/**
* Create a {@link SelectOptimalEncodingFeature}
*
* @param enabled specifies whether this feature should
* be enabled or not.
*/
@FeatureConstructor({"enabled"})
public SelectOptimalEncodingFeature(boolean enabled) {
this.enabled = enabled;
}
/**
* {@inheritDoc}
*/
@ManagedAttribute
public String getID() {
return ID;
}
}