001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.ws.api.pipe;
038:
039: import com.sun.istack.NotNull;
040: import com.sun.istack.Nullable;
041: import com.sun.xml.ws.api.EndpointAddress;
042: import com.sun.xml.ws.api.pipe.helper.PipeAdapter;
043: import com.sun.xml.ws.transport.http.client.HttpTransportPipe;
044: import com.sun.xml.ws.util.ServiceFinder;
045: import com.sun.xml.ws.util.pipe.StandaloneTubeAssembler;
046:
047: import javax.xml.ws.WebServiceException;
048: import java.util.logging.Logger;
049:
050: /**
051: * Factory for transport tubes that enables transport pluggability.
052: *
053: * <p>
054: * At runtime, on the client side, JAX-WS (more specifically the default {@link TubelineAssembler}
055: * of JAX-WS client runtime) relies on this factory to create a suitable transport {@link Tube}
056: * that can handle the given {@link EndpointAddress endpoint address}.
057: *
058: * <p>
059: * JAX-WS extensions that provide additional transport support can
060: * extend this class and implement the {@link #doCreate} method.
061: * They are expected to check the scheme of the endpoint address
062: * (and possibly some other settings from bindings), and create
063: * their transport tube implementations accordingly.
064: * For example,
065: *
066: * <pre>
067: * class MyTransportTubeFactoryImpl {
068: * Tube doCreate(...) {
069: * String scheme = address.getURI().getScheme();
070: * if(scheme.equals("foo"))
071: * return new MyTransport(...);
072: * else
073: * return null;
074: * }
075: * }
076: * </pre>
077: *
078: * <p>
079: * {@link TransportTubeFactory} look-up follows the standard service
080: * discovery mechanism, so you need
081: * {@code META-INF/services/com.sun.xml.ws.api.pipe.TransportTubeFactory}.
082: *
083: * @author Jitendra Kotamraju
084: * @see StandaloneTubeAssembler
085: */
086: public abstract class TransportTubeFactory {
087: /**
088: * Creates a transport {@link Tube} for the given port, if this factory can do so,
089: * or return null.
090: *
091: * @param context
092: * Object that captures various contextual information
093: * that can be used to determine the tubeline to be assembled.
094: *
095: * @return
096: * null to indicate that this factory isn't capable of creating a transport
097: * for this port (which causes the caller to search for other {@link TransportTubeFactory}s
098: * that can. Or non-null.
099: *
100: * @throws WebServiceException
101: * if this factory is capable of creating a transport tube but some fatal
102: * error prevented it from doing so. This exception will be propagated
103: * back to the user application, and no further {@link TransportTubeFactory}s
104: * are consulted.
105: */
106: public abstract Tube doCreate(@NotNull
107: ClientTubeAssemblerContext context);
108:
109: /**
110: * Locates {@link TransportTubeFactory}s and create a suitable transport {@link Tube}.
111: *
112: * @param classLoader
113: * used to locate {@code META-INF/servces} files.
114: * @return
115: * Always non-null, since we fall back to our default {@link Tube}.
116: */
117: public static Tube create(@Nullable
118: ClassLoader classLoader, @NotNull
119: ClientTubeAssemblerContext context) {
120: for (TransportTubeFactory factory : ServiceFinder.find(
121: TransportTubeFactory.class, classLoader)) {
122: Tube tube = factory.doCreate(context);
123: if (tube != null) {
124: TransportTubeFactory.logger.fine(factory.getClass()
125: + " successfully created " + tube);
126: return tube;
127: }
128: }
129:
130: // See if there is a {@link TransportPipeFactory} out there and use it for compatibility.
131: ClientPipeAssemblerContext ctxt = new ClientPipeAssemblerContext(
132: context.getAddress(), context.getWsdlModel(), context
133: .getService(), context.getBinding(), context
134: .getContainer());
135: for (TransportPipeFactory factory : ServiceFinder.find(
136: TransportPipeFactory.class, classLoader)) {
137: Pipe pipe = factory.doCreate(ctxt);
138: if (pipe != null) {
139: logger.fine(factory.getClass()
140: + " successfully created " + pipe);
141: return PipeAdapter.adapt(pipe);
142: }
143: }
144:
145: // default built-in transports
146: String scheme = context.getAddress().getURI().getScheme();
147: if (scheme != null) {
148: if (scheme.equalsIgnoreCase("http")
149: || scheme.equalsIgnoreCase("https"))
150: return new HttpTransportPipe(context.getCodec());
151: }
152:
153: throw new WebServiceException("Unsupported endpoint address: "
154: + context.getAddress()); // TODO: i18n
155: }
156:
157: private static final Logger logger = Logger
158: .getLogger(TransportTubeFactory.class.getName());
159: }
|