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

src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/TransportBackChannel.java@0989ad8c0860 (annotated)

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

Tue, 09 Apr 2013 14:51:13 +0100

author

alanb

date

Tue, 09 Apr 2013 14:51:13 +0100

changeset 368

0989ad8c0860

parent 286

f50545b5e2f1

child 637

9c07ef4934dd

permissions

-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286	1	/*
alanb@368	2	* Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286	4	*
ohair@286	5	* This code is free software; you can redistribute it and/or modify it
ohair@286	6	* under the terms of the GNU General Public License version 2 only, as
ohair@286	7	* published by the Free Software Foundation. Oracle designates this
ohair@286	8	* particular file as subject to the "Classpath" exception as provided
ohair@286	9	* by Oracle in the LICENSE file that accompanied this code.
ohair@286	10	*
ohair@286	11	* This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286	14	* version 2 for more details (a copy is included in the LICENSE file that
ohair@286	15	* accompanied this code).
ohair@286	16	*
ohair@286	17	* You should have received a copy of the GNU General Public License version
ohair@286	18	* 2 along with this work; if not, write to the Free Software Foundation,
ohair@286	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286	20	*
ohair@286	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286	22	* or visit www.oracle.com if you need additional information or have any
ohair@286	23	* questions.
ohair@286	24	*/
ohair@286	25
ohair@286	26	package com.sun.xml.internal.ws.api.server;
ohair@286	27
ohair@286	28	import com.sun.xml.internal.ws.api.message.Packet;
ohair@286	29	import com.sun.xml.internal.ws.api.server.WSEndpoint.PipeHead;
ohair@286	30
ohair@286	31	/**
ohair@286	32	* Represents a transport back-channel.
ohair@286	33	*
ohair@286	34	* <p>
ohair@286	35	* When the JAX-WS runtime finds out that the request
ohair@286	36	* {@link Packet} being processed is known not to produce
ohair@286	37	* a response, it invokes the {@link #close()} method
ohair@286	38	* to indicate that the transport does not need to keep
ohair@286	39	* the channel for the response message open.
ohair@286	40	*
ohair@286	41	* <p>
ohair@286	42	* This allows the transport to close down the communication
ohair@286	43	* channel sooner than wainting for
ohair@286	44	* {@link PipeHead#process}
ohair@286	45	* method to return, thereby improving the overall throughput
ohair@286	46	* of the system.
ohair@286	47	*
ohair@286	48	* @author Kohsuke Kawaguchi
ohair@286	49	* @author Jitu
ohair@286	50	*/
ohair@286	51	public interface TransportBackChannel {
ohair@286	52	/**
ohair@286	53	* See the class javadoc for the discussion.
ohair@286	54	*
ohair@286	55	* <p>
ohair@286	56	* JAX-WS is not guaranteed to call this method for all
ohair@286	57	* operations that do not have a response. This is merely
ohair@286	58	* a hint.
ohair@286	59	*
ohair@286	60	* <p>
ohair@286	61	* When the implementation of this method fails to close
ohair@286	62	* the connection successfuly, it should record the error,
ohair@286	63	* and return normally. Do not throw any exception.
ohair@286	64	*/
ohair@286	65	void close();
ohair@286	66	}