com.google.api.server.spi.response

Class ServletResponseResultWriter

java.lang.Object

com.google.api.server.spi.response.ServletResponseResultWriter

All Implemented Interfaces:

ResultWriter

Direct Known Subclasses:

RestResponseResultWriter

public class ServletResponseResultWriter
extends java.lang.Object
implements ResultWriter

Writes a result to a servlet response.

Constructor Summary

Constructors

Constructor and Description
ServletResponseResultWriter(javax.servlet.http.HttpServletResponse servletResponse, ApiSerializationConfig serializationConfig)
ServletResponseResultWriter(javax.servlet.http.HttpServletResponse servletResponse, ApiSerializationConfig serializationConfig, boolean prettyPrint, boolean addContentLength)

Method Summary

Modifier and Type	Method and Description
protected com.fasterxml.jackson.databind.ObjectWriter	configureWriter(com.fasterxml.jackson.databind.ObjectWriter objectWriter) Override to add additional behavior, like partial response, etc.
protected void	write(int status, java.util.Map<java.lang.String,java.lang.String> headers, java.lang.Object content)
void	write(java.lang.Object response) Writes a result JSON object.
void	writeError(ServiceException e) Writes an error response with the HTTP status code and JSON body of {"message": "<exception's message>"}.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletResponseResultWriter

public ServletResponseResultWriter(javax.servlet.http.HttpServletResponse servletResponse,
                                   ApiSerializationConfig serializationConfig)

ServletResponseResultWriter

public ServletResponseResultWriter(javax.servlet.http.HttpServletResponse servletResponse,
                                   ApiSerializationConfig serializationConfig,
                                   boolean prettyPrint,
                                   boolean addContentLength)

Method Detail

configureWriter

protected com.fasterxml.jackson.databind.ObjectWriter configureWriter(com.fasterxml.jackson.databind.ObjectWriter objectWriter)

Override to add additional behavior, like partial response, etc.

Parameters:

objectWriter - the standard object writer

Returns:

a configured writer (might be wrapped)

write

public void write(java.lang.Object response)
           throws java.io.IOException

Description copied from interface: ResultWriter

Writes a result JSON object.

Specified by:

write in interface ResultWriter

Throws:

java.io.IOException

writeError

public void writeError(ServiceException e)
                throws java.io.IOException

Description copied from interface: ResultWriter

Writes an error response with the HTTP status code and JSON body of {"message": "<exception's message>"}.

Specified by:

writeError in interface ResultWriter

Throws:

java.io.IOException

write

protected void write(int status,
                     java.util.Map<java.lang.String,java.lang.String> headers,
                     java.lang.Object content)
              throws java.io.IOException

Throws:

java.io.IOException