Package org.apache.hc.core5.http.impl.io

Class DefaultBHttpServerConnection

java.lang.Object

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

org.apache.hc.core5.http.impl.io.DefaultBHttpServerConnection

All Implemented Interfaces:

Closeable, AutoCloseable, HttpConnection, BHttpConnection, HttpServerConnection, SocketModalCloseable, ModalCloseable

Direct Known Subclasses:

LoggingBHttpServerConnection

public class DefaultBHttpServerConnection
extends BHttpConnectionBase
implements HttpServerConnection

Default implementation of HttpServerConnection.

Since:

4.3

Field Summary

Fields

Modifier and Type	Field	Description
private final ContentLengthStrategy	incomingContentStrategy
private final ContentLengthStrategy	outgoingContentStrategy
private final HttpMessageParser<ClassicHttpRequest>	requestParser
private final HttpMessageWriter<ClassicHttpResponse>	responseWriter
private final String	scheme

Fields inherited from class org.apache.hc.core5.http.impl.io.BHttpConnectionBase

connMetrics, endpointDetails, http1Config, inBuffer, outbuffer, socketHolderRef, version

Constructor Summary

Constructors

Constructor	Description
DefaultBHttpServerConnection(String scheme, Http1Config http1Config)
DefaultBHttpServerConnection(String scheme, Http1Config http1Config, CharsetDecoder charDecoder, CharsetEncoder charEncoder)
DefaultBHttpServerConnection(String scheme, Http1Config http1Config, CharsetDecoder charDecoder, CharsetEncoder charEncoder, ContentLengthStrategy incomingContentStrategy, ContentLengthStrategy outgoingContentStrategy, HttpMessageParserFactory<ClassicHttpRequest> requestParserFactory, HttpMessageWriterFactory<ClassicHttpResponse> responseWriterFactory)	Creates new instance of DefaultBHttpServerConnection.

Method Summary

Modifier and Type	Method	Description
void	bind(Socket socket)	Binds this connection to the given Socket.
protected void	onRequestReceived(ClassicHttpRequest request)
protected void	onResponseSubmitted(ClassicHttpResponse response)
void	receiveRequestEntity(ClassicHttpRequest request)	Receives the next request entity available from this connection and attaches it to an existing request.
ClassicHttpRequest	receiveRequestHeader()	Receives the request line and all headers available from this connection.
void	sendResponseEntity(ClassicHttpResponse response)	Sends the response entity of a response over this connection.
void	sendResponseHeader(ClassicHttpResponse response)	Sends the response line and headers of a response over this connection.

Methods inherited from class org.apache.hc.core5.http.impl.io.BHttpConnectionBase

awaitInput, bind, close, close, createContentInputStream, createContentOutputStream, createIncomingEntity, ensureOpen, flush, getEndpointDetails, getLocalAddress, getProtocolVersion, getRemoteAddress, getSocketHolder, getSocketTimeout, getSSLSession, incrementRequestCount, incrementResponseCount, isDataAvailable, isOpen, isStale, setSocketTimeout, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hc.core5.http.io.BHttpConnection

flush, isDataAvailable, isStale

Methods inherited from interface org.apache.hc.core5.http.HttpConnection

close, getEndpointDetails, getLocalAddress, getProtocolVersion, getRemoteAddress, getSSLSession, isOpen

Methods inherited from interface org.apache.hc.core5.io.ModalCloseable

close

Methods inherited from interface org.apache.hc.core5.http.SocketModalCloseable

getSocketTimeout, setSocketTimeout

Field Details

scheme

private final String scheme

incomingContentStrategy

private final ContentLengthStrategy incomingContentStrategy

outgoingContentStrategy

private final ContentLengthStrategy outgoingContentStrategy

requestParser

private final HttpMessageParser<ClassicHttpRequest> requestParser

responseWriter

private final HttpMessageWriter<ClassicHttpResponse> responseWriter

Constructor Details

DefaultBHttpServerConnection

public DefaultBHttpServerConnection(String scheme,
 Http1Config http1Config,
 CharsetDecoder charDecoder,
 CharsetEncoder charEncoder,
 ContentLengthStrategy incomingContentStrategy,
 ContentLengthStrategy outgoingContentStrategy,
 HttpMessageParserFactory<ClassicHttpRequest> requestParserFactory,
 HttpMessageWriterFactory<ClassicHttpResponse> responseWriterFactory)

Creates new instance of DefaultBHttpServerConnection.

Parameters:

scheme - protocol scheme

http1Config - Message http1Config. If null Http1Config.DEFAULT will be used.

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

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

incomingContentStrategy - incoming content length strategy. If null DefaultContentLengthStrategy.INSTANCE will be used.

outgoingContentStrategy - outgoing content length strategy. If null DefaultContentLengthStrategy.INSTANCE will be used.

requestParserFactory - request parser factory. If null DefaultHttpRequestParserFactory.INSTANCE will be used.

responseWriterFactory - response writer factory. If null DefaultHttpResponseWriterFactory.INSTANCE will be used.

DefaultBHttpServerConnection

public DefaultBHttpServerConnection(String scheme,
 Http1Config http1Config,
 CharsetDecoder charDecoder,
 CharsetEncoder charEncoder)

DefaultBHttpServerConnection

public DefaultBHttpServerConnection(String scheme,
 Http1Config http1Config)

Method Details

onRequestReceived

protected void onRequestReceived(ClassicHttpRequest request)

onResponseSubmitted

protected void onResponseSubmitted(ClassicHttpResponse response)

bind

public void bind(Socket socket)
          throws IOException

Description copied from class: BHttpConnectionBase

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 BHttpConnectionBase.isOpen() will return true.

Overrides:

bind in class BHttpConnectionBase

Parameters:

socket - the socket.

Throws:

IOException - in case of an I/O error.

receiveRequestHeader

public ClassicHttpRequest receiveRequestHeader()
                                        throws HttpException,
IOException

Description copied from interface: HttpServerConnection

Receives the request line and all headers available from this connection. The caller should examine the returned request and decide if to receive a request entity as well.

Specified by:

receiveRequestHeader in interface HttpServerConnection

Returns:

a new HttpRequest object whose request line and headers are initialized or null if the connection has been closed by the opposite endpoint.

Throws:

HttpException - in case of HTTP protocol violation

IOException - in case of an I/O error

receiveRequestEntity

public void receiveRequestEntity(ClassicHttpRequest request)
                          throws HttpException,
IOException

Description copied from interface: HttpServerConnection

Receives the next request entity available from this connection and attaches it to an existing request.

Specified by:

receiveRequestEntity in interface HttpServerConnection

Parameters:

request - the request to attach the entity to.

Throws:

HttpException - in case of HTTP protocol violation

IOException - in case of an I/O error

sendResponseHeader

public void sendResponseHeader(ClassicHttpResponse response)
                        throws HttpException,
IOException

Description copied from interface: HttpServerConnection

Sends the response line and headers of a response over this connection.

Specified by:

sendResponseHeader in interface HttpServerConnection

Parameters:

response - the response whose headers to send.

Throws:

HttpException - in case of HTTP protocol violation

IOException - in case of an I/O error

sendResponseEntity

public void sendResponseEntity(ClassicHttpResponse response)
                        throws HttpException,
IOException

Description copied from interface: HttpServerConnection

Sends the response entity of a response over this connection.

Specified by:

sendResponseEntity in interface HttpServerConnection

Parameters:

response - the response whose entity to send.

Throws:

HttpException - in case of HTTP protocol violation

IOException - in case of an I/O error