Top Description Fields Constructors Methods
org.apache.http.impl

public Class DefaultBHttpClientConnection

extends BHttpConnectionBase
implements HttpClientConnection
Class Inheritance
All Implemented Interfaces
org.apache.http.HttpClientConnection, org.apache.http.HttpConnection, java.io.Closeable, java.lang.AutoCloseable
Imports
java.io.IOException, .OutputStream, java.net.Socket, .SocketTimeoutException, java.nio.charset.CharsetDecoder, .CharsetEncoder, org.apache.http.HttpClientConnection, .HttpEntity, .HttpEntityEnclosingRequest, .HttpException, .HttpRequest, .HttpResponse, .HttpStatus, org.apache.http.config.MessageConstraints, org.apache.http.entity.ContentLengthStrategy, org.apache.http.impl.io.DefaultHttpRequestWriterFactory, .DefaultHttpResponseParserFactory, org.apache.http.io.HttpMessageParser, .HttpMessageParserFactory, .HttpMessageWriter, .HttpMessageWriterFactory, org.apache.http.util.Args
Default implementation of HttpClientConnection.
Since
4.3

Field Summary

Modifier and TypeField and Description
private final HttpMessageWriter<HttpRequest>
requestWriter

private final HttpMessageParser<HttpResponse>
responseParser

Constructor Summary

AccessConstructor and Description
public
DefaultBHttpClientConnection(final int
buffer size. Must be a positive number.
bufferSize, final int
fragment size hint.
fragmentSizeHint, final CharsetDecoder
decoder to be used for decoding HTTP protocol elements. If null simple type cast will be used for byte to char conversion.
charDecoder, final CharsetEncoder
encoder to be used for encoding HTTP protocol elements. If null simple type cast will be used for char to byte conversion.
charEncoder, final MessageConstraints
Message constraints. If null MessageConstraints#DEFAULT will be used.
constraints, final ContentLengthStrategy
incoming content length strategy. If null org.apache.http.impl.entity.LaxContentLengthStrategy#INSTANCE will be used.
incomingContentStrategy, final ContentLengthStrategy
outgoing content length strategy. If null org.apache.http.impl.entity.StrictContentLengthStrategy#INSTANCE will be used.
outgoingContentStrategy, final HttpMessageWriterFactory<HttpRequest>
request writer factory. If null DefaultHttpRequestWriterFactory#INSTANCE will be used.
requestWriterFactory, final HttpMessageParserFactory<HttpResponse>
response parser factory. If null DefaultHttpResponseParserFactory#INSTANCE will be used.
responseParserFactory)

Creates new instance of DefaultBHttpClientConnection.

public
DefaultBHttpClientConnection(final int bufferSize, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder, final MessageConstraints constraints)

public
DefaultBHttpClientConnection(final int bufferSize)

Method Summary

Modifier and TypeMethod and Description
public void
bind(final Socket
the socket.
socket)

Overrides org.apache.http.impl.BHttpConnectionBase.bind.

Binds this connection to the given Socket.
public void
flush()

Implements org.apache.http.HttpClientConnection.flush.

Writes out all pending buffered data over the open connection.
public boolean
isResponseAvailable(final int
the maximum time in milliseconds to wait for data
timeout)

Implements org.apache.http.HttpClientConnection.isResponseAvailable.

Checks if response data is available from the connection.
protected void
onRequestSubmitted(final HttpRequest request)

protected void
onResponseReceived(final HttpResponse response)

public void
receiveResponseEntity(final HttpResponse
the response to attach the entity to
response)

Implements org.apache.http.HttpClientConnection.receiveResponseEntity.

Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.
public HttpResponse
receiveResponseHeader()

Implements org.apache.http.HttpClientConnection.receiveResponseHeader.

Receives the request line and headers of the next response available from this connection.
public void
sendRequestEntity(final HttpEntityEnclosingRequest
the request whose entity to send.
request)

Implements org.apache.http.HttpClientConnection.sendRequestEntity.

Sends the request entity over the connection.
public void
sendRequestHeader(final HttpRequest
the request whose headers to send.
request)

Implements org.apache.http.HttpClientConnection.sendRequestHeader.

Sends the request line and all headers over the connection.
Inherited from org.apache.http.impl.BHttpConnectionBase:
awaitInputclosecreateInputStreamcreateOutputStreamdoFlushensureOpengetLocalAddressgetLocalPortgetMetricsgetRemoteAddressgetRemotePortgetSessionInputBuffergetSessionOutputBuffergetSocketgetSocketInputStreamgetSocketOutputStreamgetSocketTimeoutincrementRequestCountincrementResponseCountisOpenisStaleprepareInputprepareOutputsetSocketTimeoutshutdowntoString

Field Detail

requestWriterback to summary
private final HttpMessageWriter<HttpRequest> requestWriter
responseParserback to summary
private final HttpMessageParser<HttpResponse> responseParser

Constructor Detail

DefaultBHttpClientConnectionback to summary
public DefaultBHttpClientConnection(final int bufferSize, final int fragmentSizeHint, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder, final MessageConstraints constraints, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy, final HttpMessageWriterFactory<HttpRequest> requestWriterFactory, final HttpMessageParserFactory<HttpResponse> responseParserFactory)

Creates new instance of DefaultBHttpClientConnection.

Parameters
bufferSize:int

buffer size. Must be a positive number.

fragmentSizeHint:int

fragment size hint.

charDecoder:CharsetDecoder

decoder to be used for decoding HTTP protocol elements. If null simple type cast will be used for byte to char conversion.

charEncoder:CharsetEncoder

encoder to be used for encoding HTTP protocol elements. If null simple type cast will be used for char to byte conversion.

constraints:MessageConstraints

Message constraints. If null MessageConstraints#DEFAULT will be used.

incomingContentStrategy:ContentLengthStrategy

incoming content length strategy. If null org.apache.http.impl.entity.LaxContentLengthStrategy#INSTANCE will be used.

outgoingContentStrategy:ContentLengthStrategy

outgoing content length strategy. If null org.apache.http.impl.entity.StrictContentLengthStrategy#INSTANCE will be used.

requestWriterFactory:HttpMessageWriterFactory<HttpRequest>

request writer factory. If null DefaultHttpRequestWriterFactory#INSTANCE will be used.

responseParserFactory:HttpMessageParserFactory<HttpResponse>

response parser factory. If null DefaultHttpResponseParserFactory#INSTANCE will be used.

DefaultBHttpClientConnectionback to summary
public DefaultBHttpClientConnection(final int bufferSize, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder, final MessageConstraints constraints)
DefaultBHttpClientConnectionback to summary
public DefaultBHttpClientConnection(final int bufferSize)

Method Detail

bindback to summary
public void bind(final Socket socket) throws IOException

Overrides org.apache.http.impl.BHttpConnectionBase.bind.

Doc from org.apache.http.impl.BHttpConnectionBase.bind.

Binds this connection to the given Socket. This socket will be used by the connection to send and receive data.

After this method's execution the connection status will be reported as open and the isOpen() will return true.

Parameters
socket:Socket

the socket.

Annotations
@Override
Exceptions
IOException:
in case of an I/O error.
flushback to summary
public void flush() throws IOException

Implements org.apache.http.HttpClientConnection.flush.

Doc from org.apache.http.HttpClientConnection.flush.

Writes out all pending buffered data over the open connection.

Annotations
@Override
Exceptions
IOException:
in case of an I/O error
isResponseAvailableback to summary
public boolean isResponseAvailable(final int timeout) throws IOException

Implements org.apache.http.HttpClientConnection.isResponseAvailable.

Doc from org.apache.http.HttpClientConnection.isResponseAvailable.

Checks if response data is available from the connection. May wait for the specified time until some data becomes available. Note that some implementations may completely ignore the timeout parameter.

Parameters
timeout:int

the maximum time in milliseconds to wait for data

Returns:boolean

true if data is available; false if there was no data available even after waiting for timeout milliseconds.

Annotations
@Override
Exceptions
IOException:
if an error happens on the connection
onRequestSubmittedback to summary
protected void onRequestSubmitted(final HttpRequest request)
onResponseReceivedback to summary
protected void onResponseReceived(final HttpResponse response)
receiveResponseEntityback to summary
public void receiveResponseEntity(final HttpResponse response) throws HttpException, IOException

Implements org.apache.http.HttpClientConnection.receiveResponseEntity.

Doc from org.apache.http.HttpClientConnection.receiveResponseEntity.

Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.

Parameters
response:HttpResponse

the response to attach the entity to

Annotations
@Override
Exceptions
HttpException:
in case of HTTP protocol violation
IOException:
in case of an I/O error
receiveResponseHeaderback to summary
public HttpResponse receiveResponseHeader() throws HttpException, IOException

Implements org.apache.http.HttpClientConnection.receiveResponseHeader.

Doc from org.apache.http.HttpClientConnection.receiveResponseHeader.

Receives the request line and headers of the next response available from this connection. The caller should examine the HttpResponse object to find out if it should try to receive a response entity as well.

Returns:HttpResponse

a new HttpResponse object with status line and headers initialized.

Annotations
@Override
Exceptions
HttpException:
in case of HTTP protocol violation
IOException:
in case of an I/O error
sendRequestEntityback to summary
public void sendRequestEntity(final HttpEntityEnclosingRequest request) throws HttpException, IOException

Implements org.apache.http.HttpClientConnection.sendRequestEntity.

Doc from org.apache.http.HttpClientConnection.sendRequestEntity.

Sends the request entity over the connection.

Parameters
request:HttpEntityEnclosingRequest

the request whose entity to send.

Annotations
@Override
Exceptions
HttpException:
in case of HTTP protocol violation
IOException:
in case of an I/O error
sendRequestHeaderback to summary
public void sendRequestHeader(final HttpRequest request) throws HttpException, IOException

Implements org.apache.http.HttpClientConnection.sendRequestHeader.

Doc from org.apache.http.HttpClientConnection.sendRequestHeader.

Sends the request line and all headers over the connection.

Parameters
request:HttpRequest

the request whose headers to send.

Annotations
@Override
Exceptions
HttpException:
in case of HTTP protocol violation
IOException:
in case of an I/O error