org.structr.rest.servlet

Class JsonRestServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.structr.rest.servlet.JsonRestServlet

All Implemented Interfaces:

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

public class JsonRestServlet
extends javax.servlet.http.HttpServlet
implements HttpServiceServlet

Implements the structr REST API. The input and output format of the JSON serialisation can be configured with the servlet init parameter "PropertyFormat". (PropertyFormat).

Author:

Christian Morgner

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	commonRequestParameters
static int	DEFAULT_VALUE_PAGE_SIZE
static String	DEFAULT_VALUE_SORT_ORDER
static String	REQUEST_PARAMETER_LOOSE_SEARCH
static String	REQUEST_PARAMETER_OFFSET_ID
static String	REQUEST_PARAMETER_PAGE_NUMBER
static String	REQUEST_PARAMETER_PAGE_SIZE
static String	REQUEST_PARAMETER_SORT_KEY
static String	REQUEST_PARAMETER_SORT_ORDER

Constructor Summary

Constructors

Constructor and Description
JsonRestServlet()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
protected void	doDelete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doHead(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doOptions(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doPut(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doTrace(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
StructrHttpServiceConfig	getConfig()
void	init()

Methods inherited from class javax.servlet.http.HttpServlet

getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.Servlet

getServletConfig, getServletInfo, init, service

Field Detail

DEFAULT_VALUE_PAGE_SIZE

public static final int DEFAULT_VALUE_PAGE_SIZE

See Also:

Constant Field Values

DEFAULT_VALUE_SORT_ORDER

public static final String DEFAULT_VALUE_SORT_ORDER

See Also:

Constant Field Values

REQUEST_PARAMETER_LOOSE_SEARCH

public static final String REQUEST_PARAMETER_LOOSE_SEARCH

See Also:

Constant Field Values

REQUEST_PARAMETER_PAGE_NUMBER

public static final String REQUEST_PARAMETER_PAGE_NUMBER

See Also:

Constant Field Values

REQUEST_PARAMETER_PAGE_SIZE

public static final String REQUEST_PARAMETER_PAGE_SIZE

See Also:

Constant Field Values

REQUEST_PARAMETER_OFFSET_ID

public static final String REQUEST_PARAMETER_OFFSET_ID

See Also:

Constant Field Values

REQUEST_PARAMETER_SORT_KEY

public static final String REQUEST_PARAMETER_SORT_KEY

See Also:

Constant Field Values

REQUEST_PARAMETER_SORT_ORDER

public static final String REQUEST_PARAMETER_SORT_ORDER

See Also:

Constant Field Values

commonRequestParameters

public static final Set<String> commonRequestParameters

Constructor Detail

JsonRestServlet

public JsonRestServlet()

Method Detail

getConfig

public StructrHttpServiceConfig getConfig()

Specified by:

getConfig in interface HttpServiceServlet

init

public void init()

Overrides:

init in class javax.servlet.GenericServlet

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

doDelete

protected void doDelete(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)
                 throws javax.servlet.ServletException,
                        IOException

Overrides:

doDelete in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doHead

protected void doHead(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response)
               throws javax.servlet.ServletException,
                      IOException

Overrides:

doHead in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doOptions

protected void doOptions(javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)
                  throws javax.servlet.ServletException,
                         IOException

Overrides:

doOptions in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response)
               throws javax.servlet.ServletException,
                      IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doPut

protected void doPut(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doPut in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doTrace

protected void doTrace(javax.servlet.http.HttpServletRequest request,
           javax.servlet.http.HttpServletResponse response)
                throws javax.servlet.ServletException,
                       IOException

Overrides:

doTrace in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException