| /* |
| * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package com.sun.xml.internal.ws.api.server; |
| |
| import com.sun.istack.internal.NotNull; |
| import com.sun.istack.internal.Nullable; |
| import com.sun.xml.internal.ws.api.Component; |
| import com.sun.xml.internal.ws.transport.http.HttpAdapterList; |
| |
| import javax.xml.ws.wsaddressing.W3CEndpointReferenceBuilder; |
| import java.util.List; |
| |
| /** |
| * Represents an object scoped to the current "module" (like a JavaEE web appliation). |
| * |
| * <p> |
| * This object can be obtained from {@link Container#getSPI(Class)}. |
| * |
| * <p> |
| * The scope of the module is driven by {@link W3CEndpointReferenceBuilder#build()}'s |
| * requirement that we need to identify a {@link WSEndpoint} that has a specific |
| * service/port name. |
| * |
| * <p> |
| * For JavaEE containers this should be scoped to a JavaEE application. For |
| * other environment, this could be scoped to any similar notion. If no such |
| * notion is available, the implementation of {@link Container} can return |
| * a new {@link Module} object each time {@link Container#getSPI(Class)} is invoked. |
| * |
| * <p> |
| * There's a considerable overlap between this and {@link HttpAdapterList}. |
| * The SPI really needs to be reconsidered |
| * |
| * |
| * @see Container |
| * @author Kohsuke Kawaguchi |
| * @since 2.1 EA3 |
| */ |
| public abstract class Module implements Component { |
| /** |
| * Gets the list of {@link BoundEndpoint} deployed in this module. |
| * |
| * <p> |
| * From the point of view of the {@link Module} implementation, |
| * it really only needs to provide a {@link List} object as a data store. |
| * JAX-WS will update this list accordingly. |
| * |
| * @return |
| * always return the same non-null instance. |
| */ |
| public abstract @NotNull List<BoundEndpoint> getBoundEndpoints(); |
| |
| public @Nullable <S> S getSPI(@NotNull Class<S> spiType) { |
| return null; |
| } |
| |
| } |