Package org.apache.wicket.protocol.http.servlet

Class ServletWebRequest

java.lang.Object

org.apache.wicket.request.Request

org.apache.wicket.request.http.WebRequest

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

Direct Known Subclasses:

MultipartServletWebRequest

public class ServletWebRequest
extends WebRequest

WebRequest subclass that wraps a HttpServletRequest object.

Author:

Matej Knopp, Juergen Donnerstag, Igor Vaynberg

Field Summary

Fields inherited from class org.apache.wicket.request.http.WebRequest

HEADER_AJAX, HEADER_AJAX_BASE_URL, HEADER_ORIGIN, HEADER_REFERER, PARAM_AJAX, PARAM_AJAX_BASE_URL, PARAM_AJAX_REQUEST_ANTI_CACHE

Constructor Summary

Constructors

Constructor	Description
ServletWebRequest(jakarta.servlet.http.HttpServletRequest httpServletRequest, String filterPrefix)	Construct.
ServletWebRequest(jakarta.servlet.http.HttpServletRequest httpServletRequest, String filterPrefix, Url url)	Construct.

Method Summary

Modifier and Type	Method	Description
ServletWebRequest	cloneWithUrl(Url url)
protected Map<String,List<StringValue>>	generatePostParameters()
Charset	getCharset()
Url	getClientUrl()	Returns base url without context or filter mapping.
jakarta.servlet.http.HttpServletRequest	getContainerRequest()
String	getContextPath()
List<jakarta.servlet.http.Cookie>	getCookies()
Instant	getDateHeader(String name)
String	getFilterPath()
String	getFilterPrefix()	Returns the prefix of Wicket filter (without the leading /)
String	getHeader(String name)
List<String>	getHeaders(String name)
Locale	getLocale()
IRequestParameters	getPostParameters()
String	getPrefixToContextPath()
Url	getUrl()
MultipartServletWebRequest	newMultipartWebRequest(Bytes maxSize, String upload)	Creates multipart web request from this request.
MultipartServletWebRequest	newMultipartWebRequest(Bytes maxSize, String upload, org.apache.commons.fileupload2.core.FileItemFactory factory)	Creates multipart web request from this request.
boolean	shouldPreserveClientUrl()

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 Details

ServletWebRequest

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

Construct.

Parameters:

httpServletRequest -

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

ServletWebRequest

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

Construct.

Parameters:

httpServletRequest -

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

url -

Method Details

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

Specified by:

getClientUrl in class Request

See Also:

• Request.getClientUrl()

getFilterPrefix

public String getFilterPrefix()

Returns the prefix of Wicket filter (without the leading /)

Returns:

Wicket filter prefix

getCookies

public List<jakarta.servlet.http.Cookie> getCookies()

Specified by:

getCookies in class WebRequest

getLocale

public Locale getLocale()

Specified by:

getLocale in class Request

getDateHeader

public Instant getDateHeader(String name)

Specified by:

getDateHeader in class WebRequest

getHeader

public String getHeader(String name)

Specified by:

getHeader in class WebRequest

getHeaders

public List<String> getHeaders(String name)

Specified by:

getHeaders in class WebRequest

generatePostParameters

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

getPostParameters

public IRequestParameters getPostParameters()

Overrides:

getPostParameters in class Request

getUrl

public Url getUrl()

Specified by:

getUrl in class Request

cloneWithUrl

public ServletWebRequest cloneWithUrl(Url url)

Overrides:

cloneWithUrl in class WebRequest

newMultipartWebRequest

public MultipartServletWebRequest newMultipartWebRequest(Bytes maxSize,
 String upload)
                                                  throws org.apache.commons.fileupload2.core.FileUploadException

Creates multipart web request from this request.

Parameters:

maxSize - max allowed size of request

upload - upload identifier for UploadInfo

Returns:

multipart request

Throws:

org.apache.commons.fileupload2.core.FileUploadException

newMultipartWebRequest

public MultipartServletWebRequest newMultipartWebRequest(Bytes maxSize,
 String upload,
 org.apache.commons.fileupload2.core.FileItemFactory factory)
                                                  throws org.apache.commons.fileupload2.core.FileUploadException

Creates multipart web request from this request.

Parameters:

maxSize - max allowed size of request

upload - upload identifier for UploadInfo

factory -

Returns:

multipart request

Throws:

org.apache.commons.fileupload2.core.FileUploadException

getPrefixToContextPath

public String getPrefixToContextPath()

Overrides:

getPrefixToContextPath in class Request

getCharset

public Charset getCharset()

Specified by:

getCharset in class Request

getContainerRequest

public jakarta.servlet.http.HttpServletRequest getContainerRequest()

Specified by:

getContainerRequest in class Request

getContextPath

public String getContextPath()

Overrides:

getContextPath in class Request

getFilterPath

public String getFilterPath()

Overrides:

getFilterPath in class Request

shouldPreserveClientUrl

public boolean shouldPreserveClientUrl()

Overrides:

shouldPreserveClientUrl in class WebRequest