javax.xml.ws.soap.SOAPBinding 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.soap;
import java.util.Set;
import javax.xml.ws.Binding;
import javax.xml.soap.SOAPFactory;
import javax.xml.soap.MessageFactory;
/** The {@code SOAPBinding} interface is an abstraction for
* the SOAP binding.
*
* @since 1.6, JAX-WS 2.0
**/
public interface SOAPBinding extends Binding {
/**
* A constant representing the identity of the SOAP 1.1 over HTTP binding.
*/
public static final String SOAP11HTTP_BINDING = "http://schemas.xmlsoap.org/wsdl/soap/http";
/**
* A constant representing the identity of the SOAP 1.2 over HTTP binding.
*/
public static final String SOAP12HTTP_BINDING = "http://www.w3.org/2003/05/soap/bindings/HTTP/";
/**
* A constant representing the identity of the SOAP 1.1 over HTTP binding
* with MTOM enabled by default.
*/
public static final String SOAP11HTTP_MTOM_BINDING = "http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true";
/**
* A constant representing the identity of the SOAP 1.2 over HTTP binding
* with MTOM enabled by default.
*/
public static final String SOAP12HTTP_MTOM_BINDING = "http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true";
/** Gets the roles played by the SOAP binding instance.
*
* @return {@code Set} The set of roles played by the binding instance.
**/
public Set getRoles();
/** Sets the roles played by the SOAP binding instance.
*
* @param roles The set of roles played by the binding instance.
* @throws javax.xml.ws.WebServiceException On an error in the configuration of
* the list of roles.
**/
public void setRoles(Set roles);
/**
* Returns {@code true} if the use of MTOM is enabled.
*
* @return {@code true} if and only if the use of MTOM is enabled.
**/
public boolean isMTOMEnabled();
/**
* Enables or disables use of MTOM.
*
* @param flag A {@code boolean} specifying whether the use of MTOM should
* be enabled or disabled.
* @throws javax.xml.ws.WebServiceException If the specified setting is not supported
* by this binding instance.
*
**/
public void setMTOMEnabled(boolean flag);
/**
* Gets the SAAJ {@code SOAPFactory} instance used by this SOAP binding.
*
* @return SOAPFactory instance used by this SOAP binding.
**/
public SOAPFactory getSOAPFactory();
/**
* Gets the SAAJ {@code MessageFactory} instance used by this SOAP binding.
*
* @return MessageFactory instance used by this SOAP binding.
**/
public MessageFactory getMessageFactory();
}