jaxws/src/java.xml.ws/share/classes/javax/xml/ws/soap/SOAPBinding.java
changeset 30005 b2f720a258c4
parent 25871 b80b84e87032
child 31746 7573de6b8e46
equal deleted inserted replaced
29963:ac3f5a39d4ff 30005:b2f720a258c4
    29 import java.util.Set;
    29 import java.util.Set;
    30 import javax.xml.ws.Binding;
    30 import javax.xml.ws.Binding;
    31 import javax.xml.soap.SOAPFactory;
    31 import javax.xml.soap.SOAPFactory;
    32 import javax.xml.soap.MessageFactory;
    32 import javax.xml.soap.MessageFactory;
    33 
    33 
    34 /** The <code>SOAPBinding</code> interface is an abstraction for
    34 /** The {@code SOAPBinding} interface is an abstraction for
    35  *  the SOAP binding.
    35  *  the SOAP binding.
    36  *
    36  *
    37  *  @since 1.6, JAX-WS 2.0
    37  *  @since 1.6, JAX-WS 2.0
    38 **/
    38 **/
    39 public interface SOAPBinding extends Binding {
    39 public interface SOAPBinding extends Binding {
    61   public static final String SOAP12HTTP_MTOM_BINDING = "http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true";
    61   public static final String SOAP12HTTP_MTOM_BINDING = "http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true";
    62 
    62 
    63 
    63 
    64   /** Gets the roles played by the SOAP binding instance.
    64   /** Gets the roles played by the SOAP binding instance.
    65    *
    65    *
    66    *  @return Set&lt;String> The set of roles played by the binding instance.
    66    *  @return {@code Set<String>} The set of roles played by the binding instance.
    67   **/
    67   **/
    68   public Set<String> getRoles();
    68   public Set<String> getRoles();
    69 
    69 
    70   /** Sets the roles played by the SOAP binding instance.
    70   /** Sets the roles played by the SOAP binding instance.
    71    *
    71    *
    74    *                  the list of roles.
    74    *                  the list of roles.
    75   **/
    75   **/
    76   public void setRoles(Set<String> roles);
    76   public void setRoles(Set<String> roles);
    77 
    77 
    78   /**
    78   /**
    79    * Returns <code>true</code> if the use of MTOM is enabled.
    79    * Returns {@code true} if the use of MTOM is enabled.
    80    *
    80    *
    81    * @return <code>true</code> if and only if the use of MTOM is enabled.
    81    * @return {@code true} if and only if the use of MTOM is enabled.
    82   **/
    82   **/
    83 
    83 
    84   public boolean isMTOMEnabled();
    84   public boolean isMTOMEnabled();
    85 
    85 
    86   /**
    86   /**
    87    * Enables or disables use of MTOM.
    87    * Enables or disables use of MTOM.
    88    *
    88    *
    89    * @param flag   A <code>boolean</code> specifying whether the use of MTOM should
    89    * @param flag   A {@code boolean} specifying whether the use of MTOM should
    90    *               be enabled or disabled.
    90    *               be enabled or disabled.
    91    * @throws WebServiceException If the specified setting is not supported
    91    * @throws WebServiceException If the specified setting is not supported
    92    *                  by this binding instance.
    92    *                  by this binding instance.
    93    *
    93    *
    94    **/
    94    **/
    95   public void setMTOMEnabled(boolean flag);
    95   public void setMTOMEnabled(boolean flag);
    96 
    96 
    97   /**
    97   /**
    98    * Gets the SAAJ <code>SOAPFactory</code> instance used by this SOAP binding.
    98    * Gets the SAAJ {@code SOAPFactory} instance used by this SOAP binding.
    99    *
    99    *
   100    * @return SOAPFactory instance used by this SOAP binding.
   100    * @return SOAPFactory instance used by this SOAP binding.
   101   **/
   101   **/
   102   public SOAPFactory getSOAPFactory();
   102   public SOAPFactory getSOAPFactory();
   103 
   103 
   104   /**
   104   /**
   105    * Gets the SAAJ <code>MessageFactory</code> instance used by this SOAP binding.
   105    * Gets the SAAJ {@code MessageFactory} instance used by this SOAP binding.
   106    *
   106    *
   107    * @return MessageFactory instance used by this SOAP binding.
   107    * @return MessageFactory instance used by this SOAP binding.
   108   **/
   108   **/
   109   public MessageFactory getMessageFactory();
   109   public MessageFactory getMessageFactory();
   110 }
   110 }