Package com.ibm.wsspi.http
Interface HttpInboundConnection
- 
- All Known Subinterfaces:
- Http2InboundConnection
 
 public interface HttpInboundConnectionRepresentation of an inbound HTTP connection that the dispatcher will provide to containers.
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidfinish(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.HttpDateFormatgetDateFormatter()Access the HTTP date format utility class.EncodingUtilsgetEncodingUtils()Access the string encoding utility class.java.lang.StringgetLocalHostAddress()Access the local/server side address of the connection.java.lang.StringgetLocalHostAlias()java.lang.StringgetLocalHostName(boolean canonical)Access the local/server side address of the connection.intgetLocalPort()Access the local/server side port of the connection.java.lang.StringgetRemoteHostAddress()Access the remote/client side address of the connection.java.lang.StringgetRemoteHostName(boolean canonical)Access the remote/client side address of the connection.intgetRemotePort()Access the remote/client side port of the connection.HttpRequestgetRequest()Access the request message object for this connection.java.lang.StringgetRequestedHost()Get the requested host based on the Host and/or private headers.intgetRequestedPort()Get the requested port based on the Host and/or private headers.HttpResponsegetResponse()Access the response message object for this connection.SSLContextgetSSLContext()Access any SSL information, if this connection was secure.java.lang.StringgetTrustedHeader(java.lang.String headerKey)Return the value of the specified trusted header if trusted headers are enabled for this connection.booleanuseTrustedHeaders()This will indicate whether or not private headers should be trusted on this connection.
 
- 
- 
- 
Method Detail- 
getLocalHostNamejava.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()
 
 - 
getLocalHostAddressjava.lang.String getLocalHostAddress() Access the local/server side address of the connection.- Returns:
- String IP Address
 
 - 
getLocalPortint getLocalPort() Access the local/server side port of the connection.- Returns:
- int
 
 - 
getLocalHostAliasjava.lang.String getLocalHostAlias() - Returns:
- The concatenated canonicalHostName:port string representing this inbound connection (for use when looking up associated resources)
 
 - 
getRemoteHostNamejava.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()
 
 - 
getRemoteHostAddressjava.lang.String getRemoteHostAddress() Access the remote/client side address of the connection.- Returns:
- String IP Address
 
 - 
getRemotePortint getRemotePort() Access the remote/client side port of the connection.- Returns:
- int
 
 - 
getRequestHttpRequest getRequest() Access the request message object for this connection.- Returns:
- HttpRequest
 
 - 
getResponseHttpResponse getResponse() Access the response message object for this connection.- Returns:
- HttpResponse
 
 - 
getSSLContextSSLContext getSSLContext() Access any SSL information, if this connection was secure. This will return null if it was not a secure connection.- Returns:
- SSLContext
 
 - 
getEncodingUtilsEncodingUtils getEncodingUtils() Access the string encoding utility class. This is never null.- Returns:
- EncodingUtils
 
 - 
getDateFormatterHttpDateFormat getDateFormatter() Access the HTTP date format utility class. This includes support for all the various HTTP date styles, and is never null.- Returns:
- HttpDateFormat
 
 - 
finishvoid 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-
 
 - 
useTrustedHeadersboolean useTrustedHeaders() This will indicate whether or not private headers should be trusted on this connection.- Returns:
- true if trusted/private headers should be used, false if not.
 
 - 
getTrustedHeaderjava.lang.String getTrustedHeader(java.lang.String headerKey) Return the value of the specified trusted header if trusted headers are enabled for this connection.- Parameters:
- headerKey- Trusted header to find
- Returns:
- value of trusted header or null.
 
 - 
getRequestedHostjava.lang.String getRequestedHost() Get the requested host based on the Host and/or private headers.per Servlet spec, this is similar to getServerName: Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the Host header value, if any, or the resolved server name, or the server IP address. 
 - 
getRequestedPortint getRequestedPort() Get the requested port based on the Host and/or private headers. per Servlet spec, this is similar to getServerPort: Returns the port number to which the request was sent. It is the value of the part after ":" in the Host header value, if any, or the server port where the client connection was accepted on.
 
- 
 
-