javax.xml.ws.Binding Maven / Gradle / Ivy
/*
* 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;
/** The {@code Binding} interface is the base interface
* for JAX-WS protocol bindings.
*
* @since 1.6, JAX-WS 2.0
**/
public interface Binding {
/**
* Gets a copy of the handler chain for a protocol binding instance.
* If the returned chain is modified a call to {@code setHandlerChain}
* is required to configure the binding instance with the new chain.
*
* @return {@code java.util.List} Handler chain
*/
public java.util.List getHandlerChain();
/**
* Sets the handler chain for the protocol binding instance.
*
* @param chain A List of handler configuration entries
* @throws WebServiceException On an error in the configuration of
* the handler chain
* @throws java.lang.UnsupportedOperationException If this
* operation is not supported. This may be done to
* avoid any overriding of a pre-configured handler
* chain.
*/
public void setHandlerChain(java.util.List chain);
/**
* Get the URI for this binding instance.
*
* @return String The binding identifier for the port.
* Never returns {@code null}
*
* @since 1.6, JAX-WS 2.1
*/
String getBindingID();
}