• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/ws/api/pipe/TransportPipeFactory.java@9c07ef4934dd (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/api/pipe/TransportPipeFactory.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.pipe;
aoqi@0	27
aoqi@0	28	import com.sun.istack.internal.NotNull;
aoqi@0	29	import com.sun.istack.internal.Nullable;
aoqi@0	30	import com.sun.xml.internal.ws.api.EndpointAddress;
aoqi@0	31	import com.sun.xml.internal.ws.api.pipe.helper.PipeAdapter;
aoqi@0	32	import com.sun.xml.internal.ws.util.pipe.StandalonePipeAssembler;
aoqi@0	33
aoqi@0	34	import javax.xml.ws.WebServiceException;
aoqi@0	35
aoqi@0	36	/**
aoqi@0	37	* Factory for transport pipes that enables transport pluggability.
aoqi@0	38	*
aoqi@0	39	* <p>
aoqi@0	40	* At runtime, on the client side, JAX-WS (more specifically the default {@link PipelineAssembler}
aoqi@0	41	* of JAX-WS client runtime) relies on this factory to create a suitable transport {@link Pipe}
aoqi@0	42	* that can handle the given {@link EndpointAddress endpoint address}.
aoqi@0	43	*
aoqi@0	44	* <p>
aoqi@0	45	* JAX-WS extensions that provide additional transport support can
aoqi@0	46	* extend this class and implement the {@link #doCreate} method.
aoqi@0	47	* They are expected to check the scheme of the endpoint address
aoqi@0	48	* (and possibly some other settings from bindings), and create
aoqi@0	49	* their transport pipe implementations accordingly.
aoqi@0	50	* For example,
aoqi@0	51	*
aoqi@0	52	* <pre>
aoqi@0	53	* class MyTransportPipeFactoryImpl {
aoqi@0	54	* Pipe doCreate(...) {
aoqi@0	55	* String scheme = address.getURI().getScheme();
aoqi@0	56	* if(scheme.equals("foo"))
aoqi@0	57	* return new MyTransport(...);
aoqi@0	58	* else
aoqi@0	59	* return null;
aoqi@0	60	* }
aoqi@0	61	* }
aoqi@0	62	* </pre>
aoqi@0	63	*
aoqi@0	64	* <p>
aoqi@0	65	* {@link TransportPipeFactory} look-up follows the standard service
aoqi@0	66	* discovery mechanism, so you need
aoqi@0	67	* {@code META-INF/services/com.sun.xml.internal.ws.api.pipe.TransportPipeFactory}.
aoqi@0	68	*
aoqi@0	69	*
aoqi@0	70	*
aoqi@0	71	* <h2>TODO</h2>
aoqi@0	72	* <p>
aoqi@0	73	* One of the JAX-WS operation mode is supposedly where it doesn't have no WSDL whatsoever.
aoqi@0	74	* How do we identify the endpoint in such case?
aoqi@0	75	*
aoqi@0	76	* @author Kohsuke Kawaguchi
aoqi@0	77	* @see StandalonePipeAssembler
aoqi@0	78	*/
aoqi@0	79	public abstract class TransportPipeFactory {
aoqi@0	80	/**
aoqi@0	81	* Creates a transport {@link Pipe} for the given port, if this factory can do so,
aoqi@0	82	* or return null.
aoqi@0	83	*
aoqi@0	84	* @param context
aoqi@0	85	* Object that captures various contextual information
aoqi@0	86	* that can be used to determine the pipeline to be assembled.
aoqi@0	87	*
aoqi@0	88	* @return
aoqi@0	89	* null to indicate that this factory isn't capable of creating a transport
aoqi@0	90	* for this port (which causes the caller to search for other {@link TransportPipeFactory}s
aoqi@0	91	* that can. Or non-null.
aoqi@0	92	*
aoqi@0	93	* @throws WebServiceException
aoqi@0	94	* if this factory is capable of creating a transport pipe but some fatal
aoqi@0	95	* error prevented it from doing so. This exception will be propagated
aoqi@0	96	* back to the user application, and no further {@link TransportPipeFactory}s
aoqi@0	97	* are consulted.
aoqi@0	98	*/
aoqi@0	99	public abstract Pipe doCreate(@NotNull ClientPipeAssemblerContext context);
aoqi@0	100
aoqi@0	101	/**
aoqi@0	102	* Locates {@link PipelineAssemblerFactory}s and create
aoqi@0	103	* a suitable {@link PipelineAssembler}.
aoqi@0	104	*
aoqi@0	105	* @param classLoader
aoqi@0	106	* used to locate {@code META-INF/servces} files.
aoqi@0	107	* @return
aoqi@0	108	* Always non-null, since we fall back to our default {@link PipelineAssembler}.
aoqi@0	109	*
aoqi@0	110	* @deprecated
aoqi@0	111	* Use {@link TransportTubeFactory#create(ClassLoader, ClientTubeAssemblerContext)}
aoqi@0	112	*/
aoqi@0	113	public static Pipe create(@Nullable ClassLoader classLoader, @NotNull ClientPipeAssemblerContext context) {
aoqi@0	114	return PipeAdapter.adapt(TransportTubeFactory.create(classLoader,context));
aoqi@0	115	}
aoqi@0	116	}