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