jaxws/src/java.xml.ws/share/classes/com/sun/xml/internal/ws/api/pipe/Stubs.java
changeset 32795 5a5710ee05a0
parent 25871 b80b84e87032
equal deleted inserted replaced
32712:f61a63b7d1e5 32795:5a5710ee05a0
    73  * <h2>Common Parameters and Their Meanings</h2>
    73  * <h2>Common Parameters and Their Meanings</h2>
    74  *
    74  *
    75  * <h3>Pipe next</h3>
    75  * <h3>Pipe next</h3>
    76  * <p>
    76  * <p>
    77  * Stubs turn a method invocation into a {@link Pipe#process(com.sun.xml.internal.ws.api.message.Packet)} invocation,
    77  * Stubs turn a method invocation into a {@link Pipe#process(com.sun.xml.internal.ws.api.message.Packet)} invocation,
    78  * and this pipe passed in as the <tt>next</tt> parameter will receive a {@link Message}
    78  * and this pipe passed in as the {@code next} parameter will receive a {@link Message}
    79  * from newly created stub. All the methods taking Tube <<next>> parameter are deprecated. JAX-WS Runtime takes care of
    79  * from newly created stub. All the methods taking Tube <<next>> parameter are deprecated. JAX-WS Runtime takes care of
    80  * creating the tubeline when the <tt>next</tt> parameter is not passed. This gives flexibility for the JAX-WS Runtime
    80  * creating the tubeline when the {@code next} parameter is not passed. This gives flexibility for the JAX-WS Runtime
    81  * to pass extra information during the tube line creation via {@link ClientTubeAssemblerContext}.
    81  * to pass extra information during the tube line creation via {@link ClientTubeAssemblerContext}.
    82  *
    82  *
    83  * <h3>WSPortInfo portInfo</h3>
    83  * <h3>WSPortInfo portInfo</h3>
    84  * <p> Gives information about the port for which the "stub" being created. Such information includes Port QName,
    84  * <p> Gives information about the port for which the "stub" being created. Such information includes Port QName,
    85  * target endpoint address, and bindingId etc.
    85  * target endpoint address, and bindingId etc.
    86  *
    86  *
    87  * <h3>BindingImpl binding</h3>
    87  * <h3>BindingImpl binding</h3>
    88  * <p>
    88  * <p>
    89  * Stubs implement {@link BindingProvider}, and its {@link BindingProvider#getBinding()}
    89  * Stubs implement {@link BindingProvider}, and its {@link BindingProvider#getBinding()}
    90  * will return this <tt>binding</tt> object. Stubs often also use this information
    90  * will return this {@code binding} object. Stubs often also use this information
    91  * to decide which SOAP version a {@link Message} should be created in.
    91  * to decide which SOAP version a {@link Message} should be created in.
    92  *
    92  *
    93  * <h3>{@link WSService} service</h3>
    93  * <h3>{@link WSService} service</h3>
    94  * <p>
    94  * <p>
    95  * This object represents a {@link Service} that owns the newly created stub.
    95  * This object represents a {@link Service} that owns the newly created stub.
    96  * For example, asynchronous method invocation will use {@link Service#getExecutor()}.
    96  * For example, asynchronous method invocation will use {@link Service#getExecutor()}.
    97  *
    97  *
    98  * <h3>{@link WSEndpointReference} epr</h3>
    98  * <h3>{@link WSEndpointReference} epr</h3>
    99  * <p>
    99  * <p>
   100  * If you want the created {@link Dispatch} to talk to the given EPR, specify the parameter.
   100  * If you want the created {@link Dispatch} to talk to the given EPR, specify the parameter.
   101  * Otherwise leave it <tt>null</tt>. Note that the addressing needs to be enabled separately
   101  * Otherwise leave it {@code null}. Note that the addressing needs to be enabled separately
   102  * for this to take effect.
   102  * for this to take effect.
   103  *
   103  *
   104  * @author Kohsuke Kawaguchi
   104  * @author Kohsuke Kawaguchi
   105  * @author Kathy Walsh
   105  * @author Kathy Walsh
   106  */
   106  */