View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.shiro.web.util;
20  
21  import javax.servlet.http.HttpServletRequest;
22  import java.io.Serializable;
23  
24  /**
25   * Maintains request data for a request that was redirected, so that after authentication
26   * the user can be redirected to the originally requested page.
27   *
28   * @since 0.9
29   */
30  public class SavedRequest implements Serializable {
31  
32      //TODO - complete JavaDoc
33  
34      private String method;
35      private String queryString;
36      private String requestURI;
37  
38      /**
39       * Constructs a new instance from the given HTTP request.
40       *
41       * @param request the current request to save.
42       */
43      public SavedRequest(HttpServletRequest request) {
44          this.method = request.getMethod();
45          this.queryString = request.getQueryString();
46          this.requestURI = request.getRequestURI();
47      }
48  
49      public String getMethod() {
50          return method;
51      }
52  
53      public String getQueryString() {
54          return queryString;
55      }
56  
57      public String getRequestURI() {
58          return requestURI;
59      }
60  
61      public String getRequestUrl() {
62          StringBuilder requestUrl = new StringBuilder(getRequestURI());
63          if (getQueryString() != null) {
64              requestUrl.append("?").append(getQueryString());
65          }
66          return requestUrl.toString();
67      }
68  }