uws.service.actions

Class SetUWSParameter

java.lang.Object

uws.service.actions.UWSAction

uws.service.actions.SetUWSParameter

All Implemented Interfaces:

java.io.Serializable

public class SetUWSParameter
extends UWSAction

The UWS action which lets set the phase (RUN or ABORT), the execution duration and the destruction time of a job with a POST or PUT request on {job-id}/{uws-param}.

Note: The corresponding name is UWSAction.SET_UWS_PARAMETER.

Since:

4.1

Version:

4.1 (04/2015)

Author:

Grégory Mantelet (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
SetUWSParameter(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) Get the specified job (throw an error if not found), and update the specified UWS standard parameter.
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: by default, the existence of the jobs list is not checked), a job ID is given in the UWS URL (note: by default, the existence of the job is not yet checked), the job attribute "phase", "runID", "executionduration" or "destruction" is used in the UWS URL, the HTTP method is HTTP-POST or HTTP-PUT.

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

SetUWSParameter

public SetUWSParameter(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.SET_UWS_PARAMETER, 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: by default, the existence of the jobs list is not checked),
• a job ID is given in the UWS URL (note: by default, the existence of the job is not yet checked),
• the job attribute "phase", "runID", "executionduration" or "destruction" is used in the UWS URL,
• the HTTP method is HTTP-POST or HTTP-PUT.

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

Get the specified job (throw an error if not found), and update the specified UWS standard parameter.

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), UWSJob.addOrUpdateParameter(String, Object), UWSService.redirect(String, HttpServletRequest, JobOwner, String, HttpServletResponse), UWSAction.apply(UWSUrl, JobOwner, HttpServletRequest, HttpServletResponse)