View Javadoc

1   package org.apache.turbine.util.uri;
2   
3   /*
4    * Copyright 2001-2005 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   * An interface class which describes the absolute minimum of methods that
21   * a Turbine URI class must implement.
22   *
23   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
24   * @version $Id: URI.java 264148 2005-08-29 14:21:04Z henning $
25   */
26  
27  public interface URI
28  {
29      /***
30       * Gets the script name (/servlets/Turbine).
31       *
32       * @return A String with the script name.
33       */
34      String getScriptName();
35  
36      /***
37       * Gets the context path.
38       *
39       * @return A String with the context path.
40       */
41      String getContextPath();
42  
43      /***
44       * Gets the server name.
45       *
46       * @return A String with the server name.
47       */
48      String getServerName();
49  
50      /***
51       * Gets the server port.
52       *
53       * @return A String with the server port.
54       */
55      int getServerPort();
56  
57      /***
58       * Returns the current Server Scheme
59       *
60       * @return The current Server scheme
61       *
62       */
63      String getServerScheme();
64  
65      /***
66       * Returns the current reference anchor.
67       *
68       * @return A String containing the reference.
69       */
70      String getReference();
71  }