001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    package org.apache.shiro.web.util;
020    
021    import javax.servlet.http.HttpServletRequest;
022    import java.io.Serializable;
023    
024    /**
025     * Maintains request data for a request that was redirected, so that after authentication
026     * the user can be redirected to the originally requested page.
027     *
028     * @since 0.9
029     */
030    public class SavedRequest implements Serializable {
031    
032        //TODO - complete JavaDoc
033    
034        private String method;
035        private String queryString;
036        private String requestURI;
037    
038        /**
039         * Constructs a new instance from the given HTTP request.
040         *
041         * @param request the current request to save.
042         */
043        public SavedRequest(HttpServletRequest request) {
044            this.method = request.getMethod();
045            this.queryString = request.getQueryString();
046            this.requestURI = request.getRequestURI();
047        }
048    
049        public String getMethod() {
050            return method;
051        }
052    
053        public String getQueryString() {
054            return queryString;
055        }
056    
057        public String getRequestURI() {
058            return requestURI;
059        }
060    
061        public String getRequestUrl() {
062            StringBuilder requestUrl = new StringBuilder(getRequestURI());
063            if (getQueryString() != null) {
064                requestUrl.append("?").append(getQueryString());
065            }
066            return requestUrl.toString();
067        }
068    }