org.apache.wicket.request.http
Class WebRequest

java.lang.Object
  extended by org.apache.wicket.request.Request
      extended by 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

Constructor Summary
WebRequest()
           
 
Method Summary
 javax.servlet.http.Cookie getCookie(java.lang.String cookieName)
           
abstract  java.util.List<javax.servlet.http.Cookie> getCookies()
           
abstract  long getDateHeader(java.lang.String name)
          Returns the value of the specified request header as a long value that represents a Date object.
abstract  java.lang.String getHeader(java.lang.String name)
          Returns the value of the specified request header as a String
abstract  java.util.List<java.lang.String> getHeaders(java.lang.String name)
          Returns all the values of the specified request header.
 java.util.Date getIfModifiedSinceHeader()
          Convenience method for retrieving If-Modified-Since header.
 boolean isAjax()
          Returns whether this request is an Ajax request.
 WebRequest requestWithUrl(Url url)
          Returns request with specified URL and same POST parameters as this request.
 
Methods inherited from class org.apache.wicket.request.Request
getCharset, getLocale, getOriginalUrl, getPostParameters, getPrefixToContextPath, getQueryParameters, getRequestParameters, getUrl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebRequest

public WebRequest()
Method Detail

getCookies

public abstract java.util.List<javax.servlet.http.Cookie> getCookies()
Returns:
request cookies

getCookie

public javax.servlet.http.Cookie getCookie(java.lang.String cookieName)
Parameters:
cookieName -
Returns:
cookie with specified name or null if the cookie does not exist

getHeaders

public abstract java.util.List<java.lang.String> getHeaders(java.lang.String name)
Returns all the values of the specified request header.

Parameters:
name -
Returns:
unmodifiable list of header values

getHeader

public abstract java.lang.String getHeader(java.lang.String name)
Returns the value of the specified request header as a String

Parameters:
name -
Returns:
string value of request header

getDateHeader

public abstract long getDateHeader(java.lang.String name)
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.

Parameters:
name -
Returns:
date value of request header

getIfModifiedSinceHeader

public final java.util.Date 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 only checks for value of wicket:ajax url parameter. Subclasses can use other approach.

Returns:
true if this request is an ajax request, false otherwise.

requestWithUrl

public WebRequest requestWithUrl(Url url)
Returns request with specified URL and same POST parameters as this request.

Overrides:
requestWithUrl in class Request
Parameters:
url - Url instance
Returns:
request with specified URL.


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