View Javadoc

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