KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cactus > internal > configuration > WebConfiguration


1 /*
2  * ========================================================================
3  *
4  * Copyright 2001-2004 The Apache Software Foundation.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *
18  * ========================================================================
19  */
20 package org.apache.cactus.internal.configuration;
21
22 import org.apache.cactus.WebRequest;
23
24 /**
25  * Extends the generic <code>Configuration</code> interface with methods
26  * provided configuration information related to Web redirectors.
27  *
28  * @version $Id: WebConfiguration.java,v 1.1 2004/05/22 11:34:46 vmassol Exp $
29  */
30 public interface WebConfiguration extends Configuration
31 {
32     /**
33      * @return the redirector URL for the default redirector
34      */
35     String JavaDoc getDefaultRedirectorURL();
36
37     /**
38      * @return the default redirector name as defined by the Cactus
39      * configuration
40      */
41     String JavaDoc getDefaultRedirectorName();
42
43     /**
44      * @param theRequest the Web request used to connect to the redirector
45      * @return the redirector URL for the redirector to use. It is either
46      * the default redirector name or the redirector defined in
47      * the Web
48      */
49     String JavaDoc getRedirectorURL(WebRequest theRequest);
50
51     /**
52      * @param theRequest the Web request used to connect to the redirector
53      * @return the redirector name to use. It is either the default
54      * redirector name or the redirector defined in the Web
55      * Request if it has been overriden
56      */
57     String JavaDoc getRedirectorName(WebRequest theRequest);
58 }
59
Popular Tags