Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.impl.io.DefaultBHttpClientConnection

Modifier and Type	Field and Description
private volatile boolean	consistent
private final ContentLengthStrategy	incomingContentStrategy
private final ContentLengthStrategy	outgoingContentStrategy
private final HttpMessageWriter<ClassicHttpRequest>	requestWriter
private final ResponseOutOfOrderStrategy	responseOutOfOrderStrategy
private final HttpMessageParser<ClassicHttpResponse>	responseParser

Constructor Summary

Access	Constructor and Description
public	DefaultBHttpClientConnection(final Http1Config Message http1Config. If `null` `Http1Config#DEFAULT` will be used. http1Config, 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 ContentLengthStrategy incoming content length strategy. If `null` `DefaultContentLengthStrategy#INSTANCE` will be used. incomingContentStrategy, final ContentLengthStrategy outgoing content length strategy. If `null` `DefaultContentLengthStrategy#INSTANCE` will be used. outgoingContentStrategy, final ResponseOutOfOrderStrategy response out of order strategy. If `null` `NoResponseOutOfOrderStrategy#INSTANCE` will be used. responseOutOfOrderStrategy, final HttpMessageWriterFactory<ClassicHttpRequest> request writer factory. If `null` `DefaultHttpRequestWriterFactory#INSTANCE` will be used. requestWriterFactory, final HttpMessageParserFactory<ClassicHttpResponse> response parser factory. If `null` `DefaultHttpResponseParserFactory#INSTANCE` will be used. responseParserFactory) Creates new instance of DefaultBHttpClientConnection.
public	DefaultBHttpClientConnection(final Http1Config Message http1Config. If `null` `Http1Config#DEFAULT` will be used. http1Config, 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 ContentLengthStrategy incoming content length strategy. If `null` `DefaultContentLengthStrategy#INSTANCE` will be used. incomingContentStrategy, final ContentLengthStrategy outgoing content length strategy. If `null` `DefaultContentLengthStrategy#INSTANCE` will be used. outgoingContentStrategy, final HttpMessageWriterFactory<ClassicHttpRequest> request writer factory. If `null` `DefaultHttpRequestWriterFactory#INSTANCE` will be used. requestWriterFactory, final HttpMessageParserFactory<ClassicHttpResponse> response parser factory. If `null` `DefaultHttpResponseParserFactory#INSTANCE` will be used. responseParserFactory) Creates new instance of DefaultBHttpClientConnection.
public	DefaultBHttpClientConnection(final Http1Config http1Config, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder)
public	DefaultBHttpClientConnection(final Http1Config http1Config)

Method Summary

Modifier and Type	Method and Description
public void	bind(final Socket the socket. socket) Overrides org.apache.hc.core5.http.impl.io.BHttpConnectionBase.bind. Binds this connection to the given `Socket`.
public boolean	isConsistent() Implements org.apache.hc.core5.http.io.HttpClientConnection.isConsistent. Checks whether this connection is in a consistent state.
protected void	onRequestSubmitted(final ClassicHttpRequest request)
protected void	onResponseReceived(final ClassicHttpResponse response)
public void	receiveResponseEntity(final ClassicHttpResponse the response to attach the entity to response) Implements org.apache.hc.core5.http.io.HttpClientConnection.receiveResponseEntity. Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.
public ClassicHttpResponse	receiveResponseHeader() Implements org.apache.hc.core5.http.io.HttpClientConnection.receiveResponseHeader. Receives the request line and headers of the next response available from this connection.
public void	sendRequestEntity(final ClassicHttpRequest the request whose entity to send. request) Implements org.apache.hc.core5.http.io.HttpClientConnection.sendRequestEntity. Sends the request entity over the connection.
public void	sendRequestHeader(final ClassicHttpRequest the request whose headers to send. request) Implements org.apache.hc.core5.http.io.HttpClientConnection.sendRequestHeader. Sends the request line and all headers over the connection.
public void	terminateRequest(final ClassicHttpRequest the request to be terminated prematurely. request) Implements org.apache.hc.core5.http.io.HttpClientConnection.terminateRequest. Terminates request prematurely potentially leaving the connection in a inconsistent state.

