org.vertx.java.core.http.impl

Class DefaultHttpServerResponse

java.lang.Object

org.vertx.java.core.http.impl.DefaultHttpServerResponse

All Implemented Interfaces:

HttpServerResponse, ExceptionSupport<HttpServerResponse>, WriteStream<HttpServerResponse>

public class DefaultHttpServerResponse
extends java.lang.Object
implements HttpServerResponse

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the underlying TCP connection
HttpServerResponse	closeHandler(Handler<java.lang.Void> handler) Set a close handler for the response.
HttpServerResponse	drainHandler(Handler<java.lang.Void> handler) Set a drain handler on the stream.
void	end() Ends the response.
void	end(Buffer chunk) Same as HttpServerResponse.end() but writes some data to the response body before ending.
void	end(java.lang.String chunk) Same as HttpServerResponse.end(Buffer) but writes a String with the default encoding before ending the response.
void	end(java.lang.String chunk, java.lang.String enc) Same as HttpServerResponse.end(Buffer) but writes a String with the specified encoding before ending the response.
HttpServerResponse	exceptionHandler(Handler<java.lang.Throwable> handler) Set an exception handler.
int	getStatusCode() The HTTP status code of the response.
java.lang.String	getStatusMessage() The HTTP status message of the response.
MultiMap	headers()
boolean	isChunked() Is the response chunked?
DefaultHttpServerResponse	putHeader(java.lang.String key, java.lang.Iterable<java.lang.String> values) Put an HTTP header - fluent API
DefaultHttpServerResponse	putHeader(java.lang.String key, java.lang.String value) Put an HTTP header - fluent API
DefaultHttpServerResponse	putTrailer(java.lang.String key, java.lang.Iterable<java.lang.String> values) Put an HTTP trailer - fluent API
DefaultHttpServerResponse	putTrailer(java.lang.String key, java.lang.String value) Put an HTTP trailer - fluent API
DefaultHttpServerResponse	sendFile(java.lang.String filename) Tell the kernel to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.
DefaultHttpServerResponse	sendFile(java.lang.String filename, java.lang.String notFoundResource) Same as HttpServerResponse.sendFile(String) but also takes the path to a resource to serve if the resource is not found
DefaultHttpServerResponse	setChunked(boolean chunked) If chunked is true, this response will use HTTP chunked encoding, and each call to write to the body will correspond to a new HTTP chunk sent on the wire.
HttpServerResponse	setStatusCode(int statusCode) Set the status code
HttpServerResponse	setStatusMessage(java.lang.String statusMessage) Set the status message
HttpServerResponse	setWriteQueueMaxSize(int size) Set the maximum size of the write queue to maxSize.
MultiMap	trailers()
DefaultHttpServerResponse	write(Buffer chunk) Write a Buffer to the response body.
DefaultHttpServerResponse	write(java.lang.String chunk) Write a String to the response body, encoded in UTF-8.
DefaultHttpServerResponse	write(java.lang.String chunk, java.lang.String enc) Write a String to the response body, encoded using the encoding enc.
boolean	writeQueueFull() This will return true if there are more bytes in the write queue than the value set using WriteStream.setWriteQueueMaxSize(int)

Methods inherited from class java.lang.Object

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

Method Detail

headers

public MultiMap headers()

Specified by:

headers in interface HttpServerResponse

Returns:

The HTTP headers

trailers

public MultiMap trailers()

Specified by:

trailers in interface HttpServerResponse

Returns:

The HTTP trailers

getStatusCode

public int getStatusCode()

Description copied from interface: HttpServerResponse

The HTTP status code of the response. The default is 200 representing OK.

Specified by:

getStatusCode in interface HttpServerResponse

setStatusCode

public HttpServerResponse setStatusCode(int statusCode)

Description copied from interface: HttpServerResponse

Set the status code

Specified by:

setStatusCode in interface HttpServerResponse

Returns:

A reference to this, so multiple method calls can be chained.

getStatusMessage

public java.lang.String getStatusMessage()

Description copied from interface: HttpServerResponse

The HTTP status message of the response. If this is not specified a default value will be used depending on what HttpServerResponse.setStatusCode(int) has been set to.

Specified by:

getStatusMessage in interface HttpServerResponse

setStatusMessage

public HttpServerResponse setStatusMessage(java.lang.String statusMessage)

Description copied from interface: HttpServerResponse

Set the status message

Specified by:

setStatusMessage in interface HttpServerResponse

Returns:

A reference to this, so multiple method calls can be chained.

setChunked

public DefaultHttpServerResponse setChunked(boolean chunked)

Description copied from interface: HttpServerResponse

If chunked is true, this response will use HTTP chunked encoding, and each call to write to the body will correspond to a new HTTP chunk sent on the wire.

If chunked encoding is used the HTTP header Transfer-Encoding with a value of Chunked will be automatically inserted in the response.

If chunked is false, this response will not use HTTP chunked encoding, and therefore if any data is written the body of the response, the total size of that data must be set in the Content-Length header before any data is written to the response body.

An HTTP chunked response is typically used when you do not know the total size of the request body up front.

Specified by:

setChunked in interface HttpServerResponse

Returns:

A reference to this, so multiple method calls can be chained.

isChunked

public boolean isChunked()

Description copied from interface: HttpServerResponse

Is the response chunked?

Specified by:

isChunked in interface HttpServerResponse

putHeader

