src/share/jaxws_classes/com/sun/xml/internal/ws/api/pipe/TransportTubeFactory.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, 2013, 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.pipe;
ohair@286 27
ohair@286 28 import com.sun.istack.internal.NotNull;
ohair@286 29 import com.sun.istack.internal.Nullable;
ohair@286 30 import com.sun.xml.internal.ws.api.EndpointAddress;
ohair@286 31 import com.sun.xml.internal.ws.api.pipe.helper.PipeAdapter;
ohair@286 32 import com.sun.xml.internal.ws.transport.http.client.HttpTransportPipe;
ohair@286 33 import com.sun.xml.internal.ws.util.ServiceFinder;
ohair@286 34 import com.sun.xml.internal.ws.util.pipe.StandaloneTubeAssembler;
alanb@368 35 import java.util.logging.Level;
ohair@286 36
ohair@286 37 import javax.xml.ws.WebServiceException;
ohair@286 38 import java.util.logging.Logger;
ohair@286 39
ohair@286 40 /**
ohair@286 41 * Factory for transport tubes that enables transport pluggability.
ohair@286 42 *
ohair@286 43 * <p>
ohair@286 44 * At runtime, on the client side, JAX-WS (more specifically the default {@link TubelineAssembler}
ohair@286 45 * of JAX-WS client runtime) relies on this factory to create a suitable transport {@link Tube}
ohair@286 46 * that can handle the given {@link EndpointAddress endpoint address}.
ohair@286 47 *
ohair@286 48 * <p>
ohair@286 49 * JAX-WS extensions that provide additional transport support can
ohair@286 50 * extend this class and implement the {@link #doCreate} method.
ohair@286 51 * They are expected to check the scheme of the endpoint address
ohair@286 52 * (and possibly some other settings from bindings), and create
ohair@286 53 * their transport tube implementations accordingly.
ohair@286 54 * For example,
ohair@286 55 *
ohair@286 56 * <pre>
ohair@286 57 * class MyTransportTubeFactoryImpl {
ohair@286 58 * Tube doCreate(...) {
ohair@286 59 * String scheme = address.getURI().getScheme();
ohair@286 60 * if(scheme.equals("foo"))
ohair@286 61 * return new MyTransport(...);
ohair@286 62 * else
ohair@286 63 * return null;
ohair@286 64 * }
ohair@286 65 * }
ohair@286 66 * </pre>
ohair@286 67 *
ohair@286 68 * <p>
ohair@286 69 * {@link TransportTubeFactory} look-up follows the standard service
ohair@286 70 * discovery mechanism, so you need
alanb@368 71 * {@code META-INF/services/com.sun.xml.internal.ws.api.pipe.BasicTransportTubeFactory}.
ohair@286 72 *
ohair@286 73 * @author Jitendra Kotamraju
ohair@286 74 * @see StandaloneTubeAssembler
ohair@286 75 */
ohair@286 76 public abstract class TransportTubeFactory {
ohair@286 77 /**
ohair@286 78 * Creates a transport {@link Tube} for the given port, if this factory can do so,
ohair@286 79 * or return null.
ohair@286 80 *
ohair@286 81 * @param context
ohair@286 82 * Object that captures various contextual information
ohair@286 83 * that can be used to determine the tubeline to be assembled.
ohair@286 84 *
ohair@286 85 * @return
ohair@286 86 * null to indicate that this factory isn't capable of creating a transport
ohair@286 87 * for this port (which causes the caller to search for other {@link TransportTubeFactory}s
ohair@286 88 * that can. Or non-null.
ohair@286 89 *
ohair@286 90 * @throws WebServiceException
ohair@286 91 * if this factory is capable of creating a transport tube but some fatal
ohair@286 92 * error prevented it from doing so. This exception will be propagated
ohair@286 93 * back to the user application, and no further {@link TransportTubeFactory}s
ohair@286 94 * are consulted.
ohair@286 95 */
ohair@286 96 public abstract Tube doCreate(@NotNull ClientTubeAssemblerContext context);
ohair@286 97
ohair@286 98 private static final TransportTubeFactory DEFAULT = new DefaultTransportTubeFactory();
ohair@286 99 private static class DefaultTransportTubeFactory extends TransportTubeFactory {
ohair@286 100
ohair@286 101 @Override
ohair@286 102 public Tube doCreate(ClientTubeAssemblerContext context) {
ohair@286 103 return createDefault(context);
ohair@286 104 }
ohair@286 105
ohair@286 106 }
ohair@286 107
ohair@286 108 /**
ohair@286 109 * Locates {@link TransportTubeFactory}s and create a suitable transport {@link Tube}.
ohair@286 110 *
ohair@286 111 * @param classLoader
ohair@286 112 * used to locate {@code META-INF/servces} files.
ohair@286 113 * @return
ohair@286 114 * Always non-null, since we fall back to our default {@link Tube}.
ohair@286 115 */
ohair@286 116 public static Tube create(@Nullable ClassLoader classLoader, @NotNull ClientTubeAssemblerContext context) {
ohair@286 117 for (TransportTubeFactory factory : ServiceFinder.find(TransportTubeFactory.class,classLoader, context.getContainer())) {
ohair@286 118 Tube tube = factory.doCreate(context);
alanb@368 119 if (tube !=null) {
alanb@368 120 if (logger.isLoggable(Level.FINE)) {
alanb@368 121 TransportTubeFactory.logger.log(Level.FINE, "{0} successfully created {1}", new Object[]{factory.getClass(), tube});
alanb@368 122 }
ohair@286 123 return tube;
ohair@286 124 }
ohair@286 125 }
ohair@286 126
ohair@286 127 // See if there is a {@link TransportPipeFactory} out there and use it for compatibility.
ohair@286 128 ClientPipeAssemblerContext ctxt = new ClientPipeAssemblerContext(
ohair@286 129 context.getAddress(), context.getWsdlModel(), context.getService(),
ohair@286 130 context.getBinding(), context.getContainer());
ohair@286 131 ctxt.setCodec(context.getCodec());
ohair@286 132 for (TransportPipeFactory factory : ServiceFinder.find(TransportPipeFactory.class,classLoader)) {
ohair@286 133 Pipe pipe = factory.doCreate(ctxt);
ohair@286 134 if (pipe!=null) {
alanb@368 135 if (logger.isLoggable(Level.FINE)) {
alanb@368 136 logger.log(Level.FINE, "{0} successfully created {1}", new Object[]{factory.getClass(), pipe});
alanb@368 137 }
ohair@286 138 return PipeAdapter.adapt(pipe);
ohair@286 139 }
ohair@286 140 }
ohair@286 141
ohair@286 142 return DEFAULT.createDefault(ctxt);
ohair@286 143 }
ohair@286 144
ohair@286 145 protected Tube createDefault(ClientTubeAssemblerContext context) {
ohair@286 146 // default built-in transports
ohair@286 147 String scheme = context.getAddress().getURI().getScheme();
ohair@286 148 if (scheme != null) {
ohair@286 149 if(scheme.equalsIgnoreCase("http") || scheme.equalsIgnoreCase("https"))
ohair@286 150 return createHttpTransport(context);
ohair@286 151 }
ohair@286 152 throw new WebServiceException("Unsupported endpoint address: "+context.getAddress()); // TODO: i18n
ohair@286 153 }
ohair@286 154
ohair@286 155 protected Tube createHttpTransport(ClientTubeAssemblerContext context) {
ohair@286 156 return new HttpTransportPipe(context.getCodec(), context.getBinding());
ohair@286 157 }
ohair@286 158
ohair@286 159 private static final Logger logger = Logger.getLogger(TransportTubeFactory.class.getName());
ohair@286 160 }

mercurial