01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.api.server;
38:
39: import com.sun.xml.ws.api.message.Packet;
40: import com.sun.xml.ws.api.server.WSEndpoint.PipeHead;
41:
42: /**
43: * Represents a transport back-channel.
44: *
45: * <p>
46: * When the JAX-WS runtime finds out that the request
47: * {@link Packet} being processed is known not to produce
48: * a response, it invokes the {@link #close()} method
49: * to indicate that the transport does not need to keep
50: * the channel for the response message open.
51: *
52: * <p>
53: * This allows the transport to close down the communication
54: * channel sooner than wainting for
55: * {@link PipeHead#process}
56: * method to return, thereby improving the overall throughput
57: * of the system.
58: *
59: * @author Kohsuke Kawaguchi
60: * @author Jitu
61: */
62: public interface TransportBackChannel {
63: /**
64: * See the class javadoc for the discussion.
65: *
66: * <p>
67: * JAX-WS is not guaranteed to call this method for all
68: * operations that do not have a response. This is merely
69: * a hint.
70: *
71: * <p>
72: * When the implementation of this method fails to close
73: * the connection successfuly, it should record the error,
74: * and return normally. Do not throw any exception.
75: */
76: void close();
77: }
|