GC: HttpServletRequestWrapper - javax.servlet.http.HttpServletRequestWrapper (.java)

Maven-Central
/
com.fasterxml.tran.....ransistore-server
/
0.9.8

0.9.8
0.9.7
0.9.5
0.9.2
0.9.0
0.7.1
/
javax.servlet.http.HttpServletRequestWrapper
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Questions
1
  /*
2
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3
   *
4
   * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
5
   *
6
   * The contents of this file are subject to the terms of either the GNU
7
   * General Public License Version 2 only ("GPL") or the Common Development
8
   * and Distribution License("CDDL") (collectively, the "License").  You
9
   * may not use this file except in compliance with the License.  You can
10
  * obtain a copy of the License at
11
  * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
12
  * or packager/legal/LICENSE.txt.  See the License for the specific
13
  * language governing permissions and limitations under the License.
14
  *
15
  * When distributing the software, include this License Header Notice in each
16
  * file and include the License file at packager/legal/LICENSE.txt.
17
  *
18
  * GPL Classpath Exception:
19
  * Oracle designates this particular file as subject to the "Classpath"
20
  * exception as provided by Oracle in the GPL Version 2 section of the License
21
  * file that accompanied this code.
22
  *
23
  * Modifications:
24
  * If applicable, add the following below the License Header, with the fields
25
  * enclosed by brackets [] replaced by your own identifying information:
26
  * "Portions Copyright [year] [name of copyright owner]"
27
  *
28
  * Contributor(s):
29
  * If you wish your version of this file to be governed by only the CDDL or
30
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
31
  * elects to include this software in this distribution under the [CDDL or GPL
32
  * Version 2] license."  If you don't indicate a single choice of license, a
33
  * recipient has the option to distribute your version of this file under
34
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
35
  * its licensees as provided above.  However, if you add GPL Version 2 code
36
  * and therefore, elected the GPL Version 2 license, then the option applies
37
  * only if the new code is made subject to such option by the copyright
38
  * holder.
39
  *
40
  *
41
  * This file incorporates work covered by the following copyright and
42
  * permission notice:
43
  *
44
  * Copyright 2004 The Apache Software Foundation
45
  *
46
  * Licensed under the Apache License, Version 2.0 (the "License");
47
  * you may not use this file except in compliance with the License.
48
  * You may obtain a copy of the License at
49
  *
50
  *     http://www.apache.org/licenses/LICENSE-2.0
51
  *
52
  * Unless required by applicable law or agreed to in writing, software
53
  * distributed under the License is distributed on an "AS IS" BASIS,
54
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
55
  * See the License for the specific language governing permissions and
56
  * limitations under the License.
57
  */
58
 
59
 package javax.servlet.http;
60
 
61
 import java.io.IOException;
62
 import java.util.*;
63
 import javax.servlet.ServletException;
64
 import javax.servlet.ServletRequestWrapper;

 Provides a convenient implementation of the HttpServletRequest interface
 that can be subclassed by developers wishing to adapt the request to a
 Servlet.

 This class implements the Wrapper or Decorator pattern. Methods default
 to calling through to the wrapped request object.
 
 
 Since:Servlet 2.3 See also:HttpServletRequest
76
 
77
 
78
 
