javax.xml.ws.RespectBindingFeature Maven / Gradle / Ivy
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.ws;
import javax.xml.ws.soap.AddressingFeature;
/**
* This feature clarifies the use of the {@code wsdl:binding}
* in a JAX-WS runtime.
*
* This feature can be used during the creation of SEI proxy, and
* {@link Dispatch} instances on the client side and {@link Endpoint}
* instances on the server side. This feature cannot be used for {@link Service}
* instance creation on the client side.
*
* This feature is only useful with web services that have an
* associated WSDL. Enabling this feature requires that a JAX-WS
* implementation inspect the {@code wsdl:binding} for an
* endpoint at runtime to make sure that all {@code wsdl:extensions}
* that have the {@code required} attribute set to {@code true}
* are understood and are being used.
*
* The following describes the affects of this feature with respect
* to be enabled or disabled:
*
* - ENABLED: In this Mode, a JAX-WS runtime MUST assure that all
* required {@code wsdl:binding} extensions(including policies) are
* either understood and used by the runtime, or explicitly disabled by the
* web service application. A web service can disable a particular
* extension if there is a corresponding {@link WebServiceFeature} or annotation.
* Similarly, a web service client can disable
* particular extension using the corresponding {@code WebServiceFeature} while
* creating a proxy or Dispatch instance.
* The runtime MUST also make sure that binding of
* SEI parameters/return values respect the {@code wsdl:binding}.
* With this feature enabled, if a required ({@code wsdl:required="true"})
* {@code wsdl:binding} extension is in the WSDL and it is not
* supported by a JAX-WS runtime and it has not
* been explicitly turned off by the web service developer, then
* that JAX-WS runtime MUST behave appropriately based on whether it is
* on the client or server:
*
* - Client: runtime MUST throw a
* {@link WebServiceException} no sooner than when one of the methods
* above is invoked but no later than the first invocation of an endpoint
* operation.
*
- Server: throw a {@link WebServiceException} and the endpoint MUST fail to deploy
*
*
* - DISABLED: In this Mode, an implementation may choose whether
* to inspect the {@code wsdl:binding} or not and to what degree
* the {@code wsdl:binding} will be inspected. For example,
* one implementation may choose to behave as if this feature is enabled,
* another implementation may only choose to verify the SEI's
* parameter/return type bindings.
*
*
* @see AddressingFeature
*
* @since 1.6, JAX-WS 2.1
*/
public final class RespectBindingFeature extends WebServiceFeature {
/**
*
* Constant value identifying the RespectBindingFeature
*/
public static final String ID = "javax.xml.ws.RespectBindingFeature";
/**
* Creates an {@code RespectBindingFeature}.
* The instance created will be enabled.
*/
public RespectBindingFeature() {
this.enabled = true;
}
/**
* Creates an RespectBindingFeature
*
* @param enabled specifies whether this feature should
* be enabled or not.
*/
public RespectBindingFeature(boolean enabled) {
this.enabled = enabled;
}
/**
* {@inheritDoc}
*/
public String getID() {
return ID;
}
}