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