com.sun.xml.ws.api.server.Container Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2019 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.ws.api.server;
import java.util.Collection;
import java.util.Collections;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArraySet;
import com.sun.istack.NotNull;
import com.sun.xml.ws.api.Component;
import com.sun.xml.ws.api.ComponentEx;
import com.sun.xml.ws.api.ComponentRegistry;
/**
* Root of the SPI implemented by the container
* (such as application server.)
*
*
* Often technologies that are built on top of JAX-WS
* (such as Tango) needs to negotiate private contracts between
* them and the container. This interface allows such technologies
* to query the negotiated SPI by using the {@link #getSPI(Class)}.
*
*
* For example, if a security pipe needs to get some information
* from a container, they can do the following:
*
* - Negotiate an interface with the container and define it.
* (let's call it {@code ContainerSecuritySPI}.)
*
- The container will implement {@code ContainerSecuritySPI}.
*
- At the runtime, a security pipe gets
* {@link WSEndpoint} and then to {@link Container}.
*
- It calls {@code container.getSPI(ContainerSecuritySPI.class)}
*
- The container returns an instance of {@code ContainerSecuritySPI}.
*
- The security pipe talks to the container through this SPI.
*
*
*
* This protects JAX-WS from worrying about the details of such contracts,
* while still providing the necessary service of hooking up those parties.
*
*
* Technologies that run inside JAX-WS server runtime can access this object through
* {@link WSEndpoint#getContainer()}. In the client runtime, it can be accessed from
* {@link ContainerResolver#getContainer()}
*
* @author Kohsuke Kawaguchi
* @see WSEndpoint
*/
public abstract class Container implements ComponentRegistry, ComponentEx {
private final Set components = new CopyOnWriteArraySet();
/**
* For derived classes.
*/
protected Container() {
}
/**
* Constant that represents a "no {@link Container}",
* which always returns null from {@link #getSPI(Class)}.
*/
public static final Container NONE = new NoneContainer();
private static final class NoneContainer extends Container {
}
public S getSPI(Class spiType) {
if (components == null) return null;
for (Component c : components) {
S s = c.getSPI(spiType);
if (s != null)
return s;
}
return null;
}
public Set getComponents() {
return components;
}
public @NotNull Iterable getIterableSPI(Class spiType) {
E item = getSPI(spiType);
if (item != null) {
Collection c = Collections.singletonList(item);
return c;
}
return Collections.emptySet();
}
}