< prev index next >

src/java.xml.ws/share/classes/com/sun/xml/internal/ws/api/BindingID.java

Print this page




 147     /**
 148      * Gets the binding ID, which uniquely identifies the binding.
 149      *
 150      * <p>
 151      * The relevant specs define the binding IDs and what they mean.
 152      * The ID is used in many places to identify the kind of binding
 153      * (such as SOAP1.1, SOAP1.2, REST, ...)
 154      *
 155      * @return
 156      *      Always non-null same value.
 157      */
 158     @Override
 159     public abstract String toString();
 160 
 161     /**
 162      * Returna a new {@link WebServiceFeatureList} instance
 163      * that represents the features that are built into this binding ID.
 164      *
 165      * <p>
 166      * For example, {@link BindingID} for
 167      * <tt>"{@value SOAPBinding#SOAP11HTTP_MTOM_BINDING}"</tt>
 168      * would always return a list that has {@link MTOMFeature} enabled.
 169      */
 170     public WebServiceFeatureList createBuiltinFeatureList() {
 171         return new WebServiceFeatureList();
 172     }
 173 
 174     /**
 175      * Returns true if this binding can generate WSDL.
 176      *
 177      * <p>
 178      * For e.g.: SOAP 1.1 and "XSOAP 1.2" is supposed to return true
 179      * from this method. For SOAP1.2, there is no standard WSDL, so the
 180      * runtime is not generating one and it expects the WSDL is packaged.
 181      *
 182      */
 183     public boolean canGenerateWSDL() {
 184         return false;
 185     }
 186 
 187     /**
 188      * Returns a parameter of this binding ID.
 189      *
 190      * <p>
 191      * Some binding ID, such as those for SOAP/HTTP, uses the URL
 192      * query syntax (like <tt>?mtom=true</tt>) to control
 193      * the optional part of the binding. This method obtains
 194      * the value for such optional parts.
 195      *
 196      * <p>
 197      * For implementors of the derived classes, if your binding ID
 198      * does not define such optional parts (such as the XML/HTTP binding ID),
 199      * then you should simply return the specified default value
 200      * (which is what this implementation does.)
 201      *
 202      * @param parameterName
 203      *      The parameter name, such as "mtom" in the above example.
 204      * @param defaultValue
 205      *      If this binding ID doesn't have the specified parameter explicitly,
 206      *      this value will be returned.
 207      *
 208      * @return
 209      *      the value of the parameter, if it's present (such as "true"
 210      *      in the above example.) If not present, this method returns
 211      *      the {@code defaultValue}.
 212      */




 147     /**
 148      * Gets the binding ID, which uniquely identifies the binding.
 149      *
 150      * <p>
 151      * The relevant specs define the binding IDs and what they mean.
 152      * The ID is used in many places to identify the kind of binding
 153      * (such as SOAP1.1, SOAP1.2, REST, ...)
 154      *
 155      * @return
 156      *      Always non-null same value.
 157      */
 158     @Override
 159     public abstract String toString();
 160 
 161     /**
 162      * Returna a new {@link WebServiceFeatureList} instance
 163      * that represents the features that are built into this binding ID.
 164      *
 165      * <p>
 166      * For example, {@link BindingID} for
 167      * {@code "{@value SOAPBinding#SOAP11HTTP_MTOM_BINDING}"}
 168      * would always return a list that has {@link MTOMFeature} enabled.
 169      */
 170     public WebServiceFeatureList createBuiltinFeatureList() {
 171         return new WebServiceFeatureList();
 172     }
 173 
 174     /**
 175      * Returns true if this binding can generate WSDL.
 176      *
 177      * <p>
 178      * For e.g.: SOAP 1.1 and "XSOAP 1.2" is supposed to return true
 179      * from this method. For SOAP1.2, there is no standard WSDL, so the
 180      * runtime is not generating one and it expects the WSDL is packaged.
 181      *
 182      */
 183     public boolean canGenerateWSDL() {
 184         return false;
 185     }
 186 
 187     /**
 188      * Returns a parameter of this binding ID.
 189      *
 190      * <p>
 191      * Some binding ID, such as those for SOAP/HTTP, uses the URL
 192      * query syntax (like {@code ?mtom=true}) to control
 193      * the optional part of the binding. This method obtains
 194      * the value for such optional parts.
 195      *
 196      * <p>
 197      * For implementors of the derived classes, if your binding ID
 198      * does not define such optional parts (such as the XML/HTTP binding ID),
 199      * then you should simply return the specified default value
 200      * (which is what this implementation does.)
 201      *
 202      * @param parameterName
 203      *      The parameter name, such as "mtom" in the above example.
 204      * @param defaultValue
 205      *      If this binding ID doesn't have the specified parameter explicitly,
 206      *      this value will be returned.
 207      *
 208      * @return
 209      *      the value of the parameter, if it's present (such as "true"
 210      *      in the above example.) If not present, this method returns
 211      *      the {@code defaultValue}.
 212      */


< prev index next >