Package org.apache.wicket.request.http
Class WebRequest
- java.lang.Object
-
- org.apache.wicket.request.Request
-
- org.apache.wicket.request.http.WebRequest
-
- Direct Known Subclasses:
MockWebRequest
,ServletWebRequest
public abstract class WebRequest extends Request
Base class for request that provides additional web-related information.- Author:
- Matej Knopp, Igor Vaynberg
-
-
Field Summary
Fields Modifier and Type Field Description static String
HEADER_AJAX
marker for Ajax requestsstatic String
HEADER_AJAX_BASE_URL
marker for Ajax-relative urlstatic String
HEADER_ORIGIN
Origin
http headerstatic String
HEADER_REFERER
Referer
http headerstatic String
PARAM_AJAX
marker for Ajax requestsstatic String
PARAM_AJAX_BASE_URL
marker for Ajax-relative urlstatic String
PARAM_AJAX_REQUEST_ANTI_CACHE
anti-cache query parameter added by Wicket.Ajax.Request at its URL
-
Constructor Summary
Constructors Constructor Description WebRequest()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description WebRequest
cloneWithUrl(Url url)
Returns request with specified URL and same POST parameters as this request.javax.servlet.http.Cookie
getCookie(String cookieName)
abstract List<javax.servlet.http.Cookie>
getCookies()
abstract Instant
getDateHeader(String name)
Returns the value of the specified request header as along
value that represents aDate
object.abstract String
getHeader(String name)
Returns the value of the specified request header as aString
abstract List<String>
getHeaders(String name)
Returns all the values of the specified request header.Instant
getIfModifiedSinceHeader()
Convenience method for retrieving If-Modified-Since header.boolean
isAjax()
Returns whether this request is an Ajax request.boolean
shouldPreserveClientUrl()
Signals whether or not request processing should preserve the current client url - in other words, handle this request without redirecting.-
Methods inherited from class org.apache.wicket.request.Request
getCharset, getClientUrl, getContainerRequest, getContextPath, getFilterPath, getLocale, getOriginalUrl, getPostParameters, getPrefixToContextPath, getQueryParameters, getRequestParameters, getUrl
-
-
-
-
Field Detail
-
PARAM_AJAX
public static final String PARAM_AJAX
marker for Ajax requests- See Also:
- Constant Field Values
-
HEADER_AJAX
public static final String HEADER_AJAX
marker for Ajax requests- See Also:
- Constant Field Values
-
PARAM_AJAX_BASE_URL
public static final String PARAM_AJAX_BASE_URL
marker for Ajax-relative url- See Also:
- Constant Field Values
-
HEADER_AJAX_BASE_URL
public static final String HEADER_AJAX_BASE_URL
marker for Ajax-relative url- See Also:
- Constant Field Values
-
PARAM_AJAX_REQUEST_ANTI_CACHE
public static final String PARAM_AJAX_REQUEST_ANTI_CACHE
anti-cache query parameter added by Wicket.Ajax.Request at its URL- See Also:
- Constant Field Values
-
HEADER_ORIGIN
public static final String HEADER_ORIGIN
Origin
http header- See Also:
- Constant Field Values
-
HEADER_REFERER
public static final String HEADER_REFERER
Referer
http header- See Also:
- Constant Field Values
-
-
Constructor Detail
-
WebRequest
public WebRequest()
-
-
Method Detail
-
getCookies
public abstract List<javax.servlet.http.Cookie> getCookies()
- Returns:
- request cookies
-
getCookie
public javax.servlet.http.Cookie getCookie(String cookieName)
- Parameters:
cookieName
-- Returns:
- cookie with specified name or
null
if the cookie does not exist
-
getHeaders
public abstract List<String> getHeaders(String name)
Returns all the values of the specified request header.- Parameters:
name
-- Returns:
- unmodifiable list of header values
-
getHeader
public abstract String getHeader(String name)
Returns the value of the specified request header as aString
- Parameters:
name
-- Returns:
- string value of request header
-
getDateHeader
public abstract Instant getDateHeader(String name)
Returns the value of the specified request header as along
value that represents aDate
object. Use this method with headers that contain dates, such asIf-Modified-Since
.- Parameters:
name
-- Returns:
- date value of request header or
null
if not found
-
getIfModifiedSinceHeader
public final Instant getIfModifiedSinceHeader()
Convenience method for retrieving If-Modified-Since header.- Returns:
- date representing the header or
null
if not set
-
isAjax
public boolean isAjax()
Returns whether this request is an Ajax request. This implementation checks for values of "wicket-ajax" url parameter or the "Wicket-Ajax" header. Subclasses can use other approaches.- Returns:
true
if this request is an ajax request,false
otherwise.
-
shouldPreserveClientUrl
public boolean shouldPreserveClientUrl()
Signals whether or not request processing should preserve the current client url - in other words, handle this request without redirecting. By default, this method returnsfalse
. For example, this method can be used to preserve the url that caused a 404 in the browser if Wicket is also responsible for rendering the 404 page. If this method returns the default value offalse
then Wicket will redirect to the bookmarkable url of the error page, instead of preserving the url that caused the 404 in the browser.- Returns:
true
if current client url should be preserved
-
cloneWithUrl
public WebRequest cloneWithUrl(Url url)
Returns request with specified URL and same POST parameters as this request.- Overrides:
cloneWithUrl
in classRequest
- Parameters:
url
- Url instance- Returns:
- request with specified URL.
-
-