01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.api.server;
38:
39: import com.sun.istack.NotNull;
40: import com.sun.xml.ws.transport.http.HttpAdapterList;
41:
42: import javax.xml.ws.wsaddressing.W3CEndpointReferenceBuilder;
43: import java.util.List;
44:
45: /**
46: * Represents an object scoped to the current "module" (like a JavaEE web appliation).
47: *
48: * <p>
49: * This object can be obtained from {@link Container#getSPI(Class)}.
50: *
51: * <p>
52: * The scope of the module is driven by {@link W3CEndpointReferenceBuilder#build()}'s
53: * requirement that we need to identify a {@link WSEndpoint} that has a specific
54: * service/port name.
55: *
56: * <p>
57: * For JavaEE containers this should be scoped to a JavaEE application. For
58: * other environment, this could be scoped to any similar notion. If no such
59: * notion is available, the implementation of {@link Container} can return
60: * a new {@link Module} object each time {@link Container#getSPI(Class)} is invoked.
61: *
62: * <p>
63: * There's a considerable overlap between this and {@link HttpAdapterList}.
64: * The SPI really needs to be reconsidered
65: *
66: *
67: * @see Container
68: * @author Kohsuke Kawaguchi
69: * @since 2.1 EA3
70: */
71: public abstract class Module {
72: /**
73: * Gets the list of {@link BoundEndpoint} deployed in this module.
74: *
75: * <p>
76: * From the point of view of the {@link Module} implementation,
77: * it really only needs to provide a {@link List} object as a data store.
78: * JAX-WS will update this list accordingly.
79: *
80: * @return
81: * always return the same non-null instance.
82: */
83: public abstract @NotNull
84: List<BoundEndpoint> getBoundEndpoints();
85: }
|