• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/AsyncProvider.java@9c07ef4934dd (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/AsyncProvider.java

Thu, 31 Aug 2017 15:18:52 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:18:52 +0800

changeset 637

9c07ef4934dd

parent 368

0989ad8c0860

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.xml.internal.ws.api.server;
aoqi@0	27
aoqi@0	28	import com.sun.istack.internal.NotNull;
aoqi@0	29
aoqi@0	30	import javax.xml.ws.Provider;
aoqi@0	31	import javax.xml.ws.WebServiceContext;
aoqi@0	32	import java.util.concurrent.Executor;
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* Asynchronous version of {@link Provider}.
aoqi@0	36	*
aoqi@0	37	* <p>
aoqi@0	38	* Applications that use the JAX-WS RI can implement this interface instead of
aoqi@0	39	* {@link Provider} to implement asynchronous web services (AWS.) AWS enables
aoqi@0	40	* applications to perform operations with long latency without blocking a thread,
aoqi@0	41	* and thus particularly suitable for highly scalable service implementation,
aoqi@0	42	* at the expesnce of implementation complexity.
aoqi@0	43	*
aoqi@0	44	* <h2>Programming Model</h2>
aoqi@0	45	* <p>
aoqi@0	46	* Whenever a new reuqest arrives, the JAX-WS RI invokes the {@link #invoke} method
aoqi@0	47	* to notify the application. Normally, the application then schedules an execution
aoqi@0	48	* of this request, and exit from this method immediately (the point of AWS is not
aoqi@0	49	* to use this calling thread for request processing.)
aoqi@0	50	*
aoqi@0	51	* <p>
aoqi@0	52	* Unlike the synchronous version, which requires the response to be given as the return value,
aoqi@0	53	* with AWS the JAX-WS RI will keep the connection with client open, until the application
aoqi@0	54	* eventually notifies the JAX-WS RI via {@link AsyncProviderCallback}. When that
aoqi@0	55	* happens that causes the JAX-WS RI to send back a response to the client.
aoqi@0	56	*
aoqi@0	57	* <p>
aoqi@0	58	* The following code shows a very simple AWS example:
aoqi@0	59	*
aoqi@0	60	* <pre>
aoqi@0	61	* &#64;WebService
aoqi@0	62	* class MyAsyncEchoService implements AsyncProvider&lt;Source> {
aoqi@0	63	* private static final {@link Executor} exec = ...;
aoqi@0	64	*
aoqi@0	65	* public void invoke( final Source request, final AsyncProviderCallback&lt;Source> callback, final WebServiceContext context) {
aoqi@0	66	* exec.execute(new {@link Runnable}() {
aoqi@0	67	* public void run() {
aoqi@0	68	* Thread.sleep(1000); // kill time.
aoqi@0	69	* callback.send(request); // just echo back
aoqi@0	70	* }
aoqi@0	71	* });
aoqi@0	72	* }
aoqi@0	73	* }
aoqi@0	74	* </pre>
aoqi@0	75	*
aoqi@0	76	* <p>
aoqi@0	77	* Please also check the {@link Provider} and its programming model for general
aoqi@0	78	* provider programming model.
aoqi@0	79	*
aoqi@0	80	*
aoqi@0	81	* <h2>WebServiceContext</h2>
aoqi@0	82	* <p>
aoqi@0	83	* In synchronous web services, the injected {@link WebServiceContext} instance uses
aoqi@0	84	* the calling {@link Thread} to determine which request it should return information about.
aoqi@0	85	* This no longer works with AWS, as you may need to call {@link WebServiceContext}
aoqi@0	86	* much later, possibly from entirely different thread.
aoqi@0	87	*
aoqi@0	88	* <p>
aoqi@0	89	* For this reason, {@link AsyncProvider} passes in {@link WebServiceContext} as
aoqi@0	90	* a parameter. This object remains usable until you invoke {@link AsyncProviderCallback},
aoqi@0	91	* and it can be invoked from any thread, even concurrently. AWS must not use the injected
aoqi@0	92	* {@link WebServiceContext}, as its behavior is undefined.
aoqi@0	93	*
aoqi@0	94	* @see Provider
aoqi@0	95	* @author Jitendra Kotamraju
aoqi@0	96	* @author Kohsuke Kawaguchi
aoqi@0	97	* @since 2.1
aoqi@0	98	*/
aoqi@0	99	public interface AsyncProvider<T> {
aoqi@0	100	/**
aoqi@0	101	* Schedules an execution of a request.
aoqi@0	102	*
aoqi@0	103	* @param request
aoqi@0	104	* Represents the request message or payload.
aoqi@0	105	* @param callback
aoqi@0	106	* Application must notify this callback interface when the processing
aoqi@0	107	* of a request is complete.
aoqi@0	108	* @param context
aoqi@0	109	* The web service context instance that can be used to retrieve
aoqi@0	110	* context information about the given request.
aoqi@0	111	*/
aoqi@0	112	public void invoke(
aoqi@0	113	@NotNull T request,
aoqi@0	114	@NotNull AsyncProviderCallback<T> callback,
aoqi@0	115	@NotNull WebServiceContext context);
aoqi@0	116	}