001    // Copyright 2004, 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry.services;
016    
017    /**
018     * Service used to construct absolute URLs (often used for redirects).
019     * 
020     * @author Howard M. Lewis Ship
021     * @since 4.0
022     */
023    public interface AbsoluteURLBuilder
024    {
025        /**
026         * Constructs a URL from the given URI (that is, service path), schema, server and port.
027         * 
028         * @param URI
029         *            either a complete URL (that is, containing a colon), in which case it is returned
030         *            unchanged, or the path within the server.
031         * @param scheme
032         *            scheme to prefix URI with
033         * @param server
034         *            to prefix the URI with (unless the URI begins with "//"
035         * @param port
036         *            to suffix the server with (unless the URI begins with "//")
037         */
038        String constructURL(String URI, String scheme, String server, int port);
039    
040        /**
041         * Constructs a URL, defaulting scheme, server and port to the values for the current request.
042         */
043    
044        String constructURL(String URI);
045    }