com.icfolson.aem.library.core.servlets

Class AbstractJsonResponseServlet

java.lang.Object

javax.servlet.GenericServlet

org.apache.sling.api.servlets.SlingSafeMethodsServlet

org.apache.sling.api.servlets.SlingAllMethodsServlet

com.icfolson.aem.library.core.servlets.AbstractJsonResponseServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

AbstractComponentServlet, AbstractValidatorServlet

public abstract class AbstractJsonResponseServlet
extends org.apache.sling.api.servlets.SlingAllMethodsServlet

Base servlet for writing a JSON response.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
AbstractJsonResponseServlet()

Method Summary

Modifier and Type	Method and Description
protected void	writeJsonResponse(org.apache.sling.api.SlingHttpServletResponse response, Object object) Write an object to the response as JSON.
protected void	writeJsonResponse(org.apache.sling.api.SlingHttpServletResponse response, ObjectMapper mapper, Object object) Write an object to the response as JSON using the given ObjectMapper instance.
protected void	writeJsonResponse(org.apache.sling.api.SlingHttpServletResponse response, Object object, String dateFormat) Write an object to the response as JSON.
protected void	writeJsonResponse(org.apache.sling.api.SlingHttpServletResponse response, Object object, String dateFormat, Locale locale) Write an object to the response as JSON.

Methods inherited from class org.apache.sling.api.servlets.SlingAllMethodsServlet

doDelete, doPost, doPut, getAllowedRequestMethods, isMethodValid, mayService

Methods inherited from class org.apache.sling.api.servlets.SlingSafeMethodsServlet

doGeneric, doGet, doHead, doOptions, doTrace, getServletInfo, handleMethodNotImplemented, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DATE_FORMAT

public static final String DEFAULT_DATE_FORMAT

See Also:

Constant Field Values

Constructor Detail

AbstractJsonResponseServlet

public AbstractJsonResponseServlet()

Method Detail

writeJsonResponse

protected final void writeJsonResponse(org.apache.sling.api.SlingHttpServletResponse response,
                                       Object object)
                                throws IOException,
                                       javax.servlet.ServletException

Write an object to the response as JSON.

Parameters:

response - sling response

object - object to be written as JSON

Throws:

IOException - if error occurs writing JSON response

javax.servlet.ServletException - if other error occurs

writeJsonResponse

protected final void writeJsonResponse(org.apache.sling.api.SlingHttpServletResponse response,
                                       Object object,
                                       String dateFormat)
                                throws IOException,
                                       javax.servlet.ServletException

Write an object to the response as JSON.

Parameters:

response - sling response

object - object to be written as JSON

dateFormat - SimpleDateFormat pattern for formatting Date objects using US locale

Throws:

IOException - if error occurs writing JSON response

javax.servlet.ServletException - if other error occurs

writeJsonResponse

protected final void writeJsonResponse(org.apache.sling.api.SlingHttpServletResponse response,
                                       Object object,
                                       String dateFormat,
                                       Locale locale)
                                throws IOException,
                                       javax.servlet.ServletException

Write an object to the response as JSON.

Parameters:

response - sling response

object - object to be written as JSON

dateFormat - SimpleDateFormat pattern for formatting Date objects

locale - locale for date format

Throws:

IOException - if error occurs writing JSON response

javax.servlet.ServletException - if other error occurs

writeJsonResponse

protected final void writeJsonResponse(org.apache.sling.api.SlingHttpServletResponse response,
                                       ObjectMapper mapper,
                                       Object object)
                                throws IOException,
                                       javax.servlet.ServletException

Write an object to the response as JSON using the given ObjectMapper instance.

Parameters:

response - Sling response

mapper - object mapper with a custom configuration

object - object to be written as JSON

Throws:

IOException - if error occurs writing JSON response

javax.servlet.ServletException - if other error occurs