Field Detail

consistent	back to summary
private volatile boolean consistent

incomingContentStrategy	back to summary
private final ContentLengthStrategy incomingContentStrategy

outgoingContentStrategy	back to summary
private final ContentLengthStrategy outgoingContentStrategy

requestWriter	back to summary
private final HttpMessageWriter<ClassicHttpRequest> requestWriter

responseOutOfOrderStrategy	back to summary
private final ResponseOutOfOrderStrategy responseOutOfOrderStrategy

responseParser	back to summary
private final HttpMessageParser<ClassicHttpResponse> responseParser

Constructor Detail

DefaultBHttpClientConnection back to summary

DefaultBHttpClientConnection	back to summary
public DefaultBHttpClientConnection(final Http1Config http1Config, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy, final ResponseOutOfOrderStrategy responseOutOfOrderStrategy, final HttpMessageWriterFactory<ClassicHttpRequest> requestWriterFactory, final HttpMessageParserFactory<ClassicHttpResponse> responseParserFactory) Creates new instance of DefaultBHttpClientConnection. Parameters http1Config:Http1Config Message http1Config. If `null` `Http1Config#DEFAULT` will be used. 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. incomingContentStrategy:ContentLengthStrategy incoming content length strategy. If `null` `DefaultContentLengthStrategy#INSTANCE` will be used. outgoingContentStrategy:ContentLengthStrategy outgoing content length strategy. If `null` `DefaultContentLengthStrategy#INSTANCE` will be used. responseOutOfOrderStrategy:ResponseOutOfOrderStrategy response out of order strategy. If `null` `NoResponseOutOfOrderStrategy#INSTANCE` will be used. requestWriterFactory:HttpMessageWriterFactory<ClassicHttpRequest> request writer factory. If `null` `DefaultHttpRequestWriterFactory#INSTANCE` will be used. responseParserFactory:HttpMessageParserFactory<ClassicHttpResponse> response parser factory. If `null` `DefaultHttpResponseParserFactory#INSTANCE` will be used.

public DefaultBHttpClientConnection(final Http1Config http1Config, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy, final ResponseOutOfOrderStrategy responseOutOfOrderStrategy, final HttpMessageWriterFactory<ClassicHttpRequest> requestWriterFactory, final HttpMessageParserFactory<ClassicHttpResponse> responseParserFactory)

Creates new instance of DefaultBHttpClientConnection.

Parameters

http1Config:Http1Config: Message http1Config. If null Http1Config#DEFAULT will be used.
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.
incomingContentStrategy:ContentLengthStrategy: incoming content length strategy. If null DefaultContentLengthStrategy#INSTANCE will be used.
outgoingContentStrategy:ContentLengthStrategy: outgoing content length strategy. If null DefaultContentLengthStrategy#INSTANCE will be used.
responseOutOfOrderStrategy:ResponseOutOfOrderStrategy: response out of order strategy. If null NoResponseOutOfOrderStrategy#INSTANCE will be used.
requestWriterFactory:HttpMessageWriterFactory<ClassicHttpRequest>: request writer factory. If null DefaultHttpRequestWriterFactory#INSTANCE will be used.
responseParserFactory:HttpMessageParserFactory<ClassicHttpResponse>: response parser factory. If null DefaultHttpResponseParserFactory#INSTANCE will be used.

DefaultBHttpClientConnection back to summary

DefaultBHttpClientConnection	back to summary
public DefaultBHttpClientConnection(final Http1Config http1Config, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy, final HttpMessageWriterFactory<ClassicHttpRequest> requestWriterFactory, final HttpMessageParserFactory<ClassicHttpResponse> responseParserFactory) Creates new instance of DefaultBHttpClientConnection. Parameters http1Config:Http1Config Message http1Config. If `null` `Http1Config#DEFAULT` will be used. 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. incomingContentStrategy:ContentLengthStrategy incoming content length strategy. If `null` `DefaultContentLengthStrategy#INSTANCE` will be used. outgoingContentStrategy:ContentLengthStrategy outgoing content length strategy. If `null` `DefaultContentLengthStrategy#INSTANCE` will be used. requestWriterFactory:HttpMessageWriterFactory<ClassicHttpRequest> request writer factory. If `null` `DefaultHttpRequestWriterFactory#INSTANCE` will be used. responseParserFactory:HttpMessageParserFactory<ClassicHttpResponse> response parser factory. If `null` `DefaultHttpResponseParserFactory#INSTANCE` will be used.

