com.atlassian.jira.web.task

Class TaskQuiescingServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.atlassian.jira.web.task.TaskQuiescingServlet

All Implemented Interfaces:

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

public class TaskQuiescingServlet
extends javax.servlet.http.HttpServlet

This endpoint is used by the instant upgrade feature and only works in cloud. GET returns the state of the task queue. PUT:

• Makes the queue to stop accepting requests if requested action is disableQueues
• Stops the queues and cancels all running tasks if requested action is cancelTask
• Restarts queues if requested on /resume path

This is used by zero downtime upgrades feature in cloud.

Since:

v7.1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CANCEL_TASKS
static String	DISABLE_QUEUES
static int	SC_TASKS_STILL_RUNNING
static int	SC_UNCANCELABLE_TASKS_STILL_RUNNING

Constructor Summary

Constructors

Constructor and Description
TaskQuiescingServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doPut(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles requests to stop the task manager and scheduler.

Methods inherited from class javax.servlet.http.HttpServlet

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

Field Detail

SC_UNCANCELABLE_TASKS_STILL_RUNNING

public static final int SC_UNCANCELABLE_TASKS_STILL_RUNNING

See Also:

Constant Field Values

SC_TASKS_STILL_RUNNING

public static final int SC_TASKS_STILL_RUNNING

See Also:

Constant Field Values

DISABLE_QUEUES

public static final String DISABLE_QUEUES

See Also:

Constant Field Values

CANCEL_TASKS

public static final String CANCEL_TASKS

See Also:

Constant Field Values

Constructor Detail

TaskQuiescingServlet

public TaskQuiescingServlet()

Method Detail

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

doPut

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

Handles requests to stop the task manager and scheduler. If path is /resume it restarts the task manager and scheduler. Response code:

• 200 Operation correctly performed.
• 403 Attempting to hit this servlet from outside of the containing instance
• 404 Attempting to hit this servlet on a Jira Server instance

For operation specific response codes see quiesce(javax.servlet.http.HttpServletRequest) or resume() Response body: Json representation of a ResponseObject

Overrides:

doPut in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException