001 /*
002 * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.xml.ws.soap;
027
028 import java.util.Set;
029 import javax.xml.ws.Binding;
030 import javax.xml.soap.SOAPFactory;
031 import javax.xml.soap.MessageFactory;
032
033 /** The <code>SOAPBinding</code> interface is an abstraction for
034 * the SOAP binding.
035 *
036 * @since JAX-WS 2.0
037 **/
038 public interface SOAPBinding extends Binding {
039
040 /**
041 * A constant representing the identity of the SOAP 1.1 over HTTP binding.
042 */
043 public static final String SOAP11HTTP_BINDING = "http://schemas.xmlsoap.org/wsdl/soap/http";
044
045 /**
046 * A constant representing the identity of the SOAP 1.2 over HTTP binding.
047 */
048 public static final String SOAP12HTTP_BINDING = "http://www.w3.org/2003/05/soap/bindings/HTTP/";
049
050 /**
051 * A constant representing the identity of the SOAP 1.1 over HTTP binding
052 * with MTOM enabled by default.
053 */
054 public static final String SOAP11HTTP_MTOM_BINDING = "http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true";
055
056 /**
057 * A constant representing the identity of the SOAP 1.2 over HTTP binding
058 * with MTOM enabled by default.
059 */
060 public static final String SOAP12HTTP_MTOM_BINDING = "http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true";
061
062 /** Gets the roles played by the SOAP binding instance.
063 *
064 * @return Set<String> The set of roles played by the binding instance.
065 **/
066 public Set<String> getRoles();
067
068 /** Sets the roles played by the SOAP binding instance.
069 *
070 * @param roles The set of roles played by the binding instance.
071 * @throws WebServiceException On an error in the configuration of
072 * the list of roles.
073 **/
074 public void setRoles(Set<String> roles);
075
076 /**
077 * Returns <code>true</code> if the use of MTOM is enabled.
078 *
079 * @return <code>true</code> if and only if the use of MTOM is enabled.
080 **/
081
082 public boolean isMTOMEnabled();
083
084 /**
085 * Enables or disables use of MTOM.
086 *
087 * @param flag A <code>boolean</code> specifying whether the use of MTOM should
088 * be enabled or disabled.
089 * @throws WebServiceException If the specified setting is not supported
090 * by this binding instance.
091 **/
092 public void setMTOMEnabled(boolean flag);
093
094 /**
095 * Gets the SAAJ <code>SOAPFactory</code> instance used by this SOAP binding.
096 *
097 * @return SOAPFactory instance used by this SOAP binding.
098 **/
099 public SOAPFactory getSOAPFactory();
100
101 /**
102 * Gets the SAAJ <code>MessageFactory</code> instance used by this SOAP binding.
103 *
104 * @return MessageFactory instance used by this SOAP binding.
105 **/
106 public MessageFactory getMessageFactory();
107 }
|