io.dropwizard.servlets.tasks

Class Task

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 and Description
protected	Task(String name) Create a new task with the given name.

Method Summary

Modifier and Type	Method and Description
abstract void	execute(com.google.common.collect.ImmutableMultimap<String,String> parameters, PrintWriter output) Executes the task.
String	getName() Returns the task's name,

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

Method Detail

getName

public String getName()

Returns the task's name,

Returns:

the task's name

execute

public abstract void execute(com.google.common.collect.ImmutableMultimap<String,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