io.cdap.http

Class AbstractHttpResponder

java.lang.Object

io.cdap.http.AbstractHttpResponder

All Implemented Interfaces:

HttpResponder

public abstract class AbstractHttpResponder
extends Object
implements HttpResponder

Base implementation of HttpResponder to simplify child implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	OCTET_STREAM_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractHttpResponder()

Method Summary

Modifier and Type	Method and Description
protected io.netty.handler.codec.http.HttpHeaders	addContentTypeIfMissing(io.netty.handler.codec.http.HttpHeaders headers, String contentType)
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.
void	sendFile(File file) Sends a file content back to client with response status 200 with content type as "application/octet-stream".
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.cdap.http.HttpResponder

sendChunkStart, sendContent, sendContent, sendFile

Field Detail

OCTET_STREAM_TYPE

protected static final String OCTET_STREAM_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractHttpResponder

public AbstractHttpResponder()

Method Detail

sendJson

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

Description copied from interface: HttpResponder

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.

Specified by:

sendJson in interface HttpResponder

Parameters:

status - Status of the response.

jsonString - The json string to send back.

sendString

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

Description copied from interface: HttpResponder

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

Specified by:

sendString in interface HttpResponder

Parameters:

status - status of the Http response.

data - string data to be sent back.

sendString

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

Description copied from interface: HttpResponder

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

Specified by:

sendString in interface HttpResponder

Parameters:

status - status of the Http response.

data - string data to be sent back.

headers - additional headers to send with the response.

sendStatus

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

Description copied from interface: HttpResponder

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

Specified by:

sendStatus in interface HttpResponder

Parameters:

status - status of the Http response.

sendStatus

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

Description copied from interface: HttpResponder

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

Specified by:

sendStatus in interface HttpResponder

Parameters:

status - status of the Http response.

headers - additional headers to send with the response.

sendByteArray

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

Description copied from interface: HttpResponder

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

Specified by:

sendByteArray in interface HttpResponder

Parameters:

status - status of the Http response.

bytes - bytes to be sent back.

headers - additional headers to send with the response.

sendBytes

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

Description copied from interface: HttpResponder

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

Specified by:

sendBytes in interface HttpResponder

Parameters:

status - status of the Http response

buffer - bytes to send

headers - additional headers to send with the response.

sendFile

public void sendFile(File file)
              throws IOException

Description copied from interface: HttpResponder

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

Specified by:

sendFile in interface HttpResponder

Parameters:

file - The file to send

Throws:

IOException - if failed to open and read the file

sendChunkStart

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

Description copied from interface: HttpResponder

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

Specified by:

sendChunkStart in interface HttpResponder

Parameters:

status - the status code to respond with

Returns:

chunk responder for sending the response

addContentTypeIfMissing

protected final io.netty.handler.codec.http.HttpHeaders addContentTypeIfMissing(io.netty.handler.codec.http.HttpHeaders headers,
                                                                                String contentType)