src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/WebModule.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
ohair@286 30 /**
ohair@286 31 * {@link Module} that is an HTTP container.
ohair@286 32 *
ohair@286 33 * @author Kohsuke Kawaguchi
ohair@286 34 * @since 2.1 EA3
ohair@286 35 */
ohair@286 36 public abstract class WebModule extends Module {
ohair@286 37 /**
ohair@286 38 * Gets the host, port, and context path portion of this module.
ohair@286 39 *
ohair@286 40 * <p>
ohair@286 41 * For example, if this is an web appliation running in a servlet
ohair@286 42 * container "http://myhost/myapp", then this method should return
ohair@286 43 * this URI.
ohair@286 44 *
ohair@286 45 * <p>
ohair@286 46 * This method follows the convention of the <tt>HttpServletRequest.getContextPath()</tt>,
ohair@286 47 * and accepts strings like "http://myhost" (for web applications that are deployed
ohair@286 48 * to the root context path), or "http://myhost/foobar" (for web applications
ohair@286 49 * that are deployed to context path "/foobar")
ohair@286 50 *
ohair@286 51 * <p>
ohair@286 52 * Notice that this method involves in determining the machine name
ohair@286 53 * without relying on HTTP "Host" header.
ohair@286 54 */
ohair@286 55 public abstract @NotNull String getContextPath();
ohair@286 56 }

mercurial