public class SetJobParam extends UWSAction
The "Set Job Parameter" action of a UWS.
Note: The corresponding name is UWSAction.SET_JOB_PARAM
.
This action sets the value of the specified job attribute. The response of this action is a redirection to the job summary.
ADD_JOB, DESTROY_JOB, GET_JOB_PARAM, HOME_PAGE, JOB_SUMMARY, LIST_JOBS, SET_JOB_PARAM, SET_UWS_PARAMETER, uws
Constructor and Description |
---|
SetJobParam(UWSService u) |
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),
changes the value of the specified job attribute
and makes a redirection to the job summary.
|
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),
if the HTTP method is HTTP-POST: there is exactly one attribute and at least one parameter
if the HTTP method is HTTP-PUT: there are at least two attributes (
UWSJob.PARAM_PARAMETERS /{parameter_name}) and there are at least two parameters
|
public SetJobParam(UWSService u)
public java.lang.String getName()
UWSAction
Gets the name of this UWS action. MUST BE UNIQUE !
Note: By default the name of the class is returned (Class.getName()
).
getName
in class UWSAction
UWSAction.SET_JOB_PARAM
,
UWSAction.getName()
public java.lang.String getDescription()
UWSAction
Gets the description of this UWS action.
Note: By default an empty string is returned.
getDescription
in class UWSAction
public boolean match(UWSUrl urlInterpreter, JobOwner user, javax.servlet.http.HttpServletRequest request) throws UWSException
UWSJob.PARAM_PARAMETERS
/{parameter_name}) and there are at least two parametersmatch
in class UWSAction
urlInterpreter
- The UWS URL of the given request.user
- The user who has sent the given request.request
- The received request.UWSException
- If any error occurs during the tests.UWSAction.match(UWSUrl, JobOwner, HttpServletRequest)
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), changes the value of the specified job attribute and makes a redirection to the job summary.
apply
in class UWSAction
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).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.UWSAction.getJob(UWSUrl)
,
UWSFactory.createUWSParameters(HttpServletRequest)
,
UWSJob.addOrUpdateParameters(UWSParameters, JobOwner)
,
UWSService.redirect(String, HttpServletRequest, JobOwner, String, HttpServletResponse)
,
UWSAction.apply(UWSUrl, JobOwner, HttpServletRequest, HttpServletResponse)