View Javadoc

1   package org.apache.turbine.util.uri;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  /***
23   * An interface class which describes the absolute minimum of methods that
24   * a Turbine URI class must implement.
25   *
26   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
27   * @version $Id: URI.java 534527 2007-05-02 16:10:59Z tv $
28   */
29  
30  public interface URI
31  {
32      /***
33       * Gets the script name (/servlets/Turbine).
34       *
35       * @return A String with the script name.
36       */
37      String getScriptName();
38  
39      /***
40       * Gets the context path.
41       *
42       * @return A String with the context path.
43       */
44      String getContextPath();
45  
46      /***
47       * Gets the server name.
48       *
49       * @return A String with the server name.
50       */
51      String getServerName();
52  
53      /***
54       * Gets the server port.
55       *
56       * @return A String with the server port.
57       */
58      int getServerPort();
59  
60      /***
61       * Returns the current Server Scheme
62       *
63       * @return The current Server scheme
64       *
65       */
66      String getServerScheme();
67  
68      /***
69       * Returns the current reference anchor.
70       *
71       * @return A String containing the reference.
72       */
73      String getReference();
74  }