package io.dropwizard.servlets.tasks;

import java.io.PrintWriter;
import java.util.List;
import java.util.Map;

A task which can be performed via the admin interface and provides the post body of the request.
See Also:
/** * A task which can be performed via the admin interface and provides the post body of the request. * * @see Task * @see TaskServlet */
public abstract class PostBodyTask extends Task {
Create a new task with the given name.
Params:
  • name – the task's name
/** * Create a new task with the given name. * * @param name the task's name */
protected PostBodyTask(String name) { super(name); }
Create a new task with the given name and response content type
Params:
  • name – the task's name
  • responseContentType – the task's response content type
Since:2.0
/** * Create a new task with the given name and response content type * * @param name the task's name * @param responseContentType the task's response content type * @since 2.0 */
protected PostBodyTask(String name, String responseContentType) { super(name, responseContentType); }
Params:
  • parameters – the query string parameters
  • body – the plain text request body
  • output – a PrintWriter wrapping the output stream of the task
Throws:
/** * @param parameters the query string parameters * @param body the plain text request body * @param output a {@link PrintWriter} wrapping the output stream of the task * @throws Exception */
public abstract void execute(Map<String, List<String>> parameters, String body, PrintWriter output) throws Exception;
Deprecated, use execute(Map<String,List<String>>, String, PrintWriter) or inherit from Task instead.
Params:
  • parameters – the query string parameters
  • output – a PrintWriter wrapping the output stream of the task
Throws:
Deprecated:Use execute(Map<String,List<String>>, String, PrintWriter) or inherit from Task instead.
/** * Deprecated, use {@link #execute(Map, String, PrintWriter)} or inherit from Task instead. * * @param parameters the query string parameters * @param output a {@link PrintWriter} wrapping the output stream of the task * @throws Exception * @deprecated Use {@link #execute(Map, String, PrintWriter)} or inherit from Task instead. */
@Override @Deprecated public void execute(Map<String, List<String>> parameters, PrintWriter output) throws Exception { throw new UnsupportedOperationException("Use `execute(parameters, body, output)`"); } }