io.undertow.httpcore

Class HttpExchangeBase

java.lang.Object

io.undertow.httpcore.HttpExchangeBase

All Implemented Interfaces:

HttpExchange, OutputChannel, Closeable, AutoCloseable

public abstract class HttpExchangeBase
extends Object
implements HttpExchange, OutputChannel

Field Summary

Fields

Modifier and Type	Field and Description
protected PreCommitListener	preCommitListener

Constructor Summary

Constructors

Constructor and Description
HttpExchangeBase()

Method Summary

Modifier and Type	Method and Description
void	addWriteFunction(WriteFunction listener)
void	endExchange()
InputStream	getInputStream()
OutputChannel	getOutputChannel()
OutputStream	getOutputStream()
long	getResponseBytesSent()
boolean	isComplete() Returns true if the completion handler for this exchange has been invoked, and the request is considered finished.
boolean	isRequestComplete() Returns true if all data has been read from the request, or if there was not data.
protected boolean	isRequestEntityBodyAllowed()
boolean	isResponseComplete()
protected boolean	isResponseEntityBodyAllowed()
protected boolean	isResponseStarted()
void	setBlockingHttpExchange(BlockingHttpExchange exchange)
void	setCompletedListener(CompletedListener listener)
void	setPreCommitListener(PreCommitListener listener)
protected void	terminateRequest() Force the codec to treat the request as fully read.
protected void	terminateResponse() Force the codec to treat the response as fully written.
<T> void	writeAsync(io.netty.buffer.ByteBuf data, boolean last, IoCallback<T> callback, T context)
void	writeAsync(String data) Writes the given UTF-8 data and ends the exchange
void	writeAsync(String data, Charset charset) Writes the given data in the provided charset and ends the exchange
<T> void	writeAsync(String data, Charset charset, boolean last, IoCallback<T> callback, T context) Writes the given data in the provided charset and invokes the provided callback on completion
protected abstract <T> void	writeAsync0(io.netty.buffer.ByteBuf data, boolean last, IoCallback<T> callback, T context)
void	writeBlocking(io.netty.buffer.ByteBuf data, boolean last)
protected abstract void	writeBlocking0(io.netty.buffer.ByteBuf data, boolean last)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.undertow.httpcore.HttpExchange

addRequestHeader, addResponseHeader, clearRequestHeaders, clearResponseHeaders, close, containsRequestHeader, containsResponseHeader, discardRequest, getBufferAllocator, getDestinationAddress, getInputChannel, getIoThread, getMaxEntitySize, getProtocol, getReadTimeout, getRequestContentLength, getRequestHeader, getRequestHeaderNames, getRequestHeaders, getRequestMethod, getRequestScheme, getRequestURI, getResponseContentLength, getResponseHeader, getResponseHeaderNames, getResponseHeaders, getSourceAddress, getSslSessionInfo, getStatusCode, getUndertowOptions, getWorker, isInIoThread, isIoOperationQueued, isPushSupported, isRequestTrailerFieldsSupported, isUpgrade, isUpgradeSupported, pushResource, removeRequestHeader, removeResponseHeader, sendContinue, setMaxEntitySize, setReadTimeout, setRequestHeader, setResponseHeader, setStatusCode, setUpgradeListener

Field Detail

preCommitListener

protected PreCommitListener preCommitListener

Constructor Detail

HttpExchangeBase

public HttpExchangeBase()

Method Detail

setCompletedListener

public void setCompletedListener(CompletedListener listener)

Specified by:

setCompletedListener in interface HttpExchange

setPreCommitListener

public void setPreCommitListener(PreCommitListener listener)

Specified by:

setPreCommitListener in interface HttpExchange

terminateRequest

protected void terminateRequest()

Force the codec to treat the request as fully read. Should only be invoked by handlers which downgrade the socket or implement a transfer coding.

terminateResponse

protected void terminateResponse()

Force the codec to treat the response as fully written. Should only be invoked by handlers which downgrade the socket or implement a transfer coding.

setBlockingHttpExchange

public void setBlockingHttpExchange(BlockingHttpExchange exchange)

Specified by:

setBlockingHttpExchange in interface HttpExchange

getOutputStream

public OutputStream getOutputStream()

Specified by:

getOutputStream in interface HttpExchange

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface HttpExchange

isComplete

public boolean isComplete()

Returns true if the completion handler for this exchange has been invoked, and the request is considered finished.

Specified by:

isComplete in interface HttpExchange

isRequestComplete

public boolean isRequestComplete()

Returns true if all data has been read from the request, or if there was not data.

Specified by:

isRequestComplete in interface HttpExchange

Returns:

true if the request is complete

isResponseComplete

public boolean isResponseComplete()

Specified by:

isResponseComplete in interface HttpExchange

Returns:

true if the responses is complete

endExchange

public void endExchange()

Specified by:

endExchange in interface HttpExchange

writeAsync

public final void writeAsync(String data)

Description copied from interface: OutputChannel

Writes the given UTF-8 data and ends the exchange

Specified by:

writeAsync in interface OutputChannel

Parameters:

data - The data to write

writeAsync

public final void writeAsync(String data,
                             Charset charset)

Description copied from interface: OutputChannel

Writes the given data in the provided charset and ends the exchange

Specified by:

writeAsync in interface OutputChannel

Parameters:

data - The data to write

writeAsync

public final <T> void writeAsync(String data,
                                 Charset charset,
                                 boolean last,
                                 IoCallback<T> callback,
                                 T context)

Description copied from interface: OutputChannel

Writes the given data in the provided charset and invokes the provided callback on completion

Specified by:

writeAsync in interface OutputChannel

Parameters:

data - The data to write

addWriteFunction

public void addWriteFunction(WriteFunction listener)

Specified by:

addWriteFunction in interface HttpExchange

getOutputChannel

public OutputChannel getOutputChannel()

Specified by:

getOutputChannel in interface HttpExchange

isResponseStarted

protected boolean isResponseStarted()

writeAsync

public final <T> void writeAsync(io.netty.buffer.ByteBuf data,
                                 boolean last,
                                 IoCallback<T> callback,
                                 T context)

Specified by:

writeAsync in interface OutputChannel

writeAsync0

protected abstract <T> void writeAsync0(io.netty.buffer.ByteBuf data,
                                        boolean last,
                                        IoCallback<T> callback,
                                        T context)

writeBlocking

public final void writeBlocking(io.netty.buffer.ByteBuf data,
                                boolean last)
                         throws IOException

Specified by:

writeBlocking in interface OutputChannel

Throws:

IOException

writeBlocking0

protected abstract void writeBlocking0(io.netty.buffer.ByteBuf data,
                                       boolean last)
                                throws IOException

Throws:

IOException

getResponseBytesSent

public long getResponseBytesSent()

Specified by:

getResponseBytesSent in interface HttpExchange

Returns:

The number of bytes sent in the entity body

isResponseEntityBodyAllowed

protected boolean isResponseEntityBodyAllowed()

isRequestEntityBodyAllowed

protected boolean isRequestEntityBodyAllowed()