79
 public class HttpServletRequestWrapper extends ServletRequestWrapper implements HttpServletRequest {

	
 Constructs a request object wrapping the given request.
 
 Throws:java.lang.IllegalArgumentException if the request is null
84
 
85
     public HttpServletRequestWrapper(HttpServletRequest request) {
86
 	    super(request);
87
     }
88
     
89
     private HttpServletRequest _getHttpServletRequest() {
90
 	return (HttpServletRequest) super.getRequest();
91
     }

    
 The default behavior of this method is to return getAuthType()
 on the wrapped request object.
 
96
 
97
 
98
     public String getAuthType() {
99
 	return this._getHttpServletRequest().getAuthType();
100
    }
   
    
 The default behavior of this method is to return getCookies()
 on the wrapped request object.
 
105
106
    public Cookie[] getCookies() {
107
	return this._getHttpServletRequest().getCookies();
108
    }

    
 The default behavior of this method is to return getDateHeader(String name)
 on the wrapped request object.
 
113
114
    public long getDateHeader(String name) {
115
	return this._getHttpServletRequest().getDateHeader(name);
116
    }
        	
    
 The default behavior of this method is to return getHeader(String name)
 on the wrapped request object.
 
121
122
    public String getHeader(String name) {
123
	return this._getHttpServletRequest().getHeader(name);
124
    }
    
    
 The default behavior of this method is to return getHeaders(String name)
 on the wrapped request object.
 
129
130
    public Enumeration<String> getHeaders(String name) {
131
	return this._getHttpServletRequest().getHeaders(name);
132
    }  

    
 The default behavior of this method is to return getHeaderNames()
 on the wrapped request object.
 
137
138
  
139
    public Enumeration<String> getHeaderNames() {
140
	return this._getHttpServletRequest().getHeaderNames();
141
    }
    
    
 The default behavior of this method is to return
 getIntHeader(String name) on the wrapped request object.
 
146
147
148
     public int getIntHeader(String name) {
149
	return this._getHttpServletRequest().getIntHeader(name);
150
    }
    
    
 The default behavior of this method is to return getMethod()
 on the wrapped request object.
 
155
156
    public String getMethod() {
157
	return this._getHttpServletRequest().getMethod();
158
    }
    
    
 The default behavior of this method is to return getPathInfo()
 on the wrapped request object.
 
163
164
    public String getPathInfo() {
165
	return this._getHttpServletRequest().getPathInfo();
166
    }

    
 The default behavior of this method is to return getPathTranslated()
 on the wrapped request object.
 
171
172
173
     public String getPathTranslated() {
174
	return this._getHttpServletRequest().getPathTranslated();
175
    }

    
 The default behavior of this method is to return getContextPath()
 on the wrapped request object.
 
180
181
    public String getContextPath() {
182
	return this._getHttpServletRequest().getContextPath();
183
    }
    
    
 The default behavior of this method is to return getQueryString()
 on the wrapped request object.
 
188
189
    public String getQueryString() {
190
	return this._getHttpServletRequest().getQueryString();
191
    }
    
    
 The default behavior of this method is to return getRemoteUser()
 on the wrapped request object.
 
196
197
    public String getRemoteUser() {
198
	return this._getHttpServletRequest().getRemoteUser();
199
    }
    
 
    
 The default behavior of this method is to return isUserInRole(String role)
 on the wrapped request object.
 
205
206
    public boolean isUserInRole(String role) {
207
	return this._getHttpServletRequest().isUserInRole(role);
208
    }
    
    
    
    
 The default behavior of this method is to return getUserPrincipal()
 on the wrapped request object.
 
215
216
    public java.security.Principal getUserPrincipal() {
217
	return this._getHttpServletRequest().getUserPrincipal();
218
    }
    
   
    
 The default behavior of this method is to return getRequestedSessionId()
 on the wrapped request object.
 
224
225
    public String getRequestedSessionId() {
226
	return this._getHttpServletRequest().getRequestedSessionId();
227
    }
    
    
 The default behavior of this method is to return getRequestURI()
 on the wrapped request object.
 
232
233
    public String getRequestURI() {
234
	return this._getHttpServletRequest().getRequestURI();
235
    }
	
 The default behavior of this method is to return getRequestURL()
 on the wrapped request object.
 
239
240
    public StringBuffer getRequestURL() {
241
	return this._getHttpServletRequest().getRequestURL();
242
    }
	
    
    
 The default behavior of this method is to return getServletPath()
 on the wrapped request object.
 
248
249
    public String getServletPath() {
250
	return this._getHttpServletRequest().getServletPath();
251
    }
    
    
    
 The default behavior of this method is to return getSession(boolean create)
 on the wrapped request object.
 
257
258
    public HttpSession getSession(boolean create) {
259
	return this._getHttpServletRequest().getSession(create);
260
    }
    
    
 The default behavior of this method is to return getSession()
 on the wrapped request object.
 
265
266
    public HttpSession getSession() {
267
	return this._getHttpServletRequest().getSession();
268
    }
    
    
 The default behavior of this method is to return isRequestedSessionIdValid()
 on the wrapped request object.
 
273
 
274
275
    public boolean isRequestedSessionIdValid() {
276
	return this._getHttpServletRequest().isRequestedSessionIdValid();
277
    }
     
    
    
 The default behavior of this method is to return isRequestedSessionIdFromCookie()
 on the wrapped request object.
 
283
284
    public boolean isRequestedSessionIdFromCookie() {
285
	return this._getHttpServletRequest().isRequestedSessionIdFromCookie();
286
    }
    

    
 The default behavior of this method is to return isRequestedSessionIdFromURL()
 on the wrapped request object.
 
292
 
293
    public boolean isRequestedSessionIdFromURL() {
294
        return this._getHttpServletRequest().isRequestedSessionIdFromURL();
295
    }

    
    
 The default behavior of this method is to return isRequestedSessionIdFromUrl()
 on the wrapped request object.
 
301
302
    public boolean isRequestedSessionIdFromUrl() {
303
	return this._getHttpServletRequest().isRequestedSessionIdFromUrl();
304
    }


    
 The default behavior of this method is to call authenticate on the
 wrapped request object.

 
 Since:Servlet 3.0
312
313
    public boolean authenticate(HttpServletResponse response)
314
            throws IOException, ServletException {
315
        return this._getHttpServletRequest().authenticate(response);
316
    }


    
 The default behavior of this method is to call login on the wrapped
 request object.

 
 Since:Servlet 3.0
324
325
    public void login(String username, String password)
326
            throws ServletException {
327
        this._getHttpServletRequest().login(username,password);
328
    }


    
 The default behavior of this method is to call login on the wrapped
 request object.

 
 Since:Servlet 3.0
336
337
    public void logout() throws ServletException {
338
        this._getHttpServletRequest().logout();
339
    }

    
 The default behavior of this method is to call getParts on the wrapped
 request object.

 Any changes to the returned Collection must not 
 affect this HttpServletRequestWrapper.

 
 Since:Servlet 3.0
349
350
    public Collection<Part> getParts() throws IOException, ServletException {
351
        return this._getHttpServletRequest().getParts(); 
352
    }

    
 The default behavior of this method is to call getPart on the wrapped
 request object.

 
 Since:Servlet 3.0
359
360
    public Part getPart(String name) throws IOException, ServletException {
361
        return this._getHttpServletRequest().getPart(name); 
362
    
363
    }
364
365
}