com.ibm.wsspi.http

Interface HttpInboundConnection


  1. public interface HttpInboundConnection
Representation of an inbound HTTP connection that the dispatcher will provide to containers.

Method Summary

Modifier and Type Method and Description
  1. void
finish(java.lang.Exception e)
When a container is finished with the connection, this API signals that and allows the dispatcher to complete any remaining work for the connection.
  1. HttpDateFormat
getDateFormatter()
Access the HTTP date format utility class.
  1. EncodingUtils
getEncodingUtils()
Access the string encoding utility class.
  1. java.lang.String
getLocalHostAddress()
Access the local/server side address of the connection.
  1. java.lang.String
getLocalHostAlias()
  1. java.lang.String
getLocalHostName(boolean canonical)
Access the local/server side address of the connection.
  1. int
getLocalPort()
Access the local/server side port of the connection.
  1. java.lang.String
getRemoteHostAddress()
Access the remote/client side address of the connection.
  1. java.lang.String
getRemoteHostName(boolean canonical)
Access the remote/client side address of the connection.
  1. int
getRemotePort()
Access the remote/client side port of the connection.
  1. HttpRequest
getRequest()
Access the request message object for this connection.
  1. HttpResponse
getResponse()
Access the response message object for this connection.
  1. SSLContext
getSSLContext()
Access any SSL information, if this connection was secure.

Method Detail

getLocalHostName

  1. java.lang.String getLocalHostName( boolean canonical)
Access the local/server side address of the connection.
Parameters:
canonical - if true, attempts to find fully qualified domain name
Returns:
String host name
See Also:
InetAddress.getHostName(), InetAddress.getCanonicalHostName()

getLocalHostAddress

  1. java.lang.String getLocalHostAddress( )
Access the local/server side address of the connection.
Returns:
String IP Address

getLocalPort

  1. int getLocalPort()
Access the local/server side port of the connection.
Returns:
int

getLocalHostAlias

  1. java.lang.String getLocalHostAlias( )
Returns:
The concatenated canonicalHostName:port string representing this inbound connection (for use when looking up associated resources)

getRemoteHostName

  1. java.lang.String getRemoteHostName( boolean canonical)
Access the remote/client side address of the connection.
Parameters:
canonical - if true, attempts to find fully qualified domain name
Returns:
String host name
See Also:
InetAddress.getHostName(), InetAddress.getCanonicalHostName()

getRemoteHostAddress

  1. java.lang.String getRemoteHostAddress( )
Access the remote/client side address of the connection.
Returns:
String IP Address

getRemotePort

  1. int getRemotePort()
Access the remote/client side port of the connection.
Returns:
int

getRequest

  1. HttpRequest getRequest()
Access the request message object for this connection.
Returns:
HttpRequest

getResponse

  1. HttpResponse getResponse()
Access the response message object for this connection.
Returns:
HttpResponse

getSSLContext

  1. SSLContext getSSLContext()
Access any SSL information, if this connection was secure. This will return null if it was not a secure connection.
Returns:
SSLContext

getEncodingUtils

  1. EncodingUtils getEncodingUtils( )
Access the string encoding utility class. This is never null.
Returns:
EncodingUtils

getDateFormatter

  1. HttpDateFormat getDateFormatter( )
Access the HTTP date format utility class. This includes support for all the various HTTP date styles, and is never null.
Returns:
HttpDateFormat

finish

  1. void finish(java.lang.Exception e)
When a container is finished with the connection, this API signals that and allows the dispatcher to complete any remaining work for the connection. The exception passed is used in the decision whether to perform a read for another request or to simply close the connection. Errors while reading or writing during this request/response exchange would be passed along here.
Parameters:
e -