io.dropwizard.servlets.tasks

Class PostBodyTask

java.lang.Object

io.dropwizard.servlets.tasks.Task

io.dropwizard.servlets.tasks.PostBodyTask

public abstract class PostBodyTask
extends Task

A task which can be performed via the admin interface and provides the post body of the request.

See Also:

Task, TaskServlet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PostBodyTask(String name) Create a new task with the given name.
protected	PostBodyTask(String name, String responseContentType) Create a new task with the given name and response content type

Method Summary

Modifier and Type	Method and Description
void	execute(Map<String,List<String>> parameters, PrintWriter output) Deprecated. Use execute(Map, String, PrintWriter) or inherit from Task instead.
abstract void	execute(Map<String,List<String>> parameters, String body, PrintWriter output)

Methods inherited from class io.dropwizard.servlets.tasks.Task

getName, getResponseContentType

Methods inherited from class java.lang.Object

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

Constructor Detail

PostBodyTask

protected PostBodyTask(String name)

Create a new task with the given name.

Parameters:

name - the task's name

PostBodyTask

protected PostBodyTask(String name,
                       String responseContentType)

Create a new task with the given name and response content type

Parameters:

name - the task's name

responseContentType - the task's response content type

Since:

2.0

Method Detail

execute

public abstract void execute(Map<String,List<String>> parameters,
                             String body,
                             PrintWriter output)
                      throws Exception

Parameters:

parameters - the query string parameters

body - the plain text request body

output - a PrintWriter wrapping the output stream of the task

Throws:

Exception

execute

@Deprecated
public void execute(Map<String,List<String>> parameters,
                                PrintWriter output)
                         throws Exception

Deprecated. Use execute(Map, String, PrintWriter) or inherit from Task instead.

Deprecated, use execute(Map, String, PrintWriter) or inherit from Task instead.

Specified by:

execute in class Task

Parameters:

parameters - the query string parameters

output - a PrintWriter wrapping the output stream of the task

Throws:

Exception