uws.service.actions

Class ListJobs

java.lang.Object

uws.service.actions.UWSAction

uws.service.actions.ListJobs

All Implemented Interfaces:

java.io.Serializable

public class ListJobs
extends UWSAction

The "List Jobs" action of a UWS.

Note: The corresponding name is UWSAction.LIST_JOBS.

This action returns the list of jobs contained in the jobs list specified by the URL of the request. This list is serialized by the UWSSerializer chosen in function of the HTTP Accept header.

Version:

4.3 (10/2017)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

Serialized Form

Field Summary

Fields inherited from class uws.service.actions.UWSAction

ADD_JOB, DESTROY_JOB, GET_JOB_PARAM, HOME_PAGE, JOB_SUMMARY, LIST_JOBS, SET_JOB_PARAM, SET_UWS_PARAMETER, uws

Constructor Summary

Constructors

Constructor and Description
ListJobs(UWSService u)

Method Summary

Modifier and Type	Method and Description
boolean	apply(UWSUrl urlInterpreter, JobOwner user, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Gets the specified jobs list (and throw an error if not found), chooses the serializer and write the serialization of the jobs list in the given response.
java.lang.String	getDescription() Gets the description of this UWS action.
java.lang.String	getName() Gets the name of this UWS action.
boolean	match(UWSUrl urlInterpreter, JobOwner user, javax.servlet.http.HttpServletRequest request) Checks whether: a job list name is specified in the given UWS URL (note: the existence of the jobs list is not checked), the UWS URL does not make a reference to a job (so: no job ID), the HTTP method is HTTP-GET.

Methods inherited from class uws.service.actions.UWSAction

equals, getJob, getJob, getJob, getJob, getJobsList, getLogger, getUWS, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ListJobs

public ListJobs(UWSService u)

Method Detail

getName

public java.lang.String getName()

Description copied from class: UWSAction

Gets the name of this UWS action. MUST BE UNIQUE !

Note: By default the name of the class is returned (Class.getName()).

Overrides:

getName in class UWSAction

Returns:

Its name.

See Also:

UWSAction.LIST_JOBS, UWSAction.getName()

getDescription

public java.lang.String getDescription()

Description copied from class: UWSAction

Gets the description of this UWS action.

Note: By default an empty string is returned.

Overrides:

getDescription in class UWSAction

Returns:

Its description.

match

public boolean match(UWSUrl urlInterpreter,
                     JobOwner user,
                     javax.servlet.http.HttpServletRequest request)
              throws UWSException

Checks whether:

• a job list name is specified in the given UWS URL (note: the existence of the jobs list is not checked),
• the UWS URL does not make a reference to a job (so: no job ID),
• the HTTP method is HTTP-GET.

Specified by:

match in class UWSAction

Parameters:

urlInterpreter - The UWS URL of the given request.

user - The user who has sent the given request.

request - The received request.

Returns:

true if the given request corresponds to this UWS action, false otherwise.

Throws:

UWSException - If any error occurs during the tests.

See Also:

UWSAction.match(UWSUrl, JobOwner, HttpServletRequest)

apply

public boolean apply(UWSUrl urlInterpreter,
                     JobOwner user,
                     javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws UWSException,
                     java.io.IOException

Gets the specified jobs list (and throw an error if not found), chooses the serializer and write the serialization of the jobs list in the given response.

Specified by:

apply in class UWSAction

Parameters:

urlInterpreter - The UWS URL of the given request.

user - The user who has sent the given request.

request - The received request.

response - The response of the given request (MUST BE UPDATED).

Returns:

true if the actions has been successfully applied, false otherwise.

Throws:

UWSException - If any error occurs during the action application.

java.io.IOException - If there is an error while the result is written in the given response.

See Also:

UWSAction.getJobsList(UWSUrl), JobListRefiner.JobListRefiner(HttpServletRequest), UWSService.getSerializer(String), JobList.serialize(ServletOutputStream, UWSSerializer, JobOwner, JobListRefiner), UWSAction.apply(UWSUrl, JobOwner, HttpServletRequest, HttpServletResponse)