src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/AbstractServerAsyncTransport.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
alanb@368 28 import com.oracle.webservices.internal.api.message.PropertySet;
ohair@286 29 import com.sun.istack.internal.NotNull;
ohair@286 30 import com.sun.istack.internal.Nullable;
ohair@286 31 import com.sun.xml.internal.ws.api.message.Message;
ohair@286 32 import com.sun.xml.internal.ws.api.message.Packet;
ohair@286 33 import com.sun.xml.internal.ws.api.pipe.Codec;
ohair@286 34 import com.sun.xml.internal.ws.util.Pool;
ohair@286 35
ohair@286 36 import java.io.IOException;
ohair@286 37
alanb@368 38
ohair@286 39 /**
ohair@286 40 * Partial server side async transport implementation. It manages pooling of
ohair@286 41 * {@link Codec} and other details.
ohair@286 42 *
ohair@286 43 * @author Jitendra Kotamraju
ohair@286 44 */
ohair@286 45 public abstract class AbstractServerAsyncTransport<T> {
ohair@286 46
ohair@286 47 private final WSEndpoint endpoint;
ohair@286 48 private final CodecPool codecPool;
ohair@286 49
ohair@286 50 /**
ohair@286 51 * {@link WSEndpoint#setExecutor} should be called before creating the
ohair@286 52 * transport
ohair@286 53 *
ohair@286 54 * @param endpoint webservices requests are directed towards this endpoint
ohair@286 55 */
ohair@286 56 public AbstractServerAsyncTransport(WSEndpoint endpoint) {
ohair@286 57 this.endpoint = endpoint;
ohair@286 58 codecPool = new CodecPool(endpoint);
ohair@286 59 }
ohair@286 60
ohair@286 61 /**
ohair@286 62 * decodes the transport data to Packet
ohair@286 63 *
ohair@286 64 * @param connection that carries the web service request
ohair@286 65 * @param codec for encoding/decoding {@link Message}
ohair@286 66 * @return decoded {@link Packet}
ohair@286 67 * @throws IOException if an i/o error happens while encoding/decoding
ohair@286 68 */
ohair@286 69 protected Packet decodePacket(T connection, @NotNull Codec codec) throws IOException {
ohair@286 70 Packet packet = new Packet();
ohair@286 71 packet.acceptableMimeTypes = getAcceptableMimeTypes(connection);
ohair@286 72 packet.addSatellite(getPropertySet(connection));
ohair@286 73 packet.transportBackChannel = getTransportBackChannel(connection);
ohair@286 74 return packet;
ohair@286 75 }
ohair@286 76
ohair@286 77 /**
ohair@286 78 * Encodes the {@link Packet} to infoset and writes on the connection.
ohair@286 79 *
ohair@286 80 * @param connection that carries the web service request
ohair@286 81 * @param packet that needs to encoded to infoset
ohair@286 82 * @param codec that does the encoding of Packet
ohair@286 83 * @throws IOException if an i/o error happens while encoding/decoding
ohair@286 84 */
ohair@286 85 protected abstract void encodePacket(T connection, @NotNull Packet packet, @NotNull Codec codec) throws IOException;
ohair@286 86
ohair@286 87 /**
ohair@286 88 * If the request has Accept header, return that value
ohair@286 89 *
ohair@286 90 * @param connection that carries the web service request
ohair@286 91 * @return Accept MIME types
ohair@286 92 */
ohair@286 93 protected abstract @Nullable String getAcceptableMimeTypes(T connection);
ohair@286 94
ohair@286 95 /**
ohair@286 96 * {@link TransportBackChannel} used by jax-ws runtime to close the connection
ohair@286 97 * while the processing of the request is still continuing. In oneway HTTP case, a
ohair@286 98 * response code needs to be sent before invoking the endpoint.
ohair@286 99 *
ohair@286 100 * @param connection that carries the web service request
ohair@286 101 * @return TransportBackChannel instance using the connection
ohair@286 102 */
ohair@286 103 protected abstract @Nullable TransportBackChannel getTransportBackChannel(T connection);
ohair@286 104
ohair@286 105 /**
ohair@286 106 * If there are any properties associated with the connection, those will
ohair@286 107 * be added to {@link Packet}
ohair@286 108 *
ohair@286 109 * @param connection that carries the web service request
ohair@286 110 * @return {@link PropertySet} for the connection
ohair@286 111 */
ohair@286 112 protected abstract @NotNull PropertySet getPropertySet(T connection);
ohair@286 113
ohair@286 114 /**
ohair@286 115 * Return a {@link WebServiceContextDelegate} using the underlying connection.
ohair@286 116 *
ohair@286 117 * @param connection that carries the web service request
ohair@286 118 * @return non-null WebServiceContextDelegate instance
ohair@286 119 */
ohair@286 120 protected abstract @NotNull WebServiceContextDelegate getWebServiceContextDelegate(T connection);
ohair@286 121
ohair@286 122 /**
ohair@286 123 * Reads and decodes infoset from the connection and invokes the endpoints. The
ohair@286 124 * response is encoded and written to the connection. The response could be
ohair@286 125 * written using a different thread.
ohair@286 126 *
ohair@286 127 * @param connection that carries the web service request
ohair@286 128 * @throws IOException if an i/o error happens while encoding/decoding
ohair@286 129 */
ohair@286 130 protected void handle(final T connection) throws IOException {
ohair@286 131 final Codec codec = codecPool.take();
ohair@286 132 Packet request = decodePacket(connection, codec);
ohair@286 133 if (!request.getMessage().isFault()) {
ohair@286 134 endpoint.schedule(request, new WSEndpoint.CompletionCallback() {
ohair@286 135 public void onCompletion(@NotNull Packet response) {
ohair@286 136 try {
ohair@286 137 encodePacket(connection, response, codec);
ohair@286 138 } catch(IOException ioe) {
ohair@286 139 ioe.printStackTrace();
ohair@286 140 }
ohair@286 141 codecPool.recycle(codec);
ohair@286 142 }
ohair@286 143 });
ohair@286 144 }
ohair@286 145 }
ohair@286 146
ohair@286 147 private static final class CodecPool extends Pool<Codec> {
ohair@286 148 WSEndpoint endpoint;
ohair@286 149
ohair@286 150 CodecPool(WSEndpoint endpoint) {
ohair@286 151 this. endpoint = endpoint;
ohair@286 152 }
ohair@286 153
ohair@286 154 protected Codec create() {
ohair@286 155 return endpoint.createCodec();
ohair@286 156 }
ohair@286 157 }
ohair@286 158
ohair@286 159 }

mercurial