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