eu.europeana.cloud.service.dps.rest

Class TopologyTasksResource

java.lang.Object

eu.europeana.cloud.service.dps.rest.TopologyTasksResource

@Path(value="/topologies/{topologyName}/tasks")
@Component
public class TopologyTasksResource
extends Object

Resource to fetch / submit Tasks to the DPS service

Field Summary

Fields

Modifier and Type	Field and Description
static String	TASK_PREFIX

Constructor Summary

Constructors

Constructor and Description
TopologyTasksResource()

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	checkKillFlag(String topologyName, String taskId) Check kill flag for the specified task.
eu.europeana.cloud.service.dps.DpsTask	getTask(String topologyName, String taskId) Retrieves a task with the given taskId from the specified topology.
String	getTaskNotification(String taskId) Retrieves notifications for the specified task.
javax.ws.rs.core.Response	getTaskProgress(String topologyName, String taskId) Retrieves the current progress for the requested task.
javax.ws.rs.core.Response	grantPermissions(String topologyName, String taskId, String username) Grants read / write permissions for a task to the specified user.
javax.ws.rs.core.Response	killTask(String topologyName, String taskId) Submit kill flag to the specific task.
javax.ws.rs.core.Response	removeKillFlag(String topologyName, String taskId) Remove kill flag for the specified task.
javax.ws.rs.core.Response	submitTask(javax.ws.rs.container.AsyncResponse asyncResponse, eu.europeana.cloud.service.dps.DpsTask task, String topologyName, javax.ws.rs.core.UriInfo uriInfo, String authorizationHeader) Submits a Task for execution.

Methods inherited from class java.lang.Object

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

Field Detail

TASK_PREFIX

public static final String TASK_PREFIX

See Also:

Constant Field Values

Constructor Detail

TopologyTasksResource

public TopologyTasksResource()

Method Detail

getTask

@GET
@PreAuthorize(value="hasPermission(#taskId,\'DPS_Task\', read)")
@Produces(value={"application/json","application/xml"})
@Path(value="/{taskId}")
public eu.europeana.cloud.service.dps.DpsTask getTask(@PathParam(value="topologyName")
                                                                            String topologyName,
                                                                            @PathParam(value="taskId")
                                                                            String taskId)
                                               throws eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException

Retrieves a task with the given taskId from the specified topology.

Required permissions:

• Authenticated user
• Read permission for selected task

Parameters:

topologyName - REQUIRED Name of the topology where the task is submitted.

taskId - REQUIRED Unique id that identifies the task.

Returns:

The requested task.

Throws:

eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException - if topology does not exist or access to the topology is denied for the user

getTaskProgress

@GET
@Path(value="{taskId}/progress")
@PreAuthorize(value="hasPermission(#taskId,\'DPS_Task\', read)")
public javax.ws.rs.core.Response getTaskProgress(@PathParam(value="topologyName")
                                                              String topologyName,
                                                              @PathParam(value="taskId")
                                                              String taskId)
                                          throws eu.europeana.cloud.service.dps.exception.AccessDeniedOrObjectDoesNotExistException,
                                                 eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException

Retrieves the current progress for the requested task.

Required permissions:

• Read permissions for selected task

Parameters:

topologyName - REQUIRED Name of the topology where the task is submitted.

taskId - REQUIRED Unique id that identifies the task.

Returns:

Progress for the requested task (number of records of the specified task that have been fully processed).

Throws:

eu.europeana.cloud.service.dps.exception.AccessDeniedOrObjectDoesNotExistException - if task does not exist or access to the task is denied for the user

eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException - if topology does not exist or access to the topology is denied for the user

submitTask

@POST
@Consumes(value="application/json")
@PreAuthorize(value="hasPermission(#topologyName,\'Topology\', write)")
@ManagedAsync
@Path(value="/")
public javax.ws.rs.core.Response submitTask(@Suspended
                                                                                javax.ws.rs.container.AsyncResponse asyncResponse,
                                                                                eu.europeana.cloud.service.dps.DpsTask task,
                                                                                @PathParam(value="topologyName")
                                                                                String topologyName,
                                                                                @Context
                                                                                javax.ws.rs.core.UriInfo uriInfo,
                                                                                @HeaderParam(value="Authorization")
                                                                                String authorizationHeader)
                                     throws eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException,
                                            eu.europeana.cloud.service.dps.service.utils.validation.DpsTaskValidationException

