Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/Container.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/Container.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 397
- b99d7e355d4b
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.xml.internal.ws.api.server; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.util.Collection; |
| aoqi@0 | 29 | import java.util.Collections; |
| aoqi@0 | 30 | import java.util.Set; |
| aoqi@0 | 31 | import java.util.concurrent.CopyOnWriteArraySet; |
| aoqi@0 | 32 | |
| aoqi@0 | 33 | import com.sun.istack.internal.NotNull; |
| aoqi@0 | 34 | import com.sun.xml.internal.ws.api.Component; |
| aoqi@0 | 35 | import com.sun.xml.internal.ws.api.ComponentEx; |
| aoqi@0 | 36 | import com.sun.xml.internal.ws.api.ComponentRegistry; |
| aoqi@0 | 37 | |
| aoqi@0 | 38 | /** |
| aoqi@0 | 39 | * Root of the SPI implemented by the container |
| aoqi@0 | 40 | * (such as application server.) |
| aoqi@0 | 41 | * |
| aoqi@0 | 42 | * <p> |
| aoqi@0 | 43 | * Often technologies that are built on top of JAX-WS |
| aoqi@0 | 44 | * (such as Tango) needs to negotiate private contracts between |
| aoqi@0 | 45 | * them and the container. This interface allows such technologies |
| aoqi@0 | 46 | * to query the negotiated SPI by using the {@link #getSPI(Class)}. |
| aoqi@0 | 47 | * |
| aoqi@0 | 48 | * <p> |
| aoqi@0 | 49 | * For example, if a security pipe needs to get some information |
| aoqi@0 | 50 | * from a container, they can do the following: |
| aoqi@0 | 51 | * <ol> |
| aoqi@0 | 52 | * <li>Negotiate an interface with the container and define it. |
| aoqi@0 | 53 | * (let's call it <tt>ContainerSecuritySPI</tt>.) |
| aoqi@0 | 54 | * <li>The container will implement <tt>ContainerSecuritySPI</tt>. |
| aoqi@0 | 55 | * <li>At the runtime, a security pipe gets |
| aoqi@0 | 56 | * {@link WSEndpoint} and then to {@link Container}. |
| aoqi@0 | 57 | * <li>It calls <tt>container.getSPI(ContainerSecuritySPI.class)</tt> |
| aoqi@0 | 58 | * <li>The container returns an instance of <tt>ContainerSecuritySPI</tt>. |
| aoqi@0 | 59 | * <li>The security pipe talks to the container through this SPI. |
| aoqi@0 | 60 | * </ol> |
| aoqi@0 | 61 | * |
| aoqi@0 | 62 | * <p> |
| aoqi@0 | 63 | * This protects JAX-WS from worrying about the details of such contracts, |
| aoqi@0 | 64 | * while still providing the necessary service of hooking up those parties. |
| aoqi@0 | 65 | * |
| aoqi@0 | 66 | * <p> |
| aoqi@0 | 67 | * Technologies that run inside JAX-WS server runtime can access this object through |
| aoqi@0 | 68 | * {@link WSEndpoint#getContainer()}. In the client runtime, it can be accessed from |
| aoqi@0 | 69 | * {@link ContainerResolver#getContainer()} |
| aoqi@0 | 70 | * |
| aoqi@0 | 71 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 72 | * @see WSEndpoint |
| aoqi@0 | 73 | */ |
| aoqi@0 | 74 | public abstract class Container implements ComponentRegistry, ComponentEx { |
| aoqi@0 | 75 | private final Set<Component> components = new CopyOnWriteArraySet<Component>(); |
| aoqi@0 | 76 | |
| aoqi@0 | 77 | /** |
| aoqi@0 | 78 | * For derived classes. |
| aoqi@0 | 79 | */ |
| aoqi@0 | 80 | protected Container() { |
| aoqi@0 | 81 | } |
| aoqi@0 | 82 | |
| aoqi@0 | 83 | /** |
| aoqi@0 | 84 | * Constant that represents a "no {@link Container}", |
| aoqi@0 | 85 | * which always returns null from {@link #getSPI(Class)}. |
| aoqi@0 | 86 | */ |
| aoqi@0 | 87 | public static final Container NONE = new NoneContainer(); |
| aoqi@0 | 88 | |
| aoqi@0 | 89 | private static final class NoneContainer extends Container { |
| aoqi@0 | 90 | } |
| aoqi@0 | 91 | |
| aoqi@0 | 92 | public <S> S getSPI(Class<S> spiType) { |
| aoqi@0 | 93 | if (components == null) return null; |
| aoqi@0 | 94 | for (Component c : components) { |
| aoqi@0 | 95 | S s = c.getSPI(spiType); |
| aoqi@0 | 96 | if (s != null) |
| aoqi@0 | 97 | return s; |
| aoqi@0 | 98 | } |
| aoqi@0 | 99 | return null; |
| aoqi@0 | 100 | } |
| aoqi@0 | 101 | |
| aoqi@0 | 102 | public Set<Component> getComponents() { |
| aoqi@0 | 103 | return components; |
| aoqi@0 | 104 | } |
| aoqi@0 | 105 | |
| aoqi@0 | 106 | public @NotNull <E> Iterable<E> getIterableSPI(Class<E> spiType) { |
| aoqi@0 | 107 | E item = getSPI(spiType); |
| aoqi@0 | 108 | if (item != null) { |
| aoqi@0 | 109 | Collection<E> c = Collections.singletonList(item); |
| aoqi@0 | 110 | return c; |
| aoqi@0 | 111 | } |
| aoqi@0 | 112 | return Collections.emptySet(); |
| aoqi@0 | 113 | } |
| aoqi@0 | 114 | } |