public DefaultHttpServerResponse putHeader(java.lang.String key,
                                  java.lang.String value)

Description copied from interface: HttpServerResponse

Put an HTTP header - fluent API

Specified by:

putHeader in interface HttpServerResponse

Parameters:

key - The header name

value - The header value.

Returns:

A reference to this, so multiple method calls can be chained.

putHeader

public DefaultHttpServerResponse putHeader(java.lang.String key,
                                  java.lang.Iterable<java.lang.String> values)

Description copied from interface: HttpServerResponse

Put an HTTP header - fluent API

Specified by:

putHeader in interface HttpServerResponse

Parameters:

key - The header name

values - The header values.

Returns:

A reference to this, so multiple method calls can be chained.

putTrailer

public DefaultHttpServerResponse putTrailer(java.lang.String key,
                                   java.lang.String value)

Description copied from interface: HttpServerResponse

Put an HTTP trailer - fluent API

Specified by:

putTrailer in interface HttpServerResponse

Parameters:

key - The trailer name

value - The trailer value

Returns:

A reference to this, so multiple method calls can be chained.

putTrailer

public DefaultHttpServerResponse putTrailer(java.lang.String key,
                                   java.lang.Iterable<java.lang.String> values)

Description copied from interface: HttpServerResponse

Put an HTTP trailer - fluent API

Specified by:

putTrailer in interface HttpServerResponse

Parameters:

key - The trailer name

values - The trailer values

Returns:

A reference to this, so multiple method calls can be chained.

setWriteQueueMaxSize

public HttpServerResponse setWriteQueueMaxSize(int size)

Description copied from interface: WriteStream

Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even if there is more than maxSize bytes in the write queue. This is used as an indicator by classes such as Pump to provide flow control.

Specified by:

setWriteQueueMaxSize in interface WriteStream<HttpServerResponse>

writeQueueFull

public boolean writeQueueFull()

Description copied from interface: WriteStream

This will return true if there are more bytes in the write queue than the value set using WriteStream.setWriteQueueMaxSize(int)

Specified by:

writeQueueFull in interface WriteStream<HttpServerResponse>

drainHandler

public HttpServerResponse drainHandler(Handler<java.lang.Void> handler)

Description copied from interface: WriteStream

Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue has been reduced to maxSize / 2. See Pump for an example of this being used.

Specified by:

drainHandler in interface WriteStream<HttpServerResponse>

exceptionHandler

public HttpServerResponse exceptionHandler(Handler<java.lang.Throwable> handler)

Description copied from interface: ExceptionSupport

Set an exception handler.

Specified by:

exceptionHandler in interface ExceptionSupport<HttpServerResponse>

closeHandler

public HttpServerResponse closeHandler(Handler<java.lang.Void> handler)

Description copied from interface: HttpServerResponse

Set a close handler for the response. This will be called if the underlying connection closes before the response is complete.

Specified by:

closeHandler in interface HttpServerResponse

write

public DefaultHttpServerResponse write(Buffer chunk)

Description copied from interface: HttpServerResponse

Write a Buffer to the response body.

Specified by:

write in interface HttpServerResponse

Specified by:

write in interface WriteStream<HttpServerResponse>

Returns:

A reference to this, so multiple method calls can be chained.

write

public DefaultHttpServerResponse write(java.lang.String chunk,
                              java.lang.String enc)

Description copied from interface: HttpServerResponse

Write a String to the response body, encoded using the encoding enc.

Specified by:

write in interface HttpServerResponse

Returns:

A reference to this, so multiple method calls can be chained.

write

public DefaultHttpServerResponse write(java.lang.String chunk)

Description copied from interface: HttpServerResponse

Write a String to the response body, encoded in UTF-8.

Specified by:

write in interface HttpServerResponse

Returns:

A reference to this, so multiple method calls can be chained.

end

public void end(java.lang.String chunk)

Description copied from interface: HttpServerResponse

Same as HttpServerResponse.end(Buffer) but writes a String with the default encoding before ending the response.

Specified by:

end in interface HttpServerResponse

end

public void end(java.lang.String chunk,
       java.lang.String enc)

Description copied from interface: HttpServerResponse

Same as HttpServerResponse.end(Buffer) but writes a String with the specified encoding before ending the response.

Specified by:

end in interface HttpServerResponse

end

public void end(Buffer chunk)

Description copied from interface: HttpServerResponse

Same as HttpServerResponse.end() but writes some data to the response body before ending. If the response is not chunked and no other data has been written then the Content-Length header will be automatically set

Specified by:

end in interface HttpServerResponse

close

public void close()

Description copied from interface: HttpServerResponse

Close the underlying TCP connection

Specified by:

close in interface HttpServerResponse

end

public void end()

Description copied from interface: HttpServerResponse

Ends the response. If no data has been written to the response body, the actual response won't get written until this method gets called.

Once the response has ended, it cannot be used any more.

Specified by:

end in interface HttpServerResponse

sendFile

public DefaultHttpServerResponse sendFile(java.lang.String filename)

Description copied from interface: HttpServerResponse

Tell the kernel to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to serve files.

Specified by:

sendFile in interface HttpServerResponse

sendFile

public DefaultHttpServerResponse sendFile(java.lang.String filename,
                                 java.lang.String notFoundResource)

Description copied from interface: HttpServerResponse

Same as HttpServerResponse.sendFile(String) but also takes the path to a resource to serve if the resource is not found

Specified by:

sendFile in interface HttpServerResponse