uws.service.actions

Class JobSummary

java.lang.Object

uws.service.actions.UWSAction

uws.service.actions.JobSummary

All Implemented Interfaces:

java.io.Serializable

public class JobSummary
extends UWSAction

The "Get Job" action of a UWS.

Note: The corresponding name is UWSAction.JOB_SUMMARY.

This action returns the summary of the job specified in the given UWS URL. This summary is serialized by the UWSSerializer chosen in function of the HTTP Accept header.

Version:

4.3 (11/2017)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WAIT_PARAMETER Name of the parameter which allows the blocking behavior (for a specified or unlimited duration) of a JobSummary request.

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
JobSummary(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 job (and throw an error if not found), chooses the serializer and write the serialization of the job in the given response.
static void	block(BlockingPolicy policy, javax.servlet.http.HttpServletRequest req, UWSJob job, JobOwner user) Block the current thread until the specified duration (in seconds) is elapsed or if the execution phase of the target job changes.
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), a job ID is given in the UWS URL (note: the existence of the job is not checked), there is no job attribute, 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

Field Detail

WAIT_PARAMETER

public static final java.lang.String WAIT_PARAMETER

Name of the parameter which allows the blocking behavior (for a specified or unlimited duration) of a JobSummary request.

Since:

4.3

See Also:

Constant Field Values

Constructor Detail

JobSummary

public JobSummary(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.JOB_SUMMARY, 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),
• a job ID is given in the UWS URL (note: the existence of the job is not checked),
• there is no job attribute,
• 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 job (and throw an error if not found), chooses the serializer and write the serialization of the job 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.getJob(UWSUrl), UWSService.getSerializer(String), SerializableUWSObject.serialize(ServletOutputStream, UWSSerializer), UWSAction.apply(UWSUrl, JobOwner, HttpServletRequest, HttpServletResponse)

block

public static void block(BlockingPolicy policy,
                         javax.servlet.http.HttpServletRequest req,
                         UWSJob job,
                         JobOwner user)

Block the current thread until the specified duration (in seconds) is elapsed or if the execution phase of the target job changes.

A blocking is performed only if the given job is in an active phase (i.e. PENDING, QUEUED or EXECUTING).

This function expects the 2 following HTTP-GET parameters:

• WAIT: [MANDATORY] with a value (in seconds). The value must be a positive and not null integer expressing a duration in seconds or -1 (or any other negative value) for an infinite time. If a not legal value or no value is provided, the parameter will be merely ignored.
  This parameter raises a flag meaning a blocking is required (except if 0 is provided) and eventually a time (in seconds) to wait before stop blocking.
  If several values are provided, only the one meaning the smallest blocking waiting time will be kept. Particularly if both a negative and a positive or null value are given, only the positive or null value will be kept.
• PHASE: [OPTIONAL] A legal execution phase must be provided, otherwise this parameter will be ignored.
  This parameter indicates the phase in which the job must be at the time the blocking is required. If the current job phase is different from the specified one, no blocking will be performed. Note that the allowed phases are PENDING, QUEUED and EXECUTING, because only a job in one of these phases can be blocked.
  If several values are provided, only the last occurrence is kept.

Note: A waiting time of 0 will be interpreted as "no blocking".

Note: This function will have no effect if the given thread, the given HTTP request or the given job is NULL.

Parameters:

policy - Strategy to adopt for the blocking behavior. If NULL, the standard blocking behavior will be performed: block the duration (eventually unlimited) specified by the user.

req - The HTTP request which asked for the blocking. MUST NOT be NULL, otherwise no blocking will be performed.

job - The job associate with the HTTP request. MUST NOT be NULL, otherwise no blocking will be performed.

user - The user who asked for the blocking behavior. NULL if no user is logged in.

Since:

4.3