Task (Dropwizard Servlet Support 4.0.14 API)

java.lang.Object
- io.dropwizard.servlets.tasks.Task

Direct Known Subclasses:

GarbageCollectionTask, LogConfigurationTask, PostBodyTask
```
public abstract class Task
extends Object
```
An arbitrary administrative task which can be performed via the admin interface.

See Also:

TaskServlet

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`Task(String name)`	Create a new task with the given name.
`protected`	`Task(String name, @Nullable String responseContentType)`	Create a new task with the given name and response content type

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract void`	`execute(Map<String,List<String>> parameters, PrintWriter output)`	Executes the task.
`String`	`getName()`	Returns the task's name,
`Optional<String>`	`getResponseContentType()`	Returns the task's response content type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Task
```
protected Task(String name)
```
    Create a new task with the given name.
    
    Parameters:
    
    name - the task's name
  - Task
```
protected Task(String name,
               @Nullable 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
  - getName
```
public String getName()
```
    Returns the task's name,
    
    Returns:
    
    the task's name
  - getResponseContentType
```
public Optional<String> getResponseContentType()
```
    Returns the task's response content type.
    
    Returns:
    
    the task's response content type
    
    Since:
    
    2.0
  - execute
```
public abstract void execute(Map<String,List<String>> parameters,
                             PrintWriter output)
                      throws Exception
```
    Executes the task.
    
    Parameters:
    
    parameters - the query string parameters
    
    output - a PrintWriter wrapping the output stream of the task
    
    Throws:
    
    Exception - if something goes wrong