Class HttpServletRequestProxy

  • All Implemented Interfaces:
    jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest

    public abstract class HttpServletRequestProxy
    extends java.lang.Object
    implements jakarta.servlet.http.HttpServletRequest
    Deprecated.
    since WAS V6.0 Use the HttpServletRequestWrapper class instead. Proxies function invocations to an underlying HttpServletRequest. Subclasses of this class can be created that overload or enhance the functionality of a server-provided HttpServletRequest.

    Using the proxied request:

    1. Subclass this class and overload any desired functions.
    2. During the servlet's service method, create an instance of the enhanced request using the original request from the server as the proxied request.
    3. Forward the enhanced request to another servlet for processing instead of the original request that was provided by the server.

    Sample subclass (overloads the request's InputStream)

     
     // This enhanced request will force the request to be a POST request.
     // This request POST data input will be read from a specified file.
     public class PostedFileRequest extends HttpServletRequestProxy{
        private HttpServletRequest _request;
        private File _file;
        public PostedFileRequest(File f, HttpServletRequest req){
          _file =f;
           _request = req;
        }
        protected HttpServletRequest getProxiedHttpServletRequest(){
           return _request;
        }
        //overload request functionality
        public ServletInputStream getInputStream() throws IOException{
           return new ServletInputStreamAdapter(new FileInputStream(_file));
        }
        public BufferedReader getReader() throws IOException{
           return new BufferedReader(getInputStream());
        }
        public String getMethod(){
           //force the HTTP method to be POST.
           return "POST";
        }
     }
     

    Using the enhanced request subclass transparently in a servlet

     //This servlet posts a data file as a request to another servlet.
     public class PostGeneratorServlet extends HttpServlet{
        public void service HttpServletRequest req, HttpServletResponse resp){
           req = new PostedFileRequest(req, new File(request.getPathTranslated()));
           //forward the enhanced request to be used transparently by another servlet.
           getServletContext().getRequestDispatcher("/postHandlerServlet").forward(req, resp);
        }
     }
     
    • Constructor Detail

      • HttpServletRequestProxy

        public HttpServletRequestProxy()
        Deprecated.
    • Method Detail

      • getAuthType

        public java.lang.String getAuthType()
        Deprecated.
        Specified by:
        getAuthType in interface jakarta.servlet.http.HttpServletRequest
      • getCookies

        public jakarta.servlet.http.Cookie[] getCookies()
        Deprecated.
        Specified by:
        getCookies in interface jakarta.servlet.http.HttpServletRequest
      • getIntHeader

        public int getIntHeader​(java.lang.String name)
        Deprecated.
        Specified by:
        getIntHeader in interface jakarta.servlet.http.HttpServletRequest
      • getDateHeader

        public long getDateHeader​(java.lang.String name)
        Deprecated.
        Specified by:
        getDateHeader in interface jakarta.servlet.http.HttpServletRequest
      • getHeader

        public java.lang.String getHeader​(java.lang.String name)
        Deprecated.
        Specified by:
        getHeader in interface jakarta.servlet.http.HttpServletRequest
      • getHeaderNames

        public java.util.Enumeration getHeaderNames()
        Deprecated.
        Specified by:
        getHeaderNames in interface jakarta.servlet.http.HttpServletRequest
      • getQueryString

        public java.lang.String getQueryString()
        Deprecated.
        Specified by:
        getQueryString in interface jakarta.servlet.http.HttpServletRequest
      • getMethod

        public java.lang.String getMethod()
        Deprecated.
        Specified by:
        getMethod in interface jakarta.servlet.http.HttpServletRequest
      • getPathInfo

        public java.lang.String getPathInfo()
        Deprecated.
        Specified by:
        getPathInfo in interface jakarta.servlet.http.HttpServletRequest
      • getPathTranslated

        public java.lang.String getPathTranslated()
        Deprecated.
        Specified by:
        getPathTranslated in interface jakarta.servlet.http.HttpServletRequest
      • getServletPath

        public java.lang.String getServletPath()
        Deprecated.
        Specified by:
        getServletPath in interface jakarta.servlet.http.HttpServletRequest
      • getRemoteUser

        public java.lang.String getRemoteUser()
        Deprecated.
        Specified by:
        getRemoteUser in interface jakarta.servlet.http.HttpServletRequest
      • getRequestedSessionId

        public java.lang.String getRequestedSessionId()
        Deprecated.
        Specified by:
        getRequestedSessionId in interface jakarta.servlet.http.HttpServletRequest
      • getRequestURI

        public java.lang.String getRequestURI()
        Deprecated.
        Specified by:
        getRequestURI in interface jakarta.servlet.http.HttpServletRequest
      • isRequestedSessionIdFromCookie

        public boolean isRequestedSessionIdFromCookie()
        Deprecated.
        Specified by:
        isRequestedSessionIdFromCookie in interface jakarta.servlet.http.HttpServletRequest
      • getSession

        public jakarta.servlet.http.HttpSession getSession​(boolean create)
        Deprecated.
        Specified by:
        getSession in interface jakarta.servlet.http.HttpServletRequest
      • getSession

        public jakarta.servlet.http.HttpSession getSession()
        Deprecated.
        Specified by:
        getSession in interface jakarta.servlet.http.HttpServletRequest
      • isRequestedSessionIdValid

        public boolean isRequestedSessionIdValid()
        Deprecated.
        Specified by:
        isRequestedSessionIdValid in interface jakarta.servlet.http.HttpServletRequest
      • isRequestedSessionIdFromURL

        public boolean isRequestedSessionIdFromURL()
        Deprecated.
        Specified by:
        isRequestedSessionIdFromURL in interface jakarta.servlet.http.HttpServletRequest
      • isRequestedSessionIdFromUrl

        public boolean isRequestedSessionIdFromUrl()
        Deprecated.
        Specified by:
        isRequestedSessionIdFromUrl in interface jakarta.servlet.http.HttpServletRequest
      • getHeaders

        public java.util.Enumeration getHeaders​(java.lang.String name)
        Deprecated.
        Specified by:
        getHeaders in interface jakarta.servlet.http.HttpServletRequest
      • getContextPath

        public java.lang.String getContextPath()
        Deprecated.
        Specified by:
        getContextPath in interface jakarta.servlet.http.HttpServletRequest
      • isUserInRole

        public boolean isUserInRole​(java.lang.String role)
        Deprecated.
        Specified by:
        isUserInRole in interface jakarta.servlet.http.HttpServletRequest
      • getUserPrincipal

        public java.security.Principal getUserPrincipal()
        Deprecated.
        Specified by:
        getUserPrincipal in interface jakarta.servlet.http.HttpServletRequest
      • getRequestURL

        public java.lang.StringBuffer getRequestURL()
        Deprecated.
        Specified by:
        getRequestURL in interface jakarta.servlet.http.HttpServletRequest
      • getAttribute

        public java.lang.Object getAttribute​(java.lang.String name)
        Deprecated.
        Specified by:
        getAttribute in interface jakarta.servlet.ServletRequest
      • getAttributeNames

        public java.util.Enumeration getAttributeNames()
        Deprecated.
        Specified by:
        getAttributeNames in interface jakarta.servlet.ServletRequest
      • getInputStream

        public jakarta.servlet.ServletInputStream getInputStream()
                                                        throws java.io.IOException
        Deprecated.
        Specified by:
        getInputStream in interface jakarta.servlet.ServletRequest
        Throws:
        java.io.IOException
      • getCharacterEncoding

        public java.lang.String getCharacterEncoding()
        Deprecated.
        Specified by:
        getCharacterEncoding in interface jakarta.servlet.ServletRequest
      • getContentLength

        public int getContentLength()
        Deprecated.
        Specified by:
        getContentLength in interface jakarta.servlet.ServletRequest
      • getContentType

        public java.lang.String getContentType()
        Deprecated.
        Specified by:
        getContentType in interface jakarta.servlet.ServletRequest
      • getProtocol

        public java.lang.String getProtocol()
        Deprecated.
        Specified by:
        getProtocol in interface jakarta.servlet.ServletRequest
      • getParameter

        public java.lang.String getParameter​(java.lang.String name)
        Deprecated.
        Specified by:
        getParameter in interface jakarta.servlet.ServletRequest
      • getParameterNames

        public java.util.Enumeration getParameterNames()
        Deprecated.
        Specified by:
        getParameterNames in interface jakarta.servlet.ServletRequest
      • getParameterValues

        public java.lang.String[] getParameterValues​(java.lang.String name)
        Deprecated.
        Specified by:
        getParameterValues in interface jakarta.servlet.ServletRequest
      • getScheme

        public java.lang.String getScheme()
        Deprecated.
        Specified by:
        getScheme in interface jakarta.servlet.ServletRequest
      • getServerName

        public java.lang.String getServerName()
        Deprecated.
        Specified by:
        getServerName in interface jakarta.servlet.ServletRequest
      • getServerPort

        public int getServerPort()
        Deprecated.
        Specified by:
        getServerPort in interface jakarta.servlet.ServletRequest
      • getRealPath

        public java.lang.String getRealPath​(java.lang.String path)
        Deprecated.
        Specified by:
        getRealPath in interface jakarta.servlet.ServletRequest
      • getReader

        public java.io.BufferedReader getReader()
                                         throws java.io.IOException
        Deprecated.
        Specified by:
        getReader in interface jakarta.servlet.ServletRequest
        Throws:
        java.io.IOException
      • getRemoteAddr

        public java.lang.String getRemoteAddr()
        Deprecated.
        Specified by:
        getRemoteAddr in interface jakarta.servlet.ServletRequest
      • getRemoteHost

        public java.lang.String getRemoteHost()
        Deprecated.
        Specified by:
        getRemoteHost in interface jakarta.servlet.ServletRequest
      • setAttribute

        public void setAttribute​(java.lang.String key,
                                 java.lang.Object o)
        Deprecated.
        Specified by:
        setAttribute in interface jakarta.servlet.ServletRequest
      • removeAttribute

        public void removeAttribute​(java.lang.String name)
        Deprecated.
        Specified by:
        removeAttribute in interface jakarta.servlet.ServletRequest
      • getLocale

        public java.util.Locale getLocale()
        Deprecated.
        Specified by:
        getLocale in interface jakarta.servlet.ServletRequest
      • getLocales

        public java.util.Enumeration getLocales()
        Deprecated.
        Specified by:
        getLocales in interface jakarta.servlet.ServletRequest
      • isSecure

        public boolean isSecure()
        Deprecated.
        Specified by:
        isSecure in interface jakarta.servlet.ServletRequest
      • getRequestDispatcher

        public jakarta.servlet.RequestDispatcher getRequestDispatcher​(java.lang.String path)
        Deprecated.
        Specified by:
        getRequestDispatcher in interface jakarta.servlet.ServletRequest
      • getRequest

        public jakarta.servlet.ServletRequest getRequest()
        Deprecated.
      • getParameterMap

        public java.util.Map getParameterMap()
        Deprecated.
        Specified by:
        getParameterMap in interface jakarta.servlet.ServletRequest
      • setCharacterEncoding

        public void setCharacterEncoding​(java.lang.String encoding)
                                  throws java.io.UnsupportedEncodingException
        Deprecated.
        Specified by:
        setCharacterEncoding in interface jakarta.servlet.ServletRequest
        Throws:
        java.io.UnsupportedEncodingException