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

mercurial