2011/08/05 - Jakarta Cactus has been retired.

For more information, please explore the Attic.

View Javadoc

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