com.ibm.websphere.servlet.request

Interface IRequest



  • public interface IRequest
    Interface that the webcontainer recognizes as the types of requests that it can handle. The webcontainer will call the methods on this interface during request processing.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void clearHeaders()
      Requests the implementation to clear its headers datastructure.
      java.util.List getAllCookieValues(java.lang.String cookieName)
      Get the values for the cookie specified.
      java.lang.String getAuthType()
      Returns the authorization Type of the current request
      java.lang.String getCipherSuite()
      Returns the cipherSuite
      int getContentLength()
      Method for getting the Content Length of the Request
      long getContentLengthLong()
      Method for getting the Content Length of the Request
      java.lang.String getContentType()
      Method for getting the Content Type of the Request
      javax.servlet.http.Cookie[] getCookies()
      Get all the cookies for the request.
      byte[] getCookieValue(java.lang.String cookieName)
      Get the value for the cookie specified.
      long getDateHeader(java.lang.String name)
      Returns the header value in long date format
      java.lang.String getHeader(java.lang.String headerName)
      Returns the value for the specified header requested
      java.util.Enumeration getHeaderNames()
      Get all client header field names.
      java.util.Enumeration getHeaders(java.lang.String headerName)
      Returns all values for the specified header requested
      java.io.InputStream getInputStream()
      Returns the input stream for this request
      int getIntHeader(java.lang.String name)
      Returns the header value as an int
      java.lang.String getLocalAddr()
      Returns the local address
      java.lang.String getLocalName()
      Returns the local name
      int getLocalPort()
      Returns the local port
      java.lang.String getMethod()
      Returns the method of the request
      java.security.cert.X509Certificate[] getPeerCertificates()
      Returns the array of client certificates
      java.lang.String getProtocol()
      Returns the protocol that the remote agent is speaking
      java.lang.String getQueryString()
      Get the query string of the request.
      java.lang.String getRemoteAddr()
      Returns the IP address of the remote agent, or null if not known
      java.lang.String getRemoteHost()
      Returns the host name of the remote agent, or null if not known
      int getRemotePort()
      Returns the port used by the remote agent, or null if not known
      java.lang.String getRemoteUser()
      Returns the remote user for the request
      java.lang.String getRequestURI()
      Returns the URI of the request
      java.lang.String getScheme()
      Method that returns the scheme of the request
      java.lang.String getServerName()
      Returns the Server hostname
      int getServerPort()
      Returns the port of this connection
      java.lang.String getSessionID()
      Get the session id for this request
      boolean getShouldDestroy() 
      byte[] getSSLSessionID()
      Get at SSL Session ID
      com.ibm.ws.util.ThreadPool getThreadPool() 
      IResponse getWCCResponse()
      Returns the webcontainer channel response object for this request
      boolean isProxied()
      Returns whether the request was sent from the plugin
      boolean isSSL()
      Method to determine if the request is running on an SSL Connection
      boolean isStartAsync() 
      void lock() 
      void removeHeader(java.lang.String headerName) 
      void setShouldClose(boolean b) 
      void setShouldDestroy(boolean shouldDestroy) 
      void setShouldReuse(boolean b) 
      void startAsync() 
      void unlock() 
    • Method Detail

      • getMethod

        java.lang.String getMethod()
        Returns the method of the request
        Returns:
        String the method of the request
      • getRequestURI

        java.lang.String getRequestURI()
        Returns the URI of the request
        Returns:
        String the URI of the request
      • getRemoteUser

        java.lang.String getRemoteUser()
        Returns the remote user for the request
        Returns:
        String the remote user of the request
      • getAuthType

        java.lang.String getAuthType()
        Returns the authorization Type of the current request
        Returns:
        String the authorization type of the request
      • getHeader

        java.lang.String getHeader(java.lang.String headerName)
        Returns the value for the specified header requested
        Returns:
        String the given header value
      • getHeaders

        java.util.Enumeration getHeaders(java.lang.String headerName)
        Returns all values for the specified header requested
        Returns:
        Enumeration the given header value
      • getDateHeader

        long getDateHeader(java.lang.String name)
        Returns the header value in long date format
        Parameters:
        name -
        Returns:
        date header value in date format
      • getIntHeader

        int getIntHeader(java.lang.String name)
        Returns the header value as an int
        Parameters:
        name -
        Returns:
        Header value as an int
      • clearHeaders

        void clearHeaders()
        Requests the implementation to clear its headers datastructure. This allows for optimization, as the webcontainer will hold on to the reference to this request object upon finishing of the request processing, to prevent new request object creation for every new request.
      • getHeaderNames

        java.util.Enumeration getHeaderNames()
        Get all client header field names.
        Returns:
        the names of all header fields sent by the client
      • getContentLength

        int getContentLength()
        Method for getting the Content Length of the Request
        Returns:
        int the length of data in the request
      • getContentLengthLong

        long getContentLengthLong()
        Method for getting the Content Length of the Request
        Returns:
        long the length of data in the request. Added for Servlet 3.1 support.
      • getContentType

        java.lang.String getContentType()
        Method for getting the Content Type of the Request
        Returns:
        String
      • getProtocol

        java.lang.String getProtocol()
        Returns the protocol that the remote agent is speaking
        Returns:
        String the protocol of the request
      • getServerName

        java.lang.String getServerName()
        Returns the Server hostname
        Returns:
        String the name of the server machine
      • getServerPort

        int getServerPort()
        Returns the port of this connection
        Returns:
        int the port of the server
      • getRemoteHost

        java.lang.String getRemoteHost()
        Returns the host name of the remote agent, or null if not known
        Returns:
        String the DNS name of the client machine
      • getRemoteAddr

        java.lang.String getRemoteAddr()
        Returns the IP address of the remote agent, or null if not known
        Returns:
        String the IP Address of the client machine
      • getRemotePort

        int getRemotePort()
        Returns the port used by the remote agent, or null if not known
        Returns:
        int the port of the client machine
      • getScheme

        java.lang.String getScheme()
        Method that returns the scheme of the request
        Returns:
        String the scheme of the request
      • getInputStream

        java.io.InputStream getInputStream()
                                           throws java.io.IOException
        Returns the input stream for this request
        Parameters:
        InputStream - the input stream to use
        Throws:
        java.io.IOException
      • getLocalAddr

        java.lang.String getLocalAddr()
        Returns the local address
        Returns:
        String the local address
      • getLocalName

        java.lang.String getLocalName()
        Returns the local name
        Returns:
        String the local name
      • getLocalPort

        int getLocalPort()
        Returns the local port
        Returns:
        int the local port
      • isSSL

        boolean isSSL()
        Method to determine if the request is running on an SSL Connection
        Returns:
        boolean true if this connection is an SSL Connection
      • getSSLSessionID

        byte[] getSSLSessionID()
        Get at SSL Session ID
        Returns:
        byte[] containing the SSL session ID
      • getSessionID

        java.lang.String getSessionID()
        Get the session id for this request
        Returns:
        String the session id
      • isProxied

        boolean isProxied()
        Returns whether the request was sent from the plugin
        Returns:
        boolean true if plugin sent the request
      • getWCCResponse

        IResponse getWCCResponse()
        Returns the webcontainer channel response object for this request
        Returns:
        IWCCResponse the response associated with this request
      • getCipherSuite

        java.lang.String getCipherSuite()
        Returns the cipherSuite
        Returns:
        Returns the cipherSuite
      • getPeerCertificates

        java.security.cert.X509Certificate[] getPeerCertificates()
        Returns the array of client certificates
        Returns:
        Returns the client certificates
      • getQueryString

        java.lang.String getQueryString()
        Get the query string of the request.
        Returns:
        String the query string for the request
      • getCookies

        javax.servlet.http.Cookie[] getCookies()
        Get all the cookies for the request.
        Returns:
        Cookie[] containing all the cookies
      • getCookieValue

        byte[] getCookieValue(java.lang.String cookieName)
        Get the value for the cookie specified.
        Parameters:
        name - the cookie name
        Returns:
        byte[] the value of the cookie
      • getAllCookieValues

        java.util.List getAllCookieValues(java.lang.String cookieName)
        Get the values for the cookie specified.
        Parameters:
        name - the cookie name
        Returns:
        List of values associated with this cookie name.
      • getShouldDestroy

        boolean getShouldDestroy()
      • setShouldDestroy

        void setShouldDestroy(boolean shouldDestroy)
      • setShouldReuse

        void setShouldReuse(boolean b)
      • setShouldClose

        void setShouldClose(boolean b)
      • removeHeader

        void removeHeader(java.lang.String headerName)
      • startAsync

        void startAsync()
      • getThreadPool

        com.ibm.ws.util.ThreadPool getThreadPool()
      • isStartAsync

        boolean isStartAsync()
      • lock

        void lock()
      • unlock

        void unlock()
IBM WebSphere Application ServerTM
Release 9.0