ohair@286: /*
ohair@286:  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.api.pipe;
ohair@286: 
ohair@286: import com.sun.istack.internal.NotNull;
ohair@286: 
ohair@286: /**
ohair@286:  * Creates a tubeline.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * This pluggability layer enables the upper layer to
ohair@286:  * control exactly how the tubeline is composed.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * JAX-WS is going to have its own default implementation
ohair@286:  * when used all by itself, but it can be substituted by
ohair@286:  * other implementations.
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * See {@link TubelineAssemblerFactory} for how {@link TubelineAssembler}s
ohair@286:  * are located.
ohair@286:  *
ohair@286:  *
ohair@286:  * @see com.sun.xml.internal.ws.api.pipe.ClientTubeAssemblerContext
ohair@286:  *
ohair@286:  * @author Kohsuke Kawaguchi
ohair@286:  * @author Jitendra Kotamraju
ohair@286:  */
ohair@286: public interface TubelineAssembler {
ohair@286:     /**
ohair@286:      * Creates a new tubeline for clients.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * When a JAX-WS client creates a proxy or a {@link javax.xml.ws.Dispatch} from
ohair@286:      * a {@link javax.xml.ws.Service}, JAX-WS runtime internally uses this method
ohair@286:      * to create a new tubeline as a part of the initilization.
ohair@286:      *
ohair@286:      * @param context
ohair@286:      *      Object that captures various contextual information
ohair@286:      *      that can be used to determine the tubeline to be assembled.
ohair@286:      *
ohair@286:      * @return
ohair@286:      *      non-null freshly created tubeline.
ohair@286:      *
ohair@286:      * @throws javax.xml.ws.WebServiceException
ohair@286:      *      if there's any configuration error that prevents the
ohair@286:      *      tubeline from being constructed. This exception will be
ohair@286:      *      propagated into the application, so it must have
ohair@286:      *      a descriptive error.
ohair@286:      */
ohair@286:     @NotNull Tube createClient(@NotNull ClientTubeAssemblerContext context);
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a new tubeline for servers.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * When a JAX-WS server deploys a new endpoint, it internally
ohair@286:      * uses this method to create a new tubeline as a part of the
ohair@286:      * initialization.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * Note that this method is called only once to set up a
ohair@286:      * 'master tubeline', and it gets {@link Tube#copy(TubeCloner) copied}
ohair@286:      * from it.
ohair@286:      *
ohair@286:      * @param context
ohair@286:      *      Object that captures various contextual information
ohair@286:      *      that can be used to determine the tubeline to be assembled.
ohair@286:      *
ohair@286:      * @return
ohair@286:      *      non-null freshly created tubeline.
ohair@286:      *
ohair@286:      * @throws javax.xml.ws.WebServiceException
ohair@286:      *      if there's any configuration error that prevents the
ohair@286:      *      tubeline from being constructed. This exception will be
ohair@286:      *      propagated into the container, so it must have
ohair@286:      *      a descriptive error.
ohair@286:      *
ohair@286:      */
ohair@286:     @NotNull Tube createServer(@NotNull ServerTubeAssemblerContext context);
ohair@286: }