com.ibm.wsspi.soapcontainer

Interface SOAPRequest


  1. public interface SOAPRequest
Interface that the SOAP Container recognizes as the type of request that it accepts. The SOAP Container will call the methods on this interface during request processing.

Method Summary

Modifier and Type Method and Description
  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. 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.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
getRequestPathInfo()
Returns the "path info" part of the request URI.
  1. java.lang.String
getRequestURI()
Returns the URI of the request
  1. java.lang.String
getRequestURLAsString()
Returns the full request URL string associated with the request.
  1. SOAPResponse
getResponse()
Returns the webcontainer channel response object for this request
  1. java.lang.String
getScheme()
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. byte[]
getSSLSessionID()
Get at SSL Session ID
  1. boolean
isSSL()
Method to determine if the request is running on an SSL Connection

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

getRequestPathInfo

  1. java.lang.String getRequestPathInfo( )
Returns the "path info" part of the request URI. This is the part that follows the context root: //

getRequestURLAsString

  1. java.lang.String getRequestURLAsString( )
Returns the full request URL string associated with 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

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()
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
Returns:
InputStream the input stream to use
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

getResponse

  1. SOAPResponse getResponse()
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

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