sirius.web.tasks

Class ManagedTasksController

java.lang.Object

sirius.web.controller.BasicController

sirius.web.tasks.ManagedTasksController

All Implemented Interfaces:

Controller

public class ManagedTasksController
extends BasicController

Used to view and manage tasks.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERMISSION_SYSTEM_SCRIPTING This permission is needed to access the scripting facility of the system.

Fields inherited from class sirius.web.controller.BasicController

defaultRoute

Constructor Summary

Constructors

Constructor and Description
ManagedTasksController()

Method Summary

Modifier and Type	Method and Description
void	scripting(WebContext ctx) Displays the system scripting facility.
void	scriptingExecute(WebContext ctx, JSONStructuredOutput json) Executes the given script.
void	task(WebContext ctx, String taskId) Displays details to a running task
void	taskCancel(WebContext ctx, JSONStructuredOutput json, String taskId) Cancels the given tasks as response to an AJAX call.
void	taskInfo(WebContext ctx, JSONStructuredOutput json, String taskId) Displays details to a running task as JSON
void	tasks(WebContext ctx) Lists all active tasks
void	tasksAPI(WebContext ctx, JSONStructuredOutput json) Lists all active tasks as JSON

Methods inherited from class sirius.web.controller.BasicController

assertNotNull, assertPermission, fail, getUser, hasPermission, onError, showDeletedMessage, showSavedMessage

Methods inherited from class java.lang.Object

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

Field Detail

PERMISSION_SYSTEM_SCRIPTING

public static final String PERMISSION_SYSTEM_SCRIPTING

This permission is needed to access the scripting facility of the system. Note that this give FULL access the the whole system as ANY code can be executed. This permission should be granted to system administrators only.

See Also:

Constant Field Values

Constructor Detail

ManagedTasksController

public ManagedTasksController()

Method Detail

tasks

public void tasks(WebContext ctx)

Lists all active tasks

Parameters:

ctx - the request being handled

tasksAPI

public void tasksAPI(WebContext ctx,
                     JSONStructuredOutput json)

Lists all active tasks as JSON

Parameters:

ctx - the request being handled

json - the JSON response being generated

task

public void task(WebContext ctx,
                 String taskId)

Displays details to a running task

Parameters:

ctx - the request being handled

taskId - the id of the task to be shown

taskInfo

public void taskInfo(WebContext ctx,
                     JSONStructuredOutput json,
                     String taskId)

Displays details to a running task as JSON

Parameters:

ctx - the request being handled

json - the JSON response being generated

taskId - the id of the task to be shown

taskCancel

public void taskCancel(WebContext ctx,
                       JSONStructuredOutput json,
                       String taskId)

Cancels the given tasks as response to an AJAX call.

Parameters:

ctx - the request being handled

json - the JSON response being generated

taskId - the id of the task to be shown

scripting

public void scripting(WebContext ctx)

Displays the system scripting facility.

Parameters:

ctx - the request being handled

scriptingExecute

public void scriptingExecute(WebContext ctx,
                             JSONStructuredOutput json)
                      throws IOException

Executes the given script.

Parameters:

ctx - the request being handled

json - the response sent to the browser

Throws:

IOException - in case of an io error