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.util.pipe.StandalonePipeAssembler;
044:
045: import javax.xml.ws.WebServiceException;
046:
047: /**
048: * Factory for transport pipes that enables transport pluggability.
049: *
050: * <p>
051: * At runtime, on the client side, JAX-WS (more specifically the default {@link PipelineAssembler}
052: * of JAX-WS client runtime) relies on this factory to create a suitable transport {@link Pipe}
053: * that can handle the given {@link EndpointAddress endpoint address}.
054: *
055: * <p>
056: * JAX-WS extensions that provide additional transport support can
057: * extend this class and implement the {@link #doCreate} method.
058: * They are expected to check the scheme of the endpoint address
059: * (and possibly some other settings from bindings), and create
060: * their transport pipe implementations accordingly.
061: * For example,
062: *
063: * <pre>
064: * class MyTransportPipeFactoryImpl {
065: * Pipe doCreate(...) {
066: * String scheme = address.getURI().getScheme();
067: * if(scheme.equals("foo"))
068: * return new MyTransport(...);
069: * else
070: * return null;
071: * }
072: * }
073: * </pre>
074: *
075: * <p>
076: * {@link TransportPipeFactory} look-up follows the standard service
077: * discovery mechanism, so you need
078: * {@code META-INF/services/com.sun.xml.ws.api.pipe.TransportPipeFactory}.
079: *
080: *
081: *
082: * <h2>TODO</h2>
083: * <p>
084: * One of the JAX-WS operation mode is supposedly where it doesn't have no WSDL whatsoever.
085: * How do we identify the endpoint in such case?
086: *
087: * @author Kohsuke Kawaguchi
088: * @see StandalonePipeAssembler
089: */
090: public abstract class TransportPipeFactory {
091: /**
092: * Creates a transport {@link Pipe} for the given port, if this factory can do so,
093: * or return null.
094: *
095: * @param context
096: * Object that captures various contextual information
097: * that can be used to determine the pipeline to be assembled.
098: *
099: * @return
100: * null to indicate that this factory isn't capable of creating a transport
101: * for this port (which causes the caller to search for other {@link TransportPipeFactory}s
102: * that can. Or non-null.
103: *
104: * @throws WebServiceException
105: * if this factory is capable of creating a transport pipe but some fatal
106: * error prevented it from doing so. This exception will be propagated
107: * back to the user application, and no further {@link TransportPipeFactory}s
108: * are consulted.
109: */
110: public abstract Pipe doCreate(@NotNull
111: ClientPipeAssemblerContext context);
112:
113: /**
114: * Locates {@link PipelineAssemblerFactory}s and create
115: * a suitable {@link PipelineAssembler}.
116: *
117: * @param classLoader
118: * used to locate {@code META-INF/servces} files.
119: * @return
120: * Always non-null, since we fall back to our default {@link PipelineAssembler}.
121: *
122: * @deprecated
123: * Use {@link TransportTubeFactory#create(ClassLoader, ClientTubeAssemblerContext)}
124: */
125: public static Pipe create(@Nullable
126: ClassLoader classLoader, @NotNull
127: ClientPipeAssemblerContext context) {
128: return PipeAdapter.adapt(TransportTubeFactory.create(
129: classLoader, context));
130: }
131: }
|