io.cdap.http

Interface HttpResponder

All Known Implementing Classes:

AbstractHttpResponder

public interface HttpResponder

HttpResponder is used to send response back to clients.

Method Summary

Modifier and Type	Method and Description
void	sendByteArray(io.netty.handler.codec.http.HttpResponseStatus status, byte[] bytes, io.netty.handler.codec.http.HttpHeaders headers) Send a response containing raw bytes.
void	sendBytes(io.netty.handler.codec.http.HttpResponseStatus status, ByteBuffer buffer, io.netty.handler.codec.http.HttpHeaders headers) Sends a response containing raw bytes.
ChunkResponder	sendChunkStart(io.netty.handler.codec.http.HttpResponseStatus status) Respond to the client saying the response will be in chunks.
ChunkResponder	sendChunkStart(io.netty.handler.codec.http.HttpResponseStatus status, io.netty.handler.codec.http.HttpHeaders headers) Respond to the client saying the response will be in chunks.
void	sendContent(io.netty.handler.codec.http.HttpResponseStatus status, BodyProducer bodyProducer, io.netty.handler.codec.http.HttpHeaders headers) Sends response back to client.
void	sendContent(io.netty.handler.codec.http.HttpResponseStatus status, io.netty.buffer.ByteBuf content, io.netty.handler.codec.http.HttpHeaders headers) Send response back to client.
void	sendFile(File file) Sends a file content back to client with response status 200 with content type as "application/octet-stream".
void	sendFile(File file, io.netty.handler.codec.http.HttpHeaders headers) Sends a file content back to client with response status 200.
void	sendJson(io.netty.handler.codec.http.HttpResponseStatus status, String jsonString) Sends json response back to the client.
void	sendStatus(io.netty.handler.codec.http.HttpResponseStatus status) Send only a status code back to client without any content.
void	sendStatus(io.netty.handler.codec.http.HttpResponseStatus status, io.netty.handler.codec.http.HttpHeaders headers) Send only a status code back to client without any content.
void	sendString(io.netty.handler.codec.http.HttpResponseStatus status, String data) Send a string response in UTF-8 encoding back to the http client.
void	sendString(io.netty.handler.codec.http.HttpResponseStatus status, String data, io.netty.handler.codec.http.HttpHeaders headers) Send a string response in UTF-8 encoding back to the http client.

Method Detail

sendJson

void sendJson(io.netty.handler.codec.http.HttpResponseStatus status,
              String jsonString)

Sends json response back to the client. This is a convenient method to send json encoded string with content type automatically set to application/json.

Parameters:

status - Status of the response.

jsonString - The json string to send back.

sendString

void sendString(io.netty.handler.codec.http.HttpResponseStatus status,
                String data)

Send a string response in UTF-8 encoding back to the http client.

Parameters:

status - status of the Http response.

data - string data to be sent back.

sendString

void sendString(io.netty.handler.codec.http.HttpResponseStatus status,
                String data,
                io.netty.handler.codec.http.HttpHeaders headers)

Send a string response in UTF-8 encoding back to the http client.

Parameters:

status - status of the Http response.

data - string data to be sent back.

headers - additional headers to send with the response.

sendStatus

void sendStatus(io.netty.handler.codec.http.HttpResponseStatus status)

Send only a status code back to client without any content.

Parameters:

status - status of the Http response.

sendStatus

void sendStatus(io.netty.handler.codec.http.HttpResponseStatus status,
                io.netty.handler.codec.http.HttpHeaders headers)

Send only a status code back to client without any content.

Parameters:

status - status of the Http response.

headers - additional headers to send with the response.

sendByteArray

void sendByteArray(io.netty.handler.codec.http.HttpResponseStatus status,
                   byte[] bytes,
                   io.netty.handler.codec.http.HttpHeaders headers)

Send a response containing raw bytes. Default content type is "application/octet-stream", but can be overridden by the headers parameter.

Parameters:

status - status of the Http response.

bytes - bytes to be sent back.

headers - additional headers to send with the response.

sendBytes

void sendBytes(io.netty.handler.codec.http.HttpResponseStatus status,
               ByteBuffer buffer,
               io.netty.handler.codec.http.HttpHeaders headers)

Sends a response containing raw bytes. Default content type is "application/octet-stream", but can be overridden by the headers parameter.

Parameters:

status - status of the Http response

buffer - bytes to send

headers - additional headers to send with the response.

sendChunkStart

ChunkResponder sendChunkStart(io.netty.handler.codec.http.HttpResponseStatus status)

Respond to the client saying the response will be in chunks. The response body can be sent in chunks using the ChunkResponder returned.

Parameters:

status - the status code to respond with

Returns:

chunk responder for sending the response

sendChunkStart

ChunkResponder sendChunkStart(io.netty.handler.codec.http.HttpResponseStatus status,
                              io.netty.handler.codec.http.HttpHeaders headers)

Respond to the client saying the response will be in chunks. The response body can be sent in chunks using the ChunkResponder returned.

Parameters:

status - the status code to respond with

headers - additional headers to send with the response.

Returns:

chunk responder for sending the response

sendContent

void sendContent(io.netty.handler.codec.http.HttpResponseStatus status,
                 io.netty.buffer.ByteBuf content,
                 io.netty.handler.codec.http.HttpHeaders headers)

Send response back to client. Default content type is "application/octet-stream", but can be overridden by the headers parameter.

Parameters:

status - Status of the response.

content - Content to be sent back.

headers - additional headers to send with the response.

sendFile

void sendFile(File file)
       throws IOException

Sends a file content back to client with response status 200 with content type as "application/octet-stream".

Parameters:

file - The file to send

Throws:

IOException - if failed to open and read the file

sendFile

void sendFile(File file,
              io.netty.handler.codec.http.HttpHeaders headers)
       throws IOException

Sends a file content back to client with response status 200. Default content type is "application/octet-stream", but can be overridden by the headers parameter.

Parameters:

file - The file to send

headers - additional headers to send with the response.

Throws:

IOException - if failed to open and read the file

sendContent

void sendContent(io.netty.handler.codec.http.HttpResponseStatus status,
                 BodyProducer bodyProducer,
                 io.netty.handler.codec.http.HttpHeaders headers)

Sends response back to client. The response body is produced by the given BodyProducer. This method will return immediate after it is called. Invocation of methods on the given BodyProducer will be triggered from another thread. Default content type is "application/octet-stream", but can be overridden by the headers parameter.

Parameters:

status - Status of the response.

bodyProducer - a BodyProducer to produce response body.

headers - additional headers to send with the response.