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.request;
016    
017    import javax.servlet.http.HttpServletRequest;
018    
019    /**
020     *  Given a {@link javax.servlet.http.HttpServletRequest}, identifies
021     *  the correct request properties (server, scheme, URI and port).
022     * 
023     *  <p>An implementation of this class may be necessary when using
024     *  Tapestry with specific firewalls which may obscure
025     *  the scheme, server, etc. visible to the client web browser
026     *  (the request appears to arrive from the firewall server, not the
027     *  client web browser).
028     *
029     *  @author Howard Lewis Ship
030     *  @version IRequestDecoder.java,v 1.1 2002/08/20 21:49:58 hship Exp
031     *  @since 2.2
032     * 
033     **/
034    
035    public interface IRequestDecoder
036    {
037    
038        /**
039         *  Invoked to identify the actual properties from the request.
040         * 
041         **/
042    
043        DecodedRequest decodeRequest(HttpServletRequest request);
044    }