Package com.ibm.websphere.servlet.request

Interface IRequest

All Known Subinterfaces:
IRequest, com.ibm.websphere.servlet.request.extended.IRequestExtended
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 Details

    • getMethod

      String getMethod()
      Returns the method of the request
      Returns:
      String the method of the request

    • getRequestURI

      String getRequestURI()
      Returns the URI of the request
      Returns:
      String the URI of the request

    • getRemoteUser

      String getRemoteUser()
      Returns the remote user for the request
      Returns:
      String the remote user of the request

    • getAuthType

      String getAuthType()
      Returns the authorization Type of the current request
      Returns:
      String the authorization type of the request

    • getHeader

      String getHeader(String headerName)
      Returns the value for the specified header requested
      Returns:
      String the given header value

    • getHeaders

      Enumeration getHeaders(String headerName)
      Returns all values for the specified header requested
      Returns:
      Enumeration the given header value

    • getDateHeader

      long getDateHeader(String name)
      Returns the header value in long date format
      Parameters:
      name -
      Returns:
      date header value in date format

    • getIntHeader

      int getIntHeader(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

      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

    • getContentType

      String getContentType()
      Method for getting the Content Type of the Request
      Returns:
      String

    • getProtocol

      String getProtocol()
      Returns the protocol that the remote agent is speaking
      Returns:
      String the protocol of the request

    • getServerName

      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

      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

      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

      String getScheme()
      Method that returns the scheme of the request
      Returns:
      String the scheme of the request

    • getInputStream

      InputStream getInputStream() throws IOException
      Returns the input stream for this request
      Parameters:
      InputStream - the input stream to use
      Throws:
      IOException

    • getLocalAddr

      String getLocalAddr()
      Returns the local address
      Returns:
      String the local address

    • getLocalName

      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

      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

      String getCipherSuite()
      Returns the cipherSuite
      Returns:
      Returns the cipherSuite

    • getPeerCertificates

      X509Certificate[] getPeerCertificates()
      Returns the array of client certificates
      Returns:
      Returns the client certificates

    • getQueryString

      String getQueryString()
      Get the query string of the request.
      Returns:
      String the query string for the request

    • getCookies

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

    • getCookieValue

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

    • getAllCookieValues

      List getAllCookieValues(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(String headerName)

    • startAsync

      void startAsync()

    • isStartAsync

      boolean isStartAsync()

    • lock

      void lock()

    • unlock

      void unlock()