uws.service.actions

Class GetJobParam

java.lang.Object

uws.service.actions.UWSAction

uws.service.actions.GetJobParam

All Implemented Interfaces:

java.io.Serializable

public class GetJobParam
extends UWSAction

The "Get Job Parameter" action of a UWS.

Note: The corresponding name is UWSAction.GET_JOB_PARAM.

This action returns the value of the specified job attribute. If the attribute is basic (i.e. jobID, startTime, ...) the value is returned with the content type text/plain whereas it is a complex type (i.e. results, parameters, ...) the value is the serialization of the job attribute itself. The serializer is choosen in function of the HTTP Accept header.

Version:

4.2 (06/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
GetJobParam(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 attribute 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	isDefaultUrl(Result result, UWSJob job) Tells whether the URL of this Result is the default one.
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 a 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

Constructor Detail

GetJobParam

public GetJobParam(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.GET_JOB_PARAM, 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 a 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 attribute in the given response.

Note: if the specified attribute is simple (i.e. jobID, runID, startTime, ...) it will not serialized ! The response will merely be the job attribute value (so, the content type will be: text/plain).

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), JobInfo.write(HttpServletResponse), UWSAction.apply(UWSUrl, JobOwner, HttpServletRequest, HttpServletResponse)

isDefaultUrl

public final boolean isDefaultUrl(Result result,
                                  UWSJob job)

Tells whether the URL of this Result is the default one. In this case, the result must be read from the result file and written in response of the HTTP request. In the other case, the result content can be fetched only by a redirection to the given URL.

Returns:

true if the URL of this Result is the default one, false if a redirection to its URL must be done to get the result content.