org.jumpmind.symmetric.web
Class AbstractServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.jumpmind.symmetric.web.AbstractServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

AbstractResourceServlet, SymmetricServlet

public abstract class AbstractServlet
extends javax.servlet.http.HttpServlet

See Also:

Serialized Form

Constructor Summary

AbstractServlet()

Method Summary

protected java.io.InputStream	createInputStream(javax.servlet.http.HttpServletRequest req)
protected java.io.OutputStream	createOutputStream(javax.servlet.http.HttpServletResponse resp)
protected void	doDelete(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doHead(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doOptions(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doPut(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doTrace(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected org.springframework.context.ApplicationContext	getDefaultApplicationContext()
protected abstract org.apache.commons.logging.Log	getLogger()
protected java.lang.String	getParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name) Returns the parameter with that name, trimmed to null
protected java.lang.String	getParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String defaultValue) Returns the parameter with that name, trimmed to null.
protected long	getParameterAsNumber(javax.servlet.http.HttpServletRequest request, java.lang.String name)
protected void	handleDelete(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Override me to do real work.
protected void	handleGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Override me to do real work.
protected void	handleHead(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Override me to do real work.
protected void	handleOptions(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Override me to do real work.
protected void	handlePost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Override me to do real work.
protected void	handlePut(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Override me to do real work.
protected void	handleTrace(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Override me to do real work.
protected boolean	sendError(javax.servlet.http.HttpServletResponse resp, int statusCode) Because you can't send an error when the response is already committed, this helps to avoid unnecessary errors in the logs.
protected boolean	sendError(javax.servlet.http.HttpServletResponse resp, int statusCode, java.lang.String message) Because you can't send an error when the response is already committed, this helps to avoid unnecessary errors in the logs.

Methods inherited from class javax.servlet.http.HttpServlet

getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractServlet

public AbstractServlet()

Method Detail

getLogger

protected abstract org.apache.commons.logging.Log getLogger()

createOutputStream

protected java.io.OutputStream createOutputStream(javax.servlet.http.HttpServletResponse resp)
                                           throws java.io.IOException

Throws:

java.io.IOException

createInputStream

protected java.io.InputStream createInputStream(javax.servlet.http.HttpServletRequest req)
                                         throws java.io.IOException

Throws:

java.io.IOException

getDefaultApplicationContext

protected org.springframework.context.ApplicationContext getDefaultApplicationContext()

doGet

protected final void doGet(javax.servlet.http.HttpServletRequest req,
                           javax.servlet.http.HttpServletResponse resp)
                    throws javax.servlet.ServletException,
                           java.io.IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

handleGet

protected void handleGet(javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse resp)
                  throws java.lang.Exception

Override me to do real work. Remember that a GET should be idempotent and safe. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html.

Parameters:

req -

resp -

Throws:

java.io.IOException

javax.servlet.ServletException

java.lang.Exception - everything else that could go wrong!

doPost

protected final void doPost(javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse resp)
                     throws javax.servlet.ServletException,
                            java.io.IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

handlePost

protected void handlePost(javax.servlet.http.HttpServletRequest req,
                          javax.servlet.http.HttpServletResponse resp)
                   throws java.lang.Exception

Override me to do real work. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html.

Parameters:

req -

resp -

Throws:

java.io.IOException

javax.servlet.ServletException

java.lang.Exception - everything else that could go wrong!

doPut

protected final void doPut(javax.servlet.http.HttpServletRequest req,
                           javax.servlet.http.HttpServletResponse resp)
                    throws javax.servlet.ServletException,
                           java.io.IOException

Overrides:

doPut in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

handlePut

protected void handlePut(javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse resp)
                  throws java.lang.Exception

Override me to do real work. Remember that a PUT should be idempotent. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html.

Parameters:

req -

resp -

Throws:

java.io.IOException

javax.servlet.ServletException

java.lang.Exception - everything else that could go wrong!

doDelete

protected final void doDelete(javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse resp)
                       throws javax.servlet.ServletException,
                              java.io.IOException

Overrides:

doDelete in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

handleDelete

protected void handleDelete(javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse resp)
                     throws java.lang.Exception

Override me to do real work. Remember that a DELETE should be idempotent. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html.

Parameters:

req -

resp -

Throws:

java.io.IOException

javax.servlet.ServletException

java.lang.Exception - everything else that could go wrong!

doHead

protected void doHead(javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse resp)
               throws javax.servlet.ServletException,
                      java.io.IOException

Overrides:

doHead in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

handleHead

protected void handleHead(javax.servlet.http.HttpServletRequest req,
                          javax.servlet.http.HttpServletResponse resp)
                   throws java.lang.Exception

Override me to do real work. Remember that a HEAD should be idempotent and safe. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html.

Parameters:

req -

resp -

Throws:

java.io.IOException

javax.servlet.ServletException

java.lang.Exception - everything else that could go wrong!

doOptions

protected void doOptions(javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse resp)
                  throws javax.servlet.ServletException,
                         java.io.IOException

Overrides:

doOptions in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

handleOptions

protected void handleOptions(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp)
                      throws java.lang.Exception

Override me to do real work. Remember that a OPTIONS should be idempotent and safe. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html.

Parameters:

req -

resp -

Throws:

java.io.IOException

javax.servlet.ServletException

java.lang.Exception - everything else that could go wrong!

doTrace

protected void doTrace(javax.servlet.http.HttpServletRequest req,
                       javax.servlet.http.HttpServletResponse resp)
                throws javax.servlet.ServletException,
                       java.io.IOException

Overrides:

doTrace in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

handleTrace

protected void handleTrace(javax.servlet.http.HttpServletRequest req,
                           javax.servlet.http.HttpServletResponse resp)
                    throws java.lang.Exception

Override me to do real work. Remember that a TRACE should be idempotent. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html.

Parameters:

req -

resp -

Throws:

java.io.IOException

javax.servlet.ServletException

java.lang.Exception - everything else that could go wrong!

sendError

protected boolean sendError(javax.servlet.http.HttpServletResponse resp,
                            int statusCode)
                     throws java.io.IOException

Because you can't send an error when the response is already committed, this helps to avoid unnecessary errors in the logs.

Parameters:

resp -

statusCode -

Throws:

java.io.IOException

sendError

protected boolean sendError(javax.servlet.http.HttpServletResponse resp,
                            int statusCode,
                            java.lang.String message)
                     throws java.io.IOException

Because you can't send an error when the response is already committed, this helps to avoid unnecessary errors in the logs.

Parameters:

resp -

statusCode -

message - a message to put in the body of the response

Throws:

java.io.IOException

getParameter

protected java.lang.String getParameter(javax.servlet.http.HttpServletRequest request,
                                        java.lang.String name)

Returns the parameter with that name, trimmed to null

Parameters:

request -

name -

Returns:

getParameter

protected java.lang.String getParameter(javax.servlet.http.HttpServletRequest request,
                                        java.lang.String name,
                                        java.lang.String defaultValue)

Returns the parameter with that name, trimmed to null. If the trimmed string is null, defaults to the defaultValue.

Parameters:

request -

name -

Returns:

getParameterAsNumber

protected long getParameterAsNumber(javax.servlet.http.HttpServletRequest request,
                                    java.lang.String name)