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.myfaces.orchestra.requestParameterProvider;
20  
21  import javax.servlet.http.HttpServletResponse;
22  import javax.servlet.http.HttpServletResponseWrapper;
23  
24  /**
25   * This wrapper intercepts encodeURL and pass it to the {@link RequestParameterProviderManager} which attaches the url parameters
26   */
27  public class RequestParameterResponseWrapper extends HttpServletResponseWrapper
28  {
29      public RequestParameterResponseWrapper(HttpServletResponse httpServletResponse)
30      {
31          super(httpServletResponse);
32      }
33  
34      /**
35       * @param url the url to encode
36       * @return wrappedResponse.encodeUrl(url);
37       */
38      public String encodeURL(String url)
39      {
40          if (url != null)
41          {
42              url = RequestParameterProviderManager.getInstance().encodeAndAttachParameters(url);
43          }
44  
45          return super.encodeURL(url);
46      }
47  
48      /**
49       * Override deprecated form of this method, in case users call it.
50       * <p>
51       * The inherited implementation of this method calls super.encodeUrl(url)
52       * directly, which would bypass our custom code.
53       * 
54       * @since 1.1
55       * @deprecated
56       */
57      public String encodeUrl(String url)
58      {
59          return encodeURL(url);
60      }
61  }