org.apache.wicket.protocol.http.servlet
Class ServletWebRequest

java.lang.Object
  extended by org.apache.wicket.request.Request
      extended by org.apache.wicket.request.http.WebRequest
          extended by org.apache.wicket.protocol.http.servlet.ServletWebRequest
Direct Known Subclasses:
MultipartServletWebRequest, UploadWebRequest

public class ServletWebRequest
extends WebRequest

WebRequest subclass that wraps a HttpServletRequest object.

Author:
Matej Knopp

Field Summary
 
Fields inherited from class org.apache.wicket.request.http.WebRequest
HEADER_AJAX, HEADER_AJAX_BASE_URL, PARAM_AJAX, PARAM_AJAX_BASE_URL
 
Constructor Summary
ServletWebRequest(javax.servlet.http.HttpServletRequest httpServletRequest, String filterPrefix)
          Construct.
ServletWebRequest(javax.servlet.http.HttpServletRequest httpServletRequest, String filterPrefix, Url url)
          Construct.
 
Method Summary
 ServletWebRequest cloneWithUrl(Url url)
          Returns request with specified URL and same POST parameters as this request.
protected  Map<String,List<StringValue>> generatePostParameters()
           
 Charset getCharset()
           
 Url getClientUrl()
          Returns base url without context or filter mapping.
 List<javax.servlet.http.Cookie> getCookies()
           
 long getDateHeader(String name)
          Returns the value of the specified request header as a long value that represents a Date object.
 String getFilterPrefix()
          Returns the prefix of Wicket filter (without the leading /)
 String getHeader(String name)
          Returns the value of the specified request header as a String
 List<String> getHeaders(String name)
          Returns all the values of the specified request header.
 javax.servlet.http.HttpServletRequest getHttpServletRequest()
          Returns the wrapped HttpServletRequest instance.
 Locale getLocale()
          Returns locale for this request.
 IRequestParameters getPostParameters()
           
 String getPrefixToContextPath()
          Returns prefix from Wicket Filter mapping to context path.
 Url getUrl()
          Returns the URL for this request.
 MultipartServletWebRequest newMultipartWebRequest(Bytes maxSize)
          Creates multipart web request from this request.
 MultipartServletWebRequest newMultipartWebRequest(Bytes maxSize, FileItemFactory factory)
          Creates multipart web request from this request.
 
Methods inherited from class org.apache.wicket.request.http.WebRequest
getCookie, getIfModifiedSinceHeader, isAjax
 
Methods inherited from class org.apache.wicket.request.Request
getOriginalUrl, getQueryParameters, getRequestParameters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServletWebRequest

public ServletWebRequest(javax.servlet.http.HttpServletRequest httpServletRequest,
                         String filterPrefix)
Construct.

Parameters:
httpServletRequest -
filterPrefix - contentPath + filterPath, used to extract the actual Url

ServletWebRequest

public ServletWebRequest(javax.servlet.http.HttpServletRequest httpServletRequest,
                         String filterPrefix,
                         Url url)
Construct.

Parameters:
httpServletRequest -
filterPrefix - contentPath + filterPath, used to extract the actual Url
url -
Method Detail

getClientUrl

public Url getClientUrl()
Returns base url without context or filter mapping. Example: if current url is
 http://localhost:8080/context/filter/mapping/wicket/bookmarkable/com.foo.Page?1&id=2
 
the base url is wicket/bookmarkable/com.foo.Page
 wicket / bookmarkab

Specified by:
getClientUrl in class Request
Returns:
client url
See Also:
Request.getClientUrl()

getFilterPrefix

public String getFilterPrefix()
Returns the prefix of Wicket filter (without the leading /)

Returns:
Wicket filter prefix

getHttpServletRequest

public final javax.servlet.http.HttpServletRequest getHttpServletRequest()
Returns the wrapped HttpServletRequest instance.

Returns:
HttpServletRequest instance.

getCookies

public List<javax.servlet.http.Cookie> getCookies()
Specified by:
getCookies in class WebRequest
Returns:
request cookies

getLocale

public Locale getLocale()
Description copied from class: Request
Returns locale for this request.

Specified by:
getLocale in class Request
Returns:
locale

getDateHeader

public long getDateHeader(String name)
Description copied from class: WebRequest
Returns the value of the specified request header as a long value that represents a Date object. Use this method with headers that contain dates, such as If-Modified-Since.

Specified by:
getDateHeader in class WebRequest
Returns:
date value of request header

getHeader

public String getHeader(String name)
Description copied from class: WebRequest
Returns the value of the specified request header as a String

Specified by:
getHeader in class WebRequest
Returns:
string value of request header

getHeaders

public List<String> getHeaders(String name)
Description copied from class: WebRequest
Returns all the values of the specified request header.

Specified by:
getHeaders in class WebRequest
Returns:
unmodifiable list of header values

generatePostParameters

protected Map<String,List<StringValue>> generatePostParameters()

getPostParameters

public IRequestParameters getPostParameters()
Overrides:
getPostParameters in class Request
Returns:
POST request parameters for this request.

getUrl

public Url getUrl()
Description copied from class: Request
Returns the URL for this request. URL is relative to Wicket filter path.

Specified by:
getUrl in class Request
Returns:
Url instance

cloneWithUrl

public ServletWebRequest cloneWithUrl(Url url)
Description copied from class: WebRequest
Returns request with specified URL and same POST parameters as this request.

Overrides:
cloneWithUrl in class WebRequest
Parameters:
url - Url instance
Returns:
request with specified URL.

newMultipartWebRequest

public MultipartServletWebRequest newMultipartWebRequest(Bytes maxSize)
                                                  throws FileUploadException
Creates multipart web request from this request.

Parameters:
maxSize -
Returns:
multipart request
Throws:
FileUploadException

newMultipartWebRequest

public MultipartServletWebRequest newMultipartWebRequest(Bytes maxSize,
                                                         FileItemFactory factory)
                                                  throws FileUploadException
Creates multipart web request from this request.

Parameters:
maxSize -
factory -
Returns:
multipart request
Throws:
FileUploadException

getPrefixToContextPath

public String getPrefixToContextPath()
Description copied from class: Request
Returns prefix from Wicket Filter mapping to context path. This method does not take the actual URL into account.

For example if Wicket filter is mapped to hello/* this method should return ../ regardless of actual URL (after Wicket filter)

Overrides:
getPrefixToContextPath in class Request
Returns:
prefix to context path for this request.

getCharset

public Charset getCharset()
Specified by:
getCharset in class Request


Copyright © 2004-2010 Apache Software Foundation. All Rights Reserved.