1 /*
   2  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.ws.api.server;
  27 
  28 import com.sun.istack.internal.NotNull;
  29 
  30 /**
  31  * {@link Module} that is an HTTP container.
  32  *
  33  * @author Kohsuke Kawaguchi
  34  * @since 2.1 EA3
  35  */
  36 public abstract class WebModule extends Module {
  37     /**
  38      * Gets the host, port, and context path portion of this module.
  39      *
  40      * <p>
  41      * For example, if this is an web appliation running in a servlet
  42      * container "http://myhost/myapp", then this method should return
  43      * this URI.
  44      *
  45      * <p>
  46      * This method follows the convention of the <tt>HttpServletRequest.getContextPath()</tt>,
  47      * and accepts strings like "http://myhost" (for web applications that are deployed
  48      * to the root context path), or "http://myhost/foobar" (for web applications
  49      * that are deployed to context path "/foobar")
  50      *
  51      * <p>
  52      * Notice that this method involves in determining the machine name
  53      * without relying on HTTP "Host" header.
  54      */
  55     public abstract @NotNull String getContextPath();
  56 }