org.apache.commons.httpclient
Class HttpConnection

java.lang.Object
  |
  +--org.apache.commons.httpclient.HttpConnection

public class HttpConnection
extends Object

An abstraction of an HTTP InputStream and OutputStream pair, together with the relevant attributes.

The following options are set on the socket before getting the input/output streams in the open() method:
Socket Method Sockets Option Configuration
Socket.setTcpNoDelay(boolean) SO_NODELAY None
Socket.setSoTimeout(int) SO_TIMEOUT setConnectionTimeout(int)

Version:
$Revision: 1.45 $ $Date: 2003/02/16 13:08:32 $
Author:
Rod Waldhoff, Sean C. Sullivan, Ortwin Gl?ck, Jeff Dever, Mike Bowler, Oleg Kalnichevski, Michael Becke

Nested Class Summary
 class HttpConnection.ConnectionTimeoutException
          Signals that a timeout occured while opening the socket.
 
Constructor Summary
HttpConnection(HostConfiguration hostConfiguration)
          Creates a new HttpConnection.
HttpConnection(String host, int port)
          Constructor.
HttpConnection(String host, int port, boolean secure)
          Deprecated. use HttpConnection(String, int, Protocol)
HttpConnection(String host, int port, Protocol protocol)
          Constructor.
HttpConnection(String proxyHost, int proxyPort, String host, int port)
          Constructor.
HttpConnection(String proxyHost, int proxyPort, String host, int port, boolean secure)
          Deprecated. use HttpConnection(String, int, String, int, Protocol)
HttpConnection(String proxyHost, int proxyPort, String host, int port, Protocol protocol)
          Create an instance
 
Method Summary
protected  void assertNotOpen()
          Throw an IllegalStateException if I am connected.
protected  void assertOpen()
          Throw an IllegalStateException if I am not connected.
 void close()
          Close my socket and streams.
protected  void closeSocketAndStreams()
          Close everything out.
 String getHost()
          Return my host.
 HttpConnectionManager getHttpConnectionManager()
          Returns the httpConnectionManager.
 InputStream getLastResponseInputStream()
          Returns the stream used to read the last response's body.
 int getPort()
          Return my port.
 Protocol getProtocol()
          Get the protocol.
 String getProxyHost()
          Return my proxy host.
 int getProxyPort()
          Return my proxy port.
 OutputStream getRequestOutputStream()
          Return a RequestOutputStream suitable for writing (possibly chunked) bytes to my OutputStream.
 OutputStream getRequestOutputStream(boolean useChunking)
          Deprecated. Use new ChunkedOutputStream(httpConnecion.getRequestOutputStream());
 InputStream getResponseInputStream()
          Return the response input stream
 InputStream getResponseInputStream(HttpMethod method)
          Deprecated. Use getResponseInputStream() instead.
 boolean isOpen()
          Return true if I am connected, false otherwise.
 boolean isProxied()
          Return true if I am (or I will be) connected via a proxy, false otherwise.
 boolean isResponseAvaliable()
          Tests if input data avaialble.
 boolean isSecure()
          Return true if I will (or I am) connected over a secure (HTTPS/SSL) protocol.
 boolean isTransparent()
          Indicates if the connection is completely transparent from end to end.
 void open()
          Open this connection to the current host and port (via a proxy if so configured).
 void print(String data)
          Write the specified String (as bytes) to my output stream.
 void printLine()
          Write "\r\n".getBytes() to my output stream.
 void printLine(String data)
          Write the specified String (as bytes), followed by "\r\n".getBytes() to my output stream.
 String readLine()
          Read up to "\r\n" from my (unchunked) input stream.
 void releaseConnection()
          Release the connection.
 void setConnectionTimeout(int timeout)
          Sets the connection timeout.
 void setHost(String host)
          Set my host.
 void setHttpConnectionManager(HttpConnectionManager httpConnectionManager)
          Sets the httpConnectionManager.
 void setLastResponseInputStream(InputStream inStream)
          Set the state to keep track of the last response for the last request.
 void setPort(int port)
          Set my port.
 void setProtocol(Protocol protocol)
          Sets the protocol used by this connection.
 void setProxyHost(String host)
          Set the host I should proxy through.
 void setProxyPort(int port)
          Set the port I should proxy through.
 void setSecure(boolean secure)
          Deprecated. use setProtocol(Protocol)
 void setSoTimeout(int timeout)
          Set my Socket's timeout, via Socket.setSoTimeout(int).
 void shutdownOutput()
          Shutdown my Socket's output, via Socket.shutdownOutput().
 void tunnelCreated()
          Calling this method indicates that the proxy has successfully created the tunnel to the host.
 boolean waitForResponse(long timeout_ms)
          Waits for the specified number of milliseconds for input data to become available
 void write(byte[] data)
          Write the specified bytes to my output stream.
 void write(byte[] data, int offset, int length)
          Write length bytes in data starting at offset to my output stream.
 void writeLine()
          Write "\r\n".getBytes() to my output stream.
 void writeLine(byte[] data)
          Write the specified bytes, followed by "\r\n".getBytes() to my output stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HttpConnection

