Tue, 06 Mar 2012 16:09:35 -0800
7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom
ohair@286 | 1 | /* |
ohair@286 | 2 | * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved. |
ohair@286 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
ohair@286 | 4 | * |
ohair@286 | 5 | * This code is free software; you can redistribute it and/or modify it |
ohair@286 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@286 | 7 | * published by the Free Software Foundation. Oracle designates this |
ohair@286 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@286 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
ohair@286 | 10 | * |
ohair@286 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
ohair@286 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
ohair@286 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
ohair@286 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
ohair@286 | 15 | * accompanied this code). |
ohair@286 | 16 | * |
ohair@286 | 17 | * You should have received a copy of the GNU General Public License version |
ohair@286 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
ohair@286 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
ohair@286 | 20 | * |
ohair@286 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@286 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@286 | 23 | * questions. |
ohair@286 | 24 | */ |
ohair@286 | 25 | |
ohair@286 | 26 | package com.sun.xml.internal.ws.api.pipe; |
ohair@286 | 27 | |
ohair@286 | 28 | import com.sun.istack.internal.NotNull; |
ohair@286 | 29 | |
ohair@286 | 30 | /** |
ohair@286 | 31 | * Creates a tubeline. |
ohair@286 | 32 | * |
ohair@286 | 33 | * <p> |
ohair@286 | 34 | * This pluggability layer enables the upper layer to |
ohair@286 | 35 | * control exactly how the tubeline is composed. |
ohair@286 | 36 | * |
ohair@286 | 37 | * <p> |
ohair@286 | 38 | * JAX-WS is going to have its own default implementation |
ohair@286 | 39 | * when used all by itself, but it can be substituted by |
ohair@286 | 40 | * other implementations. |
ohair@286 | 41 | * |
ohair@286 | 42 | * <p> |
ohair@286 | 43 | * See {@link TubelineAssemblerFactory} for how {@link TubelineAssembler}s |
ohair@286 | 44 | * are located. |
ohair@286 | 45 | * |
ohair@286 | 46 | * |
ohair@286 | 47 | * @see com.sun.xml.internal.ws.api.pipe.ClientTubeAssemblerContext |
ohair@286 | 48 | * |
ohair@286 | 49 | * @author Kohsuke Kawaguchi |
ohair@286 | 50 | * @author Jitendra Kotamraju |
ohair@286 | 51 | */ |
ohair@286 | 52 | public interface TubelineAssembler { |
ohair@286 | 53 | /** |
ohair@286 | 54 | * Creates a new tubeline for clients. |
ohair@286 | 55 | * |
ohair@286 | 56 | * <p> |
ohair@286 | 57 | * When a JAX-WS client creates a proxy or a {@link javax.xml.ws.Dispatch} from |
ohair@286 | 58 | * a {@link javax.xml.ws.Service}, JAX-WS runtime internally uses this method |
ohair@286 | 59 | * to create a new tubeline as a part of the initilization. |
ohair@286 | 60 | * |
ohair@286 | 61 | * @param context |
ohair@286 | 62 | * Object that captures various contextual information |
ohair@286 | 63 | * that can be used to determine the tubeline to be assembled. |
ohair@286 | 64 | * |
ohair@286 | 65 | * @return |
ohair@286 | 66 | * non-null freshly created tubeline. |
ohair@286 | 67 | * |
ohair@286 | 68 | * @throws javax.xml.ws.WebServiceException |
ohair@286 | 69 | * if there's any configuration error that prevents the |
ohair@286 | 70 | * tubeline from being constructed. This exception will be |
ohair@286 | 71 | * propagated into the application, so it must have |
ohair@286 | 72 | * a descriptive error. |
ohair@286 | 73 | */ |
ohair@286 | 74 | @NotNull Tube createClient(@NotNull ClientTubeAssemblerContext context); |
ohair@286 | 75 | |
ohair@286 | 76 | /** |
ohair@286 | 77 | * Creates a new tubeline for servers. |
ohair@286 | 78 | * |
ohair@286 | 79 | * <p> |
ohair@286 | 80 | * When a JAX-WS server deploys a new endpoint, it internally |
ohair@286 | 81 | * uses this method to create a new tubeline as a part of the |
ohair@286 | 82 | * initialization. |
ohair@286 | 83 | * |
ohair@286 | 84 | * <p> |
ohair@286 | 85 | * Note that this method is called only once to set up a |
ohair@286 | 86 | * 'master tubeline', and it gets {@link Tube#copy(TubeCloner) copied} |
ohair@286 | 87 | * from it. |
ohair@286 | 88 | * |
ohair@286 | 89 | * @param context |
ohair@286 | 90 | * Object that captures various contextual information |
ohair@286 | 91 | * that can be used to determine the tubeline to be assembled. |
ohair@286 | 92 | * |
ohair@286 | 93 | * @return |
ohair@286 | 94 | * non-null freshly created tubeline. |
ohair@286 | 95 | * |
ohair@286 | 96 | * @throws javax.xml.ws.WebServiceException |
ohair@286 | 97 | * if there's any configuration error that prevents the |
ohair@286 | 98 | * tubeline from being constructed. This exception will be |
ohair@286 | 99 | * propagated into the container, so it must have |
ohair@286 | 100 | * a descriptive error. |
ohair@286 | 101 | * |
ohair@286 | 102 | */ |
ohair@286 | 103 | @NotNull Tube createServer(@NotNull ServerTubeAssemblerContext context); |
ohair@286 | 104 | } |