01: /*
02: * ========================================================================
03: *
04: * Copyright 2001-2004 The Apache Software Foundation.
05: *
06: * Licensed under the Apache License, Version 2.0 (the "License");
07: * you may not use this file except in compliance with the License.
08: * You may obtain a copy of the License at
09: *
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 238991 2004-05-22 11:34:50Z vmassol $
29: */
30: public interface WebConfiguration extends Configuration {
31: /**
32: * @return the redirector URL for the default redirector
33: */
34: String getDefaultRedirectorURL();
35:
36: /**
37: * @return the default redirector name as defined by the Cactus
38: * configuration
39: */
40: String getDefaultRedirectorName();
41:
42: /**
43: * @param theRequest the Web request used to connect to the redirector
44: * @return the redirector URL for the redirector to use. It is either
45: * the default redirector name or the redirector defined in
46: * the Web
47: */
48: String getRedirectorURL(WebRequest theRequest);
49:
50: /**
51: * @param theRequest the Web request used to connect to the redirector
52: * @return the redirector name to use. It is either the default
53: * redirector name or the redirector defined in the Web
54: * Request if it has been overriden
55: */
56: String getRedirectorName(WebRequest theRequest);
57: }
|