public HttpConnection(String host,
                      int port)
Constructor.

Parameters:
host - the host I should connect to
port - the port I should connect to

HttpConnection

public HttpConnection(String host,
                      int port,
                      boolean secure)
Deprecated. use HttpConnection(String, int, Protocol)

Constructor.

Parameters:
host - the host I should connect to
port - the port I should connect to
secure - when true, connect via HTTPS (SSL)
See Also:
HttpConnection(String,int,Protocol)

HttpConnection

public HttpConnection(String host,
                      int port,
                      Protocol protocol)
Constructor.

Parameters:
host - the host I should connect to
port - the port I should connect to
protocol - the protocol to use

HttpConnection

public HttpConnection(String proxyHost,
                      int proxyPort,
                      String host,
                      int port)
Constructor.

Parameters:
proxyHost - the host I should proxy via
proxyPort - the port I should proxy via
host - the host I should connect to
port - the port I should connect to

HttpConnection

public HttpConnection(String proxyHost,
                      int proxyPort,
                      String host,
                      int port,
                      boolean secure)
Deprecated. use HttpConnection(String, int, String, int, Protocol)

Fully-specified constructor.

Parameters:
proxyHost - the host I should proxy via
proxyPort - the port I should proxy via
host - the host I should connect to. Parameter value must be non-null.
port - the port I should connect to
secure - when true, connect via HTTPS (SSL)
See Also:
HttpConnection(String, int, String, int, Protocol)

HttpConnection

public HttpConnection(HostConfiguration hostConfiguration)
Creates a new HttpConnection.

Parameters:
hostConfiguration - the host/proxy/protocol to use

HttpConnection

public HttpConnection(String proxyHost,
                      int proxyPort,
                      String host,
                      int port,
                      Protocol protocol)
Create an instance

Parameters:
proxyHost - the host I should proxy via
proxyPort - the port I should proxy via
host - the host I should connect to. Parameter value must be non-null.
port - the port I should connect to
protocol - The protocol to use.
Method Detail

getHost

public String getHost()
Return my host.

Returns:
my host.

setHost

public void setHost(String host)
             throws IllegalStateException
Set my host.

Parameters:
host - the host I should connect to. Parameter value must be non-null.
Throws:
IllegalStateException - if I am already connected

getPort

public int getPort()
Return my port. If the port is -1 (or less than 0) the default port for the current protocol is returned.

Returns:
my port.

setPort

public void setPort(int port)
             throws IllegalStateException
Set my port.

Parameters:
port - the port I should connect to
Throws:
IllegalStateException - if I am already connected

getProxyHost

public String getProxyHost()
Return my proxy host.

Returns:
my proxy host.

setProxyHost

public void setProxyHost(String host)
                  throws IllegalStateException
Set the host I should proxy through.

Parameters:
host - the host I should proxy through.
Throws:
IllegalStateException - if I am already connected

getProxyPort

public int getProxyPort()
Return my proxy port.

Returns:
my proxy port.

setProxyPort

public void setProxyPort(int port)
                  throws IllegalStateException
Set the port I should proxy through.

Parameters:
port - the host I should proxy through.
Throws:
IllegalStateException - if I am already connected

isSecure

public boolean isSecure()
Return true if I will (or I am) connected over a secure (HTTPS/SSL) protocol.

Returns:
true if I will (or I am) connected over a secure (HTTPS/SSL) protocol.

getProtocol

public Protocol getProtocol()
Get the protocol.

Returns:
HTTPS if secure, HTTP otherwise

setSecure

public void setSecure(boolean secure)
               throws IllegalStateException
Deprecated. use setProtocol(Protocol)

Set whether or not I should connect over HTTPS (SSL).

Parameters:
secure - whether or not I should connect over HTTPS (SSL).
Throws:
IllegalStateException - if I am already connected
See Also:
setProtocol(Protocol)

setProtocol

public void setProtocol(Protocol protocol)
Sets the protocol used by this connection.

