src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/Container.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 397
b99d7e355d4b
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, 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.server;
ohair@286 27
ohair@286 28 import java.util.Collection;
ohair@286 29 import java.util.Collections;
ohair@286 30 import java.util.HashSet;
ohair@286 31 import java.util.Set;
ohair@286 32 import java.util.concurrent.CopyOnWriteArraySet;
ohair@286 33
ohair@286 34 import com.sun.istack.internal.NotNull;
ohair@286 35 import com.sun.xml.internal.ws.api.Component;
ohair@286 36 import com.sun.xml.internal.ws.api.ComponentEx;
ohair@286 37 import com.sun.xml.internal.ws.api.ComponentRegistry;
ohair@286 38
ohair@286 39 /**
ohair@286 40 * Root of the SPI implemented by the container
ohair@286 41 * (such as application server.)
ohair@286 42 *
ohair@286 43 * <p>
ohair@286 44 * Often technologies that are built on top of JAX-WS
ohair@286 45 * (such as Tango) needs to negotiate private contracts between
ohair@286 46 * them and the container. This interface allows such technologies
ohair@286 47 * to query the negotiated SPI by using the {@link #getSPI(Class)}.
ohair@286 48 *
ohair@286 49 * <p>
ohair@286 50 * For example, if a security pipe needs to get some information
ohair@286 51 * from a container, they can do the following:
ohair@286 52 * <ol>
ohair@286 53 * <li>Negotiate an interface with the container and define it.
ohair@286 54 * (let's call it <tt>ContainerSecuritySPI</tt>.)
ohair@286 55 * <li>The container will implement <tt>ContainerSecuritySPI</tt>.
ohair@286 56 * <li>At the runtime, a security pipe gets
ohair@286 57 * {@link WSEndpoint} and then to {@link Container}.
ohair@286 58 * <li>It calls <tt>container.getSPI(ContainerSecuritySPI.class)</tt>
ohair@286 59 * <li>The container returns an instance of <tt>ContainerSecuritySPI</tt>.
ohair@286 60 * <li>The security pipe talks to the container through this SPI.
ohair@286 61 * </ol>
ohair@286 62 *
ohair@286 63 * <p>
ohair@286 64 * This protects JAX-WS from worrying about the details of such contracts,
ohair@286 65 * while still providing the necessary service of hooking up those parties.
ohair@286 66 *
ohair@286 67 * <p>
ohair@286 68 * Technologies that run inside JAX-WS server runtime can access this object through
ohair@286 69 * {@link WSEndpoint#getContainer()}. In the client runtime, it can be accessed from
ohair@286 70 * {@link ContainerResolver#getContainer()}
ohair@286 71 *
ohair@286 72 * @author Kohsuke Kawaguchi
ohair@286 73 * @see WSEndpoint
ohair@286 74 */
ohair@286 75 public abstract class Container implements ComponentRegistry, ComponentEx {
ohair@286 76 private final Set<Component> components = new CopyOnWriteArraySet<Component>();
ohair@286 77
ohair@286 78 /**
ohair@286 79 * For derived classes.
ohair@286 80 */
ohair@286 81 protected Container() {
ohair@286 82 }
ohair@286 83
ohair@286 84 /**
ohair@286 85 * Constant that represents a "no {@link Container}",
ohair@286 86 * which always returns null from {@link #getSPI(Class)}.
ohair@286 87 */
ohair@286 88 public static final Container NONE = new NoneContainer();
ohair@286 89
ohair@286 90 private static final class NoneContainer extends Container {
ohair@286 91 }
ohair@286 92
ohair@286 93 public <S> S getSPI(Class<S> spiType) {
ohair@286 94 for (Component c : components) {
ohair@286 95 S s = c.getSPI(spiType);
ohair@286 96 if (s != null)
ohair@286 97 return s;
ohair@286 98 }
ohair@286 99 return null;
ohair@286 100 }
ohair@286 101
ohair@286 102 public Set<Component> getComponents() {
ohair@286 103 return components;
ohair@286 104 }
ohair@286 105
ohair@286 106 public @NotNull <E> Iterable<E> getIterableSPI(Class<E> spiType) {
ohair@286 107 E item = getSPI(spiType);
ohair@286 108 if (item != null) {
ohair@286 109 Collection<E> c = Collections.singletonList(item);
ohair@286 110 return c;
ohair@286 111 }
ohair@286 112 return Collections.emptySet();
ohair@286 113 }
ohair@286 114 }

mercurial