KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > geronimo > management > geronimo > WebModule


1 /**
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 package org.apache.geronimo.management.geronimo;
18
19 import java.net.URL JavaDoc;
20
21 /**
22  * Geronimo extension to the standard JSR-77 WebModule type.
23  *
24  * @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
25  */
26 public interface WebModule extends org.apache.geronimo.management.WebModule {
27     /**
28      * Gets the web context for this web app.
29      */
30     public String JavaDoc getContextPath();
31
32     /**
33      * Gets the ObjectName of the WebContainer that's hosting this
34      * WebModule.
35      */
36     public WebContainer getContainer();
37
38     /**
39      * Gets a URL that can be used to access this web application. Prefers
40      * HTTP if available, then HTTPS, then AJP, depending on what the hosting
41      * web container makes available.
42      */
43     public URL JavaDoc getURLFor();
44
45     /**
46      * Gets a name for this WAR file that can be used to identify the WAR to a
47      * user. This is not guaranteed to be anything in particular.
48      */
49     public String JavaDoc getWARName();
50
51     /**
52      * Gets the location of the web module "source" (typically an exploded
53      * directory). This is where e.g. a web server would look for static
54      * content or a user would copy updated JSPs to.
55      */
56     public URL JavaDoc getWARDirectory();
57 }
58
Popular Tags