Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/TransportBackChannel.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/TransportBackChannel.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.xml.internal.ws.api.message.Packet; |
| aoqi@0 | 29 | import com.sun.xml.internal.ws.api.server.WSEndpoint.PipeHead; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | /** |
| aoqi@0 | 32 | * Represents a transport back-channel. |
| aoqi@0 | 33 | * |
| aoqi@0 | 34 | * <p> |
| aoqi@0 | 35 | * When the JAX-WS runtime finds out that the request |
| aoqi@0 | 36 | * {@link Packet} being processed is known not to produce |
| aoqi@0 | 37 | * a response, it invokes the {@link #close()} method |
| aoqi@0 | 38 | * to indicate that the transport does not need to keep |
| aoqi@0 | 39 | * the channel for the response message open. |
| aoqi@0 | 40 | * |
| aoqi@0 | 41 | * <p> |
| aoqi@0 | 42 | * This allows the transport to close down the communication |
| aoqi@0 | 43 | * channel sooner than wainting for |
| aoqi@0 | 44 | * {@link PipeHead#process} |
| aoqi@0 | 45 | * method to return, thereby improving the overall throughput |
| aoqi@0 | 46 | * of the system. |
| aoqi@0 | 47 | * |
| aoqi@0 | 48 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 49 | * @author Jitu |
| aoqi@0 | 50 | */ |
| aoqi@0 | 51 | public interface TransportBackChannel { |
| aoqi@0 | 52 | /** |
| aoqi@0 | 53 | * See the class javadoc for the discussion. |
| aoqi@0 | 54 | * |
| aoqi@0 | 55 | * <p> |
| aoqi@0 | 56 | * JAX-WS is not guaranteed to call this method for all |
| aoqi@0 | 57 | * operations that do not have a response. This is merely |
| aoqi@0 | 58 | * a hint. |
| aoqi@0 | 59 | * |
| aoqi@0 | 60 | * <p> |
| aoqi@0 | 61 | * When the implementation of this method fails to close |
| aoqi@0 | 62 | * the connection successfuly, it should record the error, |
| aoqi@0 | 63 | * and return normally. Do not throw any exception. |
| aoqi@0 | 64 | */ |
| aoqi@0 | 65 | void close(); |
| aoqi@0 | 66 | } |
