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

Class ServletWebRequest

  • Direct Known Subclasses:
    MultipartServletWebRequest
    public class ServletWebRequest
extends org.apache.wicket.request.http.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​(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String filterPrefix)
      Construct.
      ServletWebRequest​(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String filterPrefix, org.apache.wicket.request.Url url)
      Construct.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ServletWebRequest cloneWithUrl​(org.apache.wicket.request.Url url)  
      protected java.util.Map<java.lang.String,​java.util.List<org.apache.wicket.util.string.StringValue>> generatePostParameters()  
      java.nio.charset.Charset getCharset()  
      org.apache.wicket.request.Url getClientUrl()
      Returns base url without context or filter mapping.
      javax.servlet.http.HttpServletRequest getContainerRequest()  
      java.lang.String getContextPath()  
      java.util.List<javax.servlet.http.Cookie> getCookies()  
      org.apache.wicket.util.time.Time getDateHeader​(java.lang.String name)  
      java.lang.String getFilterPath()  
      java.lang.String getFilterPrefix()
      Returns the prefix of Wicket filter (without the leading /)
      java.lang.String getHeader​(java.lang.String name)  
      java.util.List<java.lang.String> getHeaders​(java.lang.String name)  
      java.util.Locale getLocale()  
      org.apache.wicket.request.IRequestParameters getPostParameters()  
      java.lang.String getPrefixToContextPath()  
      org.apache.wicket.request.Url getUrl()  
      MultipartServletWebRequest newMultipartWebRequest​(org.apache.wicket.util.lang.Bytes maxSize, java.lang.String upload)
      Creates multipart web request from this request.
      MultipartServletWebRequest newMultipartWebRequest​(org.apache.wicket.util.lang.Bytes maxSize, java.lang.String upload, org.apache.commons.fileupload.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 Detail

      • ServletWebRequest

        public ServletWebRequest​(javax.servlet.http.HttpServletRequest httpServletRequest,
                         java.lang.String filterPrefix)
        Construct.
        Parameters:
        httpServletRequest -
        filterPrefix - contentPath + filterPath, used to extract the actual Url

      • ServletWebRequest

        public ServletWebRequest​(javax.servlet.http.HttpServletRequest httpServletRequest,
                         java.lang.String filterPrefix,
                         org.apache.wicket.request.Url url)
        Construct.
        Parameters:
        httpServletRequest -
        filterPrefix - contentPath + filterPath, used to extract the actual Url
        url -

    • Method Detail

      • getClientUrl

        public org.apache.wicket.request.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 org.apache.wicket.request.Request
        See Also:
        Request.getClientUrl()

      • getFilterPrefix

        public java.lang.String getFilterPrefix()
        Returns the prefix of Wicket filter (without the leading /)
        Returns:
        Wicket filter prefix

      • getCookies

        public java.util.List<javax.servlet.http.Cookie> getCookies()
        Specified by:
        getCookies in class org.apache.wicket.request.http.WebRequest

      • getLocale

        public java.util.Locale getLocale()
        Specified by:
        getLocale in class org.apache.wicket.request.Request

      • getDateHeader

        public org.apache.wicket.util.time.Time getDateHeader​(java.lang.String name)
        Specified by:
        getDateHeader in class org.apache.wicket.request.http.WebRequest

      • getHeader

        public java.lang.String getHeader​(java.lang.String name)
        Specified by:
        getHeader in class org.apache.wicket.request.http.WebRequest

      • getHeaders

        public java.util.List<java.lang.String> getHeaders​(java.lang.String name)
        Specified by:
        getHeaders in class org.apache.wicket.request.http.WebRequest

      • generatePostParameters

        protected java.util.Map<java.lang.String,​java.util.List<org.apache.wicket.util.string.StringValue>> generatePostParameters()

      • getPostParameters

        public org.apache.wicket.request.IRequestParameters getPostParameters()
        Overrides:
        getPostParameters in class org.apache.wicket.request.Request

      • getUrl

        public org.apache.wicket.request.Url getUrl()
        Specified by:
        getUrl in class org.apache.wicket.request.Request

      • cloneWithUrl

        public ServletWebRequest cloneWithUrl​(org.apache.wicket.request.Url url)
        Overrides:
        cloneWithUrl in class org.apache.wicket.request.http.WebRequest

      • newMultipartWebRequest

        public MultipartServletWebRequest newMultipartWebRequest​(org.apache.wicket.util.lang.Bytes maxSize,
                                                         java.lang.String upload)
                                                  throws org.apache.commons.fileupload.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.fileupload.FileUploadException

      • newMultipartWebRequest

        public MultipartServletWebRequest newMultipartWebRequest​(org.apache.wicket.util.lang.Bytes maxSize,
                                                         java.lang.String upload,
                                                         org.apache.commons.fileupload.FileItemFactory factory)
                                                  throws org.apache.commons.fileupload.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.fileupload.FileUploadException

      • getPrefixToContextPath

        public java.lang.String getPrefixToContextPath()
        Overrides:
        getPrefixToContextPath in class org.apache.wicket.request.Request

      • getCharset

        public java.nio.charset.Charset getCharset()
        Specified by:
        getCharset in class org.apache.wicket.request.Request

      • getContainerRequest

        public javax.servlet.http.HttpServletRequest getContainerRequest()
        Specified by:
        getContainerRequest in class org.apache.wicket.request.Request

      • getContextPath

        public java.lang.String getContextPath()
        Overrides:
        getContextPath in class org.apache.wicket.request.Request

      • getFilterPath

        public java.lang.String getFilterPath()
        Overrides:
        getFilterPath in class org.apache.wicket.request.Request

      • shouldPreserveClientUrl

        public boolean shouldPreserveClientUrl()
        Overrides:
        shouldPreserveClientUrl in class org.apache.wicket.request.http.WebRequest