Submits a Task for execution. Each Task execution is associated with a specific plugin.

Write permissions required.

Parameters:

task - REQUIRED Task to be executed. Should contain links to input data, either in form of cloud-records or cloud-datasets.

topologyName - REQUIRED Name of the topology where the task is submitted.

Returns:

URI with information about the submitted task execution.

Throws:

eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException - if topology does not exist or access to the topology is denied for the user

eu.europeana.cloud.service.dps.service.utils.validation.DpsTaskValidationException

getTaskNotification

@GET
@Path(value="{taskId}/notification")
@PreAuthorize(value="hasPermission(#taskId,\'DPS_Task\', read)")
public String getTaskNotification(@PathParam(value="taskId")
                                               String taskId)

Retrieves notifications for the specified task.

Required permissions:

• Authenticated user
• Read permission for selected task

Parameters:

taskId - REQUIRED Unique id that identifies the task.

Returns:

Notification messages for the specified task.

grantPermissions

@POST
@Path(value="{taskId}/permit")
@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response grantPermissions(@PathParam(value="topologyName")
                                                                String topologyName,
                                                                @PathParam(value="taskId")
                                                                String taskId,
                                                                @FormParam(value="username")
                                                                String username)
                                           throws eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException

Grants read / write permissions for a task to the specified user.

Required permissions:

• Admin permissions

Parameters:

taskId - REQUIRED Unique id that identifies the task.

topologyName - REQUIRED Name of the topology where the task is submitted.

username - REQUIRED Permissions are granted to the account with this unique username

Returns:

Status code indicating whether the operation was successful or not.

Throws:

eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException - if topology does not exist or access to the topology is denied for the user

killTask

@POST
@Path(value="{taskId}/kill")
@PreAuthorize(value="hasPermission(#taskId,\'DPS_Task\', write)")
public javax.ws.rs.core.Response killTask(@PathParam(value="topologyName")
                                                        String topologyName,
                                                        @PathParam(value="taskId")
                                                        String taskId)
                                   throws eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException

Submit kill flag to the specific task.

Side effect: remove all flags older than 5 days (per topology).

Required permissions:

• Authenticated user
• Write permission for selected task

Parameters:

taskId - REQUIRED Unique id that identifies the task.

topologyName - REQUIRED Name of the topology where the task is submitted.

Returns:

Status code indicating whether the operation was successful or not.

Throws:

eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException - if topology does not exist or access to the topology is denied for the user

checkKillFlag

@GET
@Path(value="{taskId}/kill")
@PreAuthorize(value="hasPermission(#taskId,\'DPS_Task\', read)")
public Boolean checkKillFlag(@PathParam(value="topologyName")
                                          String topologyName,
                                          @PathParam(value="taskId")
                                          String taskId)
                      throws eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException

Check kill flag for the specified task.

Required permissions:

• Authenticated user
• Read permission for selected task

Parameters:

topologyName - REQUIRED Name of the topology where the task is submitted.

taskId - REQUIRED Unique id that identifies the task.

Returns:

true if provided task id has kill flag, false otherwise

Throws:

eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException - if topology does not exist or access to the topology is denied for the user

removeKillFlag

@DELETE
@Path(value="{taskId}/kill")
@PreAuthorize(value="hasPermission(#taskId,\'DPS_Task\', write)")
public javax.ws.rs.core.Response removeKillFlag(@PathParam(value="topologyName")
                                                                String topologyName,
                                                                @PathParam(value="taskId")
                                                                String taskId)
                                         throws eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException

Remove kill flag for the specified task.

Required permissions:

• Authenticated user
• Write permission for selected task

Parameters:

topologyName - REQUIRED Name of the topology where the task is submitted.

taskId - REQUIRED Unique id that identifies the task.

Returns:

Status code indicating whether the operation was successful or not.

Throws:

eu.europeana.cloud.service.dps.exception.AccessDeniedOrTopologyDoesNotExistException - if topology does not exist or access to the topology is denied for the user