Parameters:
protocol - The new protocol.

isOpen

public boolean isOpen()
Return true if I am connected, false otherwise.

Returns:
true if I am connected

isProxied

public boolean isProxied()
Return true if I am (or I will be) connected via a proxy, false otherwise.

Returns:
true if I am (or I will be) connected via a proxy, false otherwise.

setLastResponseInputStream

public void setLastResponseInputStream(InputStream inStream)
Set the state to keep track of the last response for the last request.

The connection managers use this to ensure that previous requests are properly closed before a new request is attempted. That way, a GET request need not be read in its entirety before a new request is issued. Instead, this stream can be closed as appropriate.

Parameters:
inStream - The stream associated with an HttpMethod.

getLastResponseInputStream

public InputStream getLastResponseInputStream()
Returns the stream used to read the last response's body.

Clients will generally not need to call this function unless using HttpConnection directly, instead of calling HttpClient.executeMethod(org.apache.commons.httpclient.HttpMethod). For those clients, call this function, and if it returns a non-null stream, close the stream before attempting to execute a method. Note that calling "close" on the stream returned by this function may close the connection if the previous response contained a "Connection: close" header.

Returns:
An InputStream corresponding to the body of the last response.

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException,
                         IllegalStateException
Set my Socket's timeout, via Socket.setSoTimeout(int). If the connection is already open, the SO_TIMEOUT is changed. If no connection is open, then subsequent connections will use the timeout value.

Note: This is not a connection timeout but a timeout on network traffic!

Parameters:
timeout - the timeout value
Throws:
SocketException - - if there is an error in the underlying protocol, such as a TCP error.
IllegalStateException - if I am not connected

setConnectionTimeout

public void setConnectionTimeout(int timeout)
Sets the connection timeout. This is the maximum time that may be spent until a connection is established. The connection will fail after this amount of time.

Parameters:
timeout - The timeout in milliseconds. 0 means timeout is not used.

open

public void open()
          throws IOException
Open this connection to the current host and port (via a proxy if so configured). The underlying socket is created from the ProtocolSocketFactory.

Throws:
IOException - when there are errors opening the connection

tunnelCreated

public void tunnelCreated()
                   throws IllegalStateException,
                          IOException
Calling this method indicates that the proxy has successfully created the tunnel to the host. The socket will be switched to the secure socket. Subsequent communication is done via the secure socket. The method can only be called once on a proxied secure connection.

Throws:
IllegalStateException - if connection is not secure and proxied or if the socket is already secure.
IOException - if an error occured creating the secure socket

isTransparent

public boolean isTransparent()
Indicates if the connection is completely transparent from end to end.

Returns:
true if conncetion is not proxied or tunneled through a transparent proxy; false otherwise.

getRequestOutputStream

public OutputStream getRequestOutputStream()
                                    throws IOException,
                                           IllegalStateException
Return a RequestOutputStream suitable for writing (possibly chunked) bytes to my OutputStream.

Returns:
a stream to write the request to
Throws:
IllegalStateException - if I am not connected
IOException - if an I/O problem occurs

getRequestOutputStream

public OutputStream getRequestOutputStream(boolean useChunking)
                                    throws IOException,
                                           IllegalStateException
Deprecated. Use new ChunkedOutputStream(httpConnecion.getRequestOutputStream());

Return a RequestOutputStream suitable for writing (possibly chunked) bytes to my OutputStream.

Parameters:
useChunking - when true the chunked transfer-encoding will be used
Returns:
a stream to write the request to
Throws:
IllegalStateException - if I am not connected
IOException - if an I/O problem occurs

getResponseInputStream

public InputStream getResponseInputStream(HttpMethod method)
                                   throws IOException,
                                          IllegalStateException
Deprecated. Use getResponseInputStream() instead.

Return a ResponseInputStream suitable for reading (possibly chunked) bytes from my InputStream.

If the given HttpMethod contains a Transfer-Encoding: chunked header, the returned stream will be configured to read chunked bytes.

Parameters:
method - This argument is ignored.
Returns:
a stream to read the response from
Throws:
IllegalStateException - if I am not connected
IOException - if an I/O problem occurs

getResponseInputStream

public InputStream getResponseInputStream()
                                   throws IOException,
                                          IllegalStateException
Return the response input stream

Returns:
InputStream The response input stream.
Throws:
IOException - If an IO problem occurs
IllegalStateException - If the connection isn't open.

isResponseAvaliable

public boolean isResponseAvaliable()
                            throws IOException
