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:
041: /**
042: * Creates a tubeline.
043: *
044: * <p>
045: * This pluggability layer enables the upper layer to
046: * control exactly how the tubeline is composed.
047: *
048: * <p>
049: * JAX-WS is going to have its own default implementation
050: * when used all by itself, but it can be substituted by
051: * other implementations.
052: *
053: * <p>
054: * See {@link TubelineAssemblerFactory} for how {@link TubelineAssembler}s
055: * are located.
056: *
057: *
058: * @see com.sun.xml.ws.api.pipe.ClientTubeAssemblerContext
059: *
060: * @author Kohsuke Kawaguchi
061: * @author Jitendra Kotamraju
062: */
063: public interface TubelineAssembler {
064: /**
065: * Creates a new tubeline for clients.
066: *
067: * <p>
068: * When a JAX-WS client creates a proxy or a {@link javax.xml.ws.Dispatch} from
069: * a {@link javax.xml.ws.Service}, JAX-WS runtime internally uses this method
070: * to create a new tubeline as a part of the initilization.
071: *
072: * @param context
073: * Object that captures various contextual information
074: * that can be used to determine the tubeline to be assembled.
075: *
076: * @return
077: * non-null freshly created tubeline.
078: *
079: * @throws javax.xml.ws.WebServiceException
080: * if there's any configuration error that prevents the
081: * tubeline from being constructed. This exception will be
082: * propagated into the application, so it must have
083: * a descriptive error.
084: */
085: @NotNull
086: Tube createClient(@NotNull
087: ClientTubeAssemblerContext context);
088:
089: /**
090: * Creates a new tubeline for servers.
091: *
092: * <p>
093: * When a JAX-WS server deploys a new endpoint, it internally
094: * uses this method to create a new tubeline as a part of the
095: * initialization.
096: *
097: * <p>
098: * Note that this method is called only once to set up a
099: * 'master tubeline', and it gets {@link Tube#copy(TubeCloner) copied}
100: * from it.
101: *
102: * @param context
103: * Object that captures various contextual information
104: * that can be used to determine the tubeline to be assembled.
105: *
106: * @return
107: * non-null freshly created tubeline.
108: *
109: * @throws javax.xml.ws.WebServiceException
110: * if there's any configuration error that prevents the
111: * tubeline from being constructed. This exception will be
112: * propagated into the container, so it must have
113: * a descriptive error.
114: *
115: */
116: @NotNull
117: Tube createServer(@NotNull
118: ServerTubeAssemblerContext context);
119: }
|