com.ibm.websphere.servlet.request

Interface IRequest


  1. 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

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

Method Detail

getMethod

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

getRequestURI

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

getRemoteUser

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

getAuthType

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

getHeader

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

getHeaders

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

getDateHeader

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

getIntHeader

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

clearHeaders

  1. 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

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

getContentLength

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

getContentType

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

getProtocol

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

getServerName

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

getServerPort

  1. int getServerPort()
Returns the port of this connection
Returns:
int the port of the server

getRemoteHost

  1. 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

  1. 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

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

getScheme

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

getInputStream

  1. java.io.InputStream getInputStream( )
  2. throws java.io.IOException
Returns the input stream for this request
Throws:
java.io.IOException

getLocalAddr

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

getLocalName

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

getLocalPort

  1. int getLocalPort()
Returns the local port
Returns:
int the local port

isSSL

  1. 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

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

getSessionID

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

isProxied

  1. boolean isProxied()
Returns whether the request was sent from the plugin
Returns:
boolean true if plugin sent the request

getWCCResponse

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

getCipherSuite

  1. java.lang.String getCipherSuite( )
Returns the cipherSuite
Returns:
Returns the cipherSuite

getPeerCertificates

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

getQueryString

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

getCookies

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

getCookieValue

  1. byte[] getCookieValue(java.lang.String cookieName)
Get the value for the cookie specified.
Returns:
byte[] the value of the cookie

getAllCookieValues

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

getShouldDestroy

  1. boolean getShouldDestroy()

setShouldDestroy

  1. void setShouldDestroy(boolean shouldDestroy)

setShouldReuse

  1. void setShouldReuse(boolean b)

setShouldClose

  1. void setShouldClose(boolean b)

removeHeader

  1. void removeHeader(java.lang.String headerName)

startAsync

  1. void startAsync()

getThreadPool

  1. com.ibm.ws.util.ThreadPool getThreadPool( )

isStartAsync

  1. boolean isStartAsync()

lock

  1. void lock()

unlock

  1. void unlock()