Tests if input data avaialble.

Returns:
boolean true if input data is availble, false otherwise.
Throws:
IOException - If an IO problem occurs
IllegalStateException - If the connection isn't open.

waitForResponse

public boolean waitForResponse(long timeout_ms)
                        throws IOException,
                               IllegalStateException
Waits for the specified number of milliseconds for input data to become available

Parameters:
timeout_ms - Number of milliseconds to wait for input data.
Returns:
boolean true if input data is availble, false otherwise.
Throws:
IOException - If an IO problem occurs
IllegalStateException - If the connection isn't open.

write

public void write(byte[] data)
           throws IOException,
                  IllegalStateException,
                  HttpRecoverableException
Write the specified bytes to my output stream.

Parameters:
data - the data to be written
Throws:
HttpRecoverableException - if a SocketException occurs
IllegalStateException - if not connected
IOException - if an I/O problem occurs
See Also:
write(byte[],int,int)

write

public void write(byte[] data,
                  int offset,
                  int length)
           throws IOException,
                  IllegalStateException,
                  HttpRecoverableException
Write length bytes in data starting at offset to my output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

Parameters:
data - array containing the data to be written.
offset - the start offset in the data.
length - the number of bytes to write.
Throws:
HttpRecoverableException - if a SocketException occurs
IllegalStateException - if not connected
IOException - if an I/O problem occurs

writeLine

public void writeLine(byte[] data)
               throws IOException,
                      IllegalStateException,
                      HttpRecoverableException
Write the specified bytes, followed by "\r\n".getBytes() to my output stream.

Parameters:
data - the bytes to be written
Throws:
HttpRecoverableException - when socket exceptions occur writing data
IllegalStateException - if I am not connected
IOException - if an I/O problem occurs

writeLine

public void writeLine()
               throws IOException,
                      IllegalStateException,
                      HttpRecoverableException
Write "\r\n".getBytes() to my output stream.

Throws:
HttpRecoverableException - when socket exceptions occur writing data
IllegalStateException - if I am not connected
IOException - if an I/O problem occurs

print

public void print(String data)
           throws IOException,
                  IllegalStateException,
                  HttpRecoverableException
Write the specified String (as bytes) to my output stream.

Parameters:
data - the string to be written
Throws:
HttpRecoverableException - when socket exceptions occur writing data
IllegalStateException - if I am not connected
IOException - if an I/O problem occurs

printLine

public void printLine(String data)
               throws IOException,
                      IllegalStateException,
                      HttpRecoverableException
Write the specified String (as bytes), followed by "\r\n".getBytes() to my output stream.

Parameters:
data - the data to be written
Throws:
HttpRecoverableException - when socket exceptions occur writing data
IllegalStateException - if I am not connected
IOException - if an I/O problem occurs

printLine

public void printLine()
               throws IOException,
                      IllegalStateException,
                      HttpRecoverableException
Write "\r\n".getBytes() to my output stream.

Throws:
HttpRecoverableException - when socket exceptions occur writing data
IllegalStateException - if I am not connected
IOException - if an I/O problem occurs

readLine

public String readLine()
                throws IOException,
                       IllegalStateException
Read up to "\r\n" from my (unchunked) input stream. If the stream ends before the line terminator is found, the last part of the string will still be returned. '\r' and '\n' are allowed to appear individually in the stream.

Returns:
a line from the response
Throws:
IllegalStateException - if I am not connected
IOException - if an I/O problem occurs

shutdownOutput

public void shutdownOutput()
Shutdown my Socket's output, via Socket.shutdownOutput().


close

public void close()
Close my socket and streams.


getHttpConnectionManager

public HttpConnectionManager getHttpConnectionManager()
Returns the httpConnectionManager.

Returns:
HttpConnectionManager

setHttpConnectionManager

public void setHttpConnectionManager(HttpConnectionManager httpConnectionManager)
Sets the httpConnectionManager.

Parameters:
httpConnectionManager - The httpConnectionManager to set

releaseConnection

public void releaseConnection()
Release the connection.


closeSocketAndStreams

protected void closeSocketAndStreams()
Close everything out.


assertNotOpen

protected void assertNotOpen()
                      throws IllegalStateException
Throw an IllegalStateException if I am connected.

Throws:
IllegalStateException - if connected

assertOpen

protected void assertOpen()
                   throws IllegalStateException
Throw an IllegalStateException if I am not connected.

Throws:
IllegalStateException - if not connected


Copyright (c) 1999-2002 - Apache Software Foundation