org.apache.qpid.server.management.plugin.servlet.rest

Class AbstractServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.qpid.server.management.plugin.servlet.rest.AbstractServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

ApiDocsServlet, ContentServlet, JsonValueServlet, MetaDataServlet, QueryServlet, QueueReportServlet, RestServlet, SaslServlet, StructureServlet, TimeZoneServlet

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_DISPOSITION
static String	CONTENT_DISPOSITION_ATTACHMENT_FILENAME_PARAM Signifies that the agent wishes the servlet to set the Content-Disposition on the response with the value attachment.
static int	SC_UNPROCESSABLE_ENTITY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doDelete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse resp)
protected void	doDelete(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, ConfiguredObject<?> managedObject)
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse resp)
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse resp, ConfiguredObject<?> managedObject)
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse resp)
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, ConfiguredObject<?> managedObject)
protected void	doPut(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse resp)
protected void	doPut(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, ConfiguredObject<?> managedObject)
protected Broker<?>	getBroker()
protected ConfiguredObjectFinder	getConfiguredObjectFinder(ConfiguredObject<?> root)
protected HttpManagementConfiguration	getManagementConfiguration()
protected OutputStream	getOutputStream(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	init()
protected void	sendCachingHeadersOnResponse(javax.servlet.http.HttpServletResponse response)
protected void	sendError(javax.servlet.http.HttpServletResponse resp, int responseCode)
protected void	sendJsonErrorResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, int responseCode, String message)
protected void	sendJsonResponse(Object object, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	sendJsonResponse(Object object, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, int responseCode, boolean sendCachingHeaders)
protected void	setContentDispositionHeaderIfNecessary(javax.servlet.http.HttpServletResponse response, String attachmentFilename)
protected void	writeContent(Content content, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	writeTypedContent(Content content, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class javax.servlet.http.HttpServlet

doHead, doOptions, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, 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

Field Detail

SC_UNPROCESSABLE_ENTITY

public static final int SC_UNPROCESSABLE_ENTITY

See Also:

Constant Field Values

CONTENT_DISPOSITION_ATTACHMENT_FILENAME_PARAM

public static final String CONTENT_DISPOSITION_ATTACHMENT_FILENAME_PARAM

Signifies that the agent wishes the servlet to set the Content-Disposition on the response with the value attachment. This filename will be derived from the parameter value.

See Also:

Constant Field Values

CONTENT_DISPOSITION

public static final String CONTENT_DISPOSITION

See Also:

Constant Field Values

Constructor Detail

AbstractServlet

protected AbstractServlet()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

doGet

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

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse resp,
                     ConfiguredObject<?> managedObject)
              throws javax.servlet.ServletException,
                     IOException

Throws:

javax.servlet.ServletException

IOException

doPost

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

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse resp,
                      ConfiguredObject<?> managedObject)
               throws javax.servlet.ServletException,
                      IOException

Throws:

javax.servlet.ServletException

IOException

doPut

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

Overrides:

doPut in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

setContentDispositionHeaderIfNecessary

protected void setContentDispositionHeaderIfNecessary(javax.servlet.http.HttpServletResponse response,
                                                      String attachmentFilename)

doPut

protected void doPut(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse resp,
                     ConfiguredObject<?> managedObject)
              throws javax.servlet.ServletException,
                     IOException

Throws:

javax.servlet.ServletException

IOException

doDelete

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

Overrides:

doDelete in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doDelete

protected void doDelete(javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse resp,
                        ConfiguredObject<?> managedObject)
                 throws javax.servlet.ServletException,
                        IOException

Throws:

javax.servlet.ServletException

IOException

getOutputStream

protected OutputStream getOutputStream(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)
                                throws IOException

Throws:

IOException

getBroker

protected Broker<?> getBroker()

getManagementConfiguration

protected HttpManagementConfiguration getManagementConfiguration()

sendJsonResponse

protected void sendJsonResponse(Object object,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws IOException

Throws:

IOException

sendJsonResponse

protected final void sendJsonResponse(Object object,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      int responseCode,
                                      boolean sendCachingHeaders)
                               throws IOException

Throws:

IOException

sendJsonErrorResponse

protected final void sendJsonErrorResponse(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response,
                                           int responseCode,
                                           String message)
                                    throws IOException

Throws:

IOException

sendError

protected void sendError(javax.servlet.http.HttpServletResponse resp,
                         int responseCode)

sendCachingHeadersOnResponse

protected void sendCachingHeadersOnResponse(javax.servlet.http.HttpServletResponse response)

writeTypedContent

protected void writeTypedContent(Content content,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws IOException

Throws:

IOException

writeContent

protected void writeContent(Content content,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws IOException

Throws:

IOException

getConfiguredObjectFinder

protected final ConfiguredObjectFinder getConfiguredObjectFinder(ConfiguredObject<?> root)