public DefaultBHttpClientConnection(final Http1Config http1Config, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy, final HttpMessageWriterFactory<ClassicHttpRequest> requestWriterFactory, final HttpMessageParserFactory<ClassicHttpResponse> responseParserFactory)

Creates new instance of DefaultBHttpClientConnection.

Parameters

http1Config:Http1Config: Message http1Config. If null Http1Config#DEFAULT will be used.
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.
incomingContentStrategy:ContentLengthStrategy: incoming content length strategy. If null DefaultContentLengthStrategy#INSTANCE will be used.
outgoingContentStrategy:ContentLengthStrategy: outgoing content length strategy. If null DefaultContentLengthStrategy#INSTANCE will be used.
requestWriterFactory:HttpMessageWriterFactory<ClassicHttpRequest>: request writer factory. If null DefaultHttpRequestWriterFactory#INSTANCE will be used.
responseParserFactory:HttpMessageParserFactory<ClassicHttpResponse>: response parser factory. If null DefaultHttpResponseParserFactory#INSTANCE will be used.

DefaultBHttpClientConnection	back to summary
public DefaultBHttpClientConnection(final Http1Config http1Config, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder)

DefaultBHttpClientConnection	back to summary
public DefaultBHttpClientConnection(final Http1Config http1Config)

Method Detail

bind back to summary

bind	back to summary
public void bind(final Socket socket) throws IOException Overrides org.apache.hc.core5.http.impl.io.BHttpConnectionBase.bind. Doc from org.apache.hc.core5.http.impl.io.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.

public void bind(final Socket socket) throws IOException

Overrides org.apache.hc.core5.http.impl.io.BHttpConnectionBase.bind.

Doc from org.apache.hc.core5.http.impl.io.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.

isConsistent back to summary

isConsistent	back to summary
public boolean isConsistent() Implements org.apache.hc.core5.http.io.HttpClientConnection.isConsistent. Doc from org.apache.hc.core5.http.io.HttpClientConnection.isConsistent. Checks whether this connection is in a consistent state. Returns:boolean `true` if the connection is known to be in a inconsistent state and cannot be re-used. Annotations @Override

public boolean isConsistent()

Implements org.apache.hc.core5.http.io.HttpClientConnection.isConsistent.

Doc from org.apache.hc.core5.http.io.HttpClientConnection.isConsistent.

Checks whether this connection is in a consistent state.

Returns:boolean

true if the connection is known to be in a inconsistent state and cannot be re-used.

Annotations

@Override

onRequestSubmitted	back to summary
protected void onRequestSubmitted(final ClassicHttpRequest request)

onResponseReceived	back to summary
protected void onResponseReceived(final ClassicHttpResponse response)

receiveResponseEntity	back to summary
public void receiveResponseEntity(final ClassicHttpResponse response) throws HttpException, IOException Implements org.apache.hc.core5.http.io.HttpClientConnection.receiveResponseEntity. Doc from org.apache.hc.core5.http.io.HttpClientConnection.receiveResponseEntity. Receives the next response entity available from this connection and attaches it to an existing HttpResponse object. Parameters response:ClassicHttpResponse 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

receiveResponseEntity

back to summary

public void receiveResponseEntity(final ClassicHttpResponse response) throws HttpException, IOException

Implements org.apache.hc.core5.http.io.HttpClientConnection.receiveResponseEntity.

Doc from org.apache.hc.core5.http.io.HttpClientConnection.receiveResponseEntity.

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

Parameters

response:ClassicHttpResponse: 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

receiveResponseHeader back to summary

receiveResponseHeader	back to summary
public ClassicHttpResponse receiveResponseHeader() throws HttpException, IOException Implements org.apache.hc.core5.http.io.HttpClientConnection.receiveResponseHeader. Doc from org.apache.hc.core5.http.io.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:ClassicHttpResponse a new HttpResponse object with status line and headers initialized or `null` if the connection has been closed by the opposite endpoint. Annotations @Override Exceptions HttpException: in case of HTTP protocol violation IOException: in case of an I/O error

public ClassicHttpResponse receiveResponseHeader() throws HttpException, IOException

Implements org.apache.hc.core5.http.io.HttpClientConnection.receiveResponseHeader.

Doc from org.apache.hc.core5.http.io.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:ClassicHttpResponse

a new HttpResponse object with status line and headers initialized or null if the connection has been closed by the opposite endpoint.

Annotations

@Override

Exceptions

HttpException:: in case of HTTP protocol violation
IOException:: in case of an I/O error

sendRequestEntity	back to summary
public void sendRequestEntity(final ClassicHttpRequest request) throws HttpException, IOException Implements org.apache.hc.core5.http.io.HttpClientConnection.sendRequestEntity. Doc from org.apache.hc.core5.http.io.HttpClientConnection.sendRequestEntity. Sends the request entity over the connection. Parameters request:ClassicHttpRequest the request whose entity to send. Annotations @Override Exceptions HttpException: in case of HTTP protocol violation IOException: in case of an I/O error

sendRequestEntity

back to summary

public void sendRequestEntity(final ClassicHttpRequest request) throws HttpException, IOException

Implements org.apache.hc.core5.http.io.HttpClientConnection.sendRequestEntity.

Doc from org.apache.hc.core5.http.io.HttpClientConnection.sendRequestEntity.

Sends the request entity over the connection.

Parameters

request:ClassicHttpRequest: the request whose entity to send.

Annotations

@Override

Exceptions

HttpException:: in case of HTTP protocol violation
IOException:: in case of an I/O error

sendRequestHeader	back to summary
public void sendRequestHeader(final ClassicHttpRequest request) throws HttpException, IOException Implements org.apache.hc.core5.http.io.HttpClientConnection.sendRequestHeader. Doc from org.apache.hc.core5.http.io.HttpClientConnection.sendRequestHeader. Sends the request line and all headers over the connection. Parameters request:ClassicHttpRequest the request whose headers to send. Annotations @Override Exceptions HttpException: in case of HTTP protocol violation IOException: in case of an I/O error

sendRequestHeader

back to summary

public void sendRequestHeader(final ClassicHttpRequest request) throws HttpException, IOException

Implements org.apache.hc.core5.http.io.HttpClientConnection.sendRequestHeader.

Doc from org.apache.hc.core5.http.io.HttpClientConnection.sendRequestHeader.

Sends the request line and all headers over the connection.

Parameters

request:ClassicHttpRequest: the request whose headers to send.

Annotations

@Override

Exceptions

HttpException:: in case of HTTP protocol violation
IOException:: in case of an I/O error

terminateRequest	back to summary
public void terminateRequest(final ClassicHttpRequest request) throws HttpException, IOException Implements org.apache.hc.core5.http.io.HttpClientConnection.terminateRequest. Doc from org.apache.hc.core5.http.io.HttpClientConnection.terminateRequest. Terminates request prematurely potentially leaving the connection in a inconsistent state. Parameters request:ClassicHttpRequest the request to be terminated prematurely. Annotations @Override

terminateRequest

back to summary

public void terminateRequest(final ClassicHttpRequest request) throws HttpException, IOException

Implements org.apache.hc.core5.http.io.HttpClientConnection.terminateRequest.

Doc from org.apache.hc.core5.http.io.HttpClientConnection.terminateRequest.

Terminates request prematurely potentially leaving the connection in a inconsistent state.

Parameters

request:ClassicHttpRequest: the request to be terminated prematurely.

Annotations

@Override

public Class DefaultBHttpClientConnection

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail