io.cdap.cdap.api.service.http

Interface HttpServiceResponder

public interface HttpServiceResponder

Interface with methods for sending HTTP responses.

Method Summary

Modifier and Type	Method and Description
void	send(int status, ByteBuffer content, String contentType, Iterable<? extends Map.Entry<String,String>> headers) Sends response back to client.
void	send(int status, ByteBuffer content, String contentType, Map<String,String> headers) Sends response back to client.
void	send(int status, HttpContentProducer producer, String contentType) Sends response back to client with response body produced by the given HttpContentProducer.
void	send(int status, HttpContentProducer producer, String contentType, Iterable<? extends Map.Entry<String,String>> headers) Sends response back to client with response body produced by the given HttpContentProducer.
void	send(int status, HttpContentProducer producer, String contentType, Map<String,String> headers) Sends response back to client with response body produced by the given HttpContentProducer.
void	send(int status, org.apache.twill.filesystem.Location location, String contentType) Sends response back to client using content in the given Location as the response body.
void	send(int status, org.apache.twill.filesystem.Location location, String contentType, Iterable<? extends Map.Entry<String,String>> headers) Sends response back to client using content in the given Location as the response body.
void	send(int status, org.apache.twill.filesystem.Location location, String contentType, Map<String,String> headers) Sends response back to client using content in the given Location as the response body.
void	sendError(int status, String errorMessage) Sends an error message back to the client with the specified status code.
void	sendJson(int status, Object object) Sends JSON response back to the client.
void	sendJson(int status, Object object, Type type, com.google.gson.Gson gson) Sends JSON response back to the client using the given Gson object.
void	sendJson(Object object) Sends JSON response back to the client with a default status.
void	sendStatus(int status) Sends only a status code back to client without any content.
void	sendStatus(int status, Iterable<? extends Map.Entry<String,String>> headers) Sends a status code and headers back to client without any content.
void	sendStatus(int status, Map<String,String> headers) Sends a status code and headers back to client without any content.
void	sendString(int status, String data, Charset charset) Sends a string response back to the HTTP client.
void	sendString(String data) Sends a UTF-8 encoded string response back to the HTTP client with a default response status.

Method Detail

sendJson

void sendJson(Object object)

Sends JSON response back to the client with a default status.

Parameters:

object - object that will be serialized into JSON and sent back as content

sendJson

void sendJson(int status,
              Object object)

Sends JSON response back to the client.

Parameters:

status - status of the HTTP response

object - object that will be serialized into JSON and sent back as content

sendJson

void sendJson(int status,
              Object object,
              Type type,
              com.google.gson.Gson gson)

Sends JSON response back to the client using the given Gson object.

Parameters:

status - status of the HTTP response

object - the object that will be serialized into JSON and sent back as content

type - the type of object

gson - the Gson object for serialization

sendString

void sendString(String data)

Sends a UTF-8 encoded string response back to the HTTP client with a default response status.

Parameters:

data - the string data to be sent back

sendString

void sendString(int status,
                String data,
                Charset charset)

Sends a string response back to the HTTP client.

Parameters:

status - status of the HTTP response

data - the data to be sent back

charset - the Charset used to encode the string

sendStatus

void sendStatus(int status)

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

Parameters:

status - status of the HTTP response

sendStatus

void sendStatus(int status,
                Map<String,String> headers)

Sends a status code and headers back to client without any content.

Parameters:

status - status of the HTTP response

headers - headers to send

sendStatus

void sendStatus(int status,
                Iterable<? extends Map.Entry<String,String>> headers)

Sends a status code and headers back to client without any content.

Parameters:

status - status of the HTTP response

headers - headers to send; each Map.Entry contains the header name and value to be sent, allowing multiple values for the same header name

sendError

void sendError(int status,
               String errorMessage)

Sends an error message back to the client with the specified status code.

Parameters:

status - status of the HTTP response

errorMessage - error message sent back to the client

send

void send(int status,
          ByteBuffer content,
          String contentType,
          Map<String,String> headers)

Sends response back to client.

Parameters:

status - status of the HTTP response

content - content to be sent back

contentType - type of content

headers - headers to be sent back

send

void send(int status,
          ByteBuffer content,
          String contentType,
          Iterable<? extends Map.Entry<String,String>> headers)

Sends response back to client.

Parameters:

status - status of the HTTP response

content - content to be sent back

contentType - type of content

headers - headers to send; each Map.Entry contains the header name and value to be sent, allowing multiple values for the same header name

send

void send(int status,
          HttpContentProducer producer,
          String contentType)

Sends response back to client with response body produced by the given HttpContentProducer.

Parameters:

status - status of the HTTP response

producer - a HttpContentProducer to produce content to be sent back

contentType - type of content

send

void send(int status,
          HttpContentProducer producer,
          String contentType,
          Map<String,String> headers)

Sends response back to client with response body produced by the given HttpContentProducer.

Parameters:

status - status of the HTTP response

producer - a HttpContentProducer to produce content to be sent back

contentType - type of content

headers - headers to be sent back

send

void send(int status,
          HttpContentProducer producer,
          String contentType,
          Iterable<? extends Map.Entry<String,String>> headers)

Sends response back to client with response body produced by the given HttpContentProducer.

Parameters:

status - status of the HTTP response

producer - a HttpContentProducer to produce content to be sent back

contentType - type of content

headers - headers to send; each Map.Entry contains the header name and value to be sent, allowing multiple values for the same header name

send

void send(int status,
          org.apache.twill.filesystem.Location location,
          String contentType)
   throws IOException

Sends response back to client using content in the given Location as the response body.

Parameters:

status - status of the HTTP response

location - location containing the response body

contentType - type of content

Throws:

IOException - if failed to open an InputStream from the given Location.

send

void send(int status,
          org.apache.twill.filesystem.Location location,
          String contentType,
          Map<String,String> headers)
   throws IOException

Sends response back to client using content in the given Location as the response body.

Parameters:

status - status of the HTTP response

location - location containing the response body

contentType - type of content

headers - headers to be sent back

Throws:

IOException - if failed to open an InputStream from the given Location.

send

void send(int status,
          org.apache.twill.filesystem.Location location,
          String contentType,
          Iterable<? extends Map.Entry<String,String>> headers)
   throws IOException

Sends response back to client using content in the given Location as the response body.

Parameters:

status - status of the HTTP response

location - location containing the response body

contentType - type of content

headers - headers to send; each Map.Entry contains the header name and value to be sent, allowing multiple values for the same header name

Throws:

IOException - if failed to open an InputStream from the given Location.