Thu, 31 Aug 2017 15:18:52 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2012, 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 com.sun.istack.internal.NotNull; |
aoqi@0 | 29 | import com.sun.istack.internal.Nullable; |
aoqi@0 | 30 | import com.sun.xml.internal.ws.api.Component; |
aoqi@0 | 31 | import com.sun.xml.internal.ws.transport.http.HttpAdapterList; |
aoqi@0 | 32 | |
aoqi@0 | 33 | import javax.xml.ws.wsaddressing.W3CEndpointReferenceBuilder; |
aoqi@0 | 34 | import java.util.List; |
aoqi@0 | 35 | |
aoqi@0 | 36 | /** |
aoqi@0 | 37 | * Represents an object scoped to the current "module" (like a JavaEE web appliation). |
aoqi@0 | 38 | * |
aoqi@0 | 39 | * <p> |
aoqi@0 | 40 | * This object can be obtained from {@link Container#getSPI(Class)}. |
aoqi@0 | 41 | * |
aoqi@0 | 42 | * <p> |
aoqi@0 | 43 | * The scope of the module is driven by {@link W3CEndpointReferenceBuilder#build()}'s |
aoqi@0 | 44 | * requirement that we need to identify a {@link WSEndpoint} that has a specific |
aoqi@0 | 45 | * service/port name. |
aoqi@0 | 46 | * |
aoqi@0 | 47 | * <p> |
aoqi@0 | 48 | * For JavaEE containers this should be scoped to a JavaEE application. For |
aoqi@0 | 49 | * other environment, this could be scoped to any similar notion. If no such |
aoqi@0 | 50 | * notion is available, the implementation of {@link Container} can return |
aoqi@0 | 51 | * a new {@link Module} object each time {@link Container#getSPI(Class)} is invoked. |
aoqi@0 | 52 | * |
aoqi@0 | 53 | * <p> |
aoqi@0 | 54 | * There's a considerable overlap between this and {@link HttpAdapterList}. |
aoqi@0 | 55 | * The SPI really needs to be reconsidered |
aoqi@0 | 56 | * |
aoqi@0 | 57 | * |
aoqi@0 | 58 | * @see Container |
aoqi@0 | 59 | * @author Kohsuke Kawaguchi |
aoqi@0 | 60 | * @since 2.1 EA3 |
aoqi@0 | 61 | */ |
aoqi@0 | 62 | public abstract class Module implements Component { |
aoqi@0 | 63 | /** |
aoqi@0 | 64 | * Gets the list of {@link BoundEndpoint} deployed in this module. |
aoqi@0 | 65 | * |
aoqi@0 | 66 | * <p> |
aoqi@0 | 67 | * From the point of view of the {@link Module} implementation, |
aoqi@0 | 68 | * it really only needs to provide a {@link List} object as a data store. |
aoqi@0 | 69 | * JAX-WS will update this list accordingly. |
aoqi@0 | 70 | * |
aoqi@0 | 71 | * @return |
aoqi@0 | 72 | * always return the same non-null instance. |
aoqi@0 | 73 | */ |
aoqi@0 | 74 | public abstract @NotNull List<BoundEndpoint> getBoundEndpoints(); |
aoqi@0 | 75 | |
aoqi@0 | 76 | public @Nullable <S> S getSPI(@NotNull Class<S> spiType) { |
aoqi@0 | 77 | return null; |
aoqi@0 | 78 | } |
aoqi@0 | 79 | |
aoqi@0 | 80 | } |