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

Class RestServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

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

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

All Implemented Interfaces:

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

public class RestServlet
extends AbstractServlet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTUALS_PARAM
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	DEFAULT_DEPTH
static int	DEFAULT_OVERSIZE
static String	DEPTH_PARAM
static String	EXTRACT_INITIAL_CONFIG_PARAM
static String	INCLUDE_SYS_CONTEXT_PARAM
static String	INHERITED_ACTUALS_PARAM
static String	OVERSIZE_PARAM
static Set<String>	RESERVED_PARAMS
static int	SC_UNPROCESSABLE_ENTITY
static String	SORT_PARAM

Fields inherited from class org.apache.qpid.server.management.plugin.servlet.rest.AbstractServlet

CONTENT_DISPOSITION

Constructor Summary

Constructors

Constructor and Description
RestServlet()
RestServlet(Class<? extends ConfiguredObject>... hierarchy)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDeleteWithSubjectAndActor(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Performs the PUT action as the logged-in Subject.
protected void	doGetWithSubjectAndActor(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Performs the GET action as the logged-in Subject.
protected void	doPostWithSubjectAndActor(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Performs the POST action as the logged-in Subject.
protected void	doPutWithSubjectAndActor(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Performs the PUT action as the logged-in Subject.
protected Collection<ConfiguredObject<?>>	getObjects(javax.servlet.http.HttpServletRequest request)
void	init()
protected void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class org.apache.qpid.server.management.plugin.servlet.rest.AbstractServlet

doDelete, doGet, doPost, doPut, getAuthorisedSubject, getBroker, getManagementConfiguration, getOutputStream, getPathInfoElements, sendCachingHeadersOnResponse, sendError, sendJsonErrorResponse, sendJsonResponse, sendJsonResponse, writeTypedContent

Methods inherited from class javax.servlet.http.HttpServlet

doHead, doOptions, doTrace, getLastModified, 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

DEPTH_PARAM

public static final String DEPTH_PARAM

See Also:

Constant Field Values

OVERSIZE_PARAM

public static final String OVERSIZE_PARAM

See Also:

Constant Field Values

ACTUALS_PARAM

public static final String ACTUALS_PARAM

See Also:

Constant Field Values

SORT_PARAM

public static final String SORT_PARAM

See Also:

Constant Field Values

INCLUDE_SYS_CONTEXT_PARAM

public static final String INCLUDE_SYS_CONTEXT_PARAM

See Also:

Constant Field Values

INHERITED_ACTUALS_PARAM

public static final String INHERITED_ACTUALS_PARAM

See Also:

Constant Field Values

EXTRACT_INITIAL_CONFIG_PARAM

public static final String EXTRACT_INITIAL_CONFIG_PARAM

See Also:

Constant Field Values

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

RESERVED_PARAMS

public static final Set<String> RESERVED_PARAMS

DEFAULT_DEPTH

public static final int DEFAULT_DEPTH

See Also:

Constant Field Values

DEFAULT_OVERSIZE

public static final int DEFAULT_OVERSIZE

See Also:

Constant Field Values

Constructor Detail

RestServlet

public RestServlet()

RestServlet

public RestServlet(Class<? extends ConfiguredObject>... hierarchy)

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class AbstractServlet

Throws:

javax.servlet.ServletException

getObjects

protected Collection<ConfiguredObject<?>> getObjects(javax.servlet.http.HttpServletRequest request)

doGetWithSubjectAndActor

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

Description copied from class: AbstractServlet

Performs the GET action as the logged-in Subject. Subclasses commonly override this method

Overrides:

doGetWithSubjectAndActor in class AbstractServlet

Throws:

javax.servlet.ServletException

IOException

doPutWithSubjectAndActor

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

Description copied from class: AbstractServlet

Performs the PUT action as the logged-in Subject. Subclasses commonly override this method

Overrides:

doPutWithSubjectAndActor in class AbstractServlet

Throws:

javax.servlet.ServletException

IOException

service

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

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doDeleteWithSubjectAndActor

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

Description copied from class: AbstractServlet

Performs the PUT action as the logged-in Subject. Subclasses commonly override this method

Overrides:

doDeleteWithSubjectAndActor in class AbstractServlet

Throws:

javax.servlet.ServletException

IOException

doPostWithSubjectAndActor

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

Description copied from class: AbstractServlet

Performs the POST action as the logged-in Subject. Subclasses commonly override this method

Overrides:

doPostWithSubjectAndActor in class AbstractServlet

Throws:

javax.servlet.ServletException

IOException