uws.job.serializer

Class JSONSerializer

java.lang.Object

uws.job.serializer.UWSSerializer

uws.job.serializer.JSONSerializer

All Implemented Interfaces:

java.io.Serializable

public class JSONSerializer
extends UWSSerializer

Lets serializing any UWS resource in JSON.

Version:

4.3 (03/2018)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

Json4Uws, Serialized Form

Field Summary

Fields inherited from class uws.job.serializer.UWSSerializer

MIME_TYPE_HTML, MIME_TYPE_JSON, MIME_TYPE_TEXT, MIME_TYPE_XML

Constructor Summary

Constructors

Constructor and Description
JSONSerializer()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdditionalParameter(java.lang.String paramName, java.lang.Object paramValue, boolean root) Serializes the specified parameter.
java.lang.String	getAdditionalParameters(UWSJob job, boolean root) Serializes the parameters of the given job.
java.lang.String	getCreationTime(UWSJob job, boolean root) Serializes the creation date/time of the given job.
java.lang.String	getDestructionTime(UWSJob job, boolean root) Serializes the destruction time of the given job.
java.lang.String	getEndTime(UWSJob job, boolean root) Serializes the end time of the given job.
java.lang.String	getErrorSummary(ErrorSummary error, boolean root) Serializes the given error summary.
java.lang.String	getExecutionDuration(UWSJob job, boolean root) Serializes the execution duration of the given job.
java.lang.String	getJob(UWSJob job, boolean root) Serializes the whole given job.
java.lang.String	getJobID(UWSJob job, boolean root) Serializes the ID of the given job.
java.lang.String	getJobList(JobList jobsList, JobOwner owner, JobListRefiner listRefiner, boolean root) Serializes the given jobs list, by filtering using user-specified filters.
java.lang.String	getJobRef(UWSJob job, UWSUrl jobsListUrl) Serializes just a reference on the given job.
java.lang.String	getMimeType() Gets the MIME type of the serialization format used by this serializer.
java.lang.String	getOwnerID(UWSJob job, boolean root) Serializes the owner ID of the given job.
java.lang.String	getPhase(UWSJob job, boolean root) Serializes the phase of the given job.
java.lang.String	getQuote(UWSJob job, boolean root) Serializes the quote of the given job.
java.lang.String	getResult(Result result, boolean root) Serializes the given result.
java.lang.String	getResults(UWSJob job, boolean root) Serializes the results of the given job.
java.lang.String	getRunID(UWSJob job, boolean root) Serializes the run ID of the given job.
java.lang.String	getStartTime(UWSJob job, boolean root) Serializes the start time of the given job.
java.lang.String	getUWS(UWS uws, JobOwner user) Serializes the given UWS for the specified user.

Methods inherited from class uws.job.serializer.UWSSerializer

getJob, getJobList, getJobList, getUWS, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONSerializer

public JSONSerializer()

Method Detail

getMimeType

public final java.lang.String getMimeType()

Description copied from class: UWSSerializer

Gets the MIME type of the serialization format used by this serializer.

Specified by:

getMimeType in class UWSSerializer

Returns:

The corresponding MIME type.

getUWS

public java.lang.String getUWS(UWS uws,
                               JobOwner user)
                        throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the given UWS for the specified user.

Specified by:

getUWS in class UWSSerializer

Parameters:

uws - The UWS to serialize.

user - The user which has asked the serialization of the given UWS.

Returns:

The serialization of the UWS.

Throws:

org.json.JSONException

getJobList

public java.lang.String getJobList(JobList jobsList,
                                   JobOwner owner,
                                   JobListRefiner listRefiner,
                                   boolean root)
                            throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the given jobs list, by filtering using user-specified filters.

Specified by:

getJobList in class UWSSerializer

Parameters:

jobsList - The jobs list to serialize.

owner - The user which has asked the serialization of the given jobs list. If NULL, all anonymous jobs are displayed.

listRefiner - Represent all the specified job filters to apply ; only the job that pass through this filter should be displayed. If NULL, all jobs are displayed.

root - false if the jobs list to serialize will be included in a top level serialization (for a jobs list: uws), true otherwise.

Returns:

The serialization of the given jobs list.

Throws:

org.json.JSONException

getJob

public java.lang.String getJob(UWSJob job,
                               boolean root)
                        throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the whole given job.

Specified by:

getJob in class UWSSerializer

Parameters:

job - The job to serialize.

root - false if the job to serialize will be included in a top level serialization (for a job: jobList), true otherwise.

Returns:

The serialization of the given job.

Throws:

org.json.JSONException

getJobRef

public java.lang.String getJobRef(UWSJob job,
                                  UWSUrl jobsListUrl)
                           throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes just a reference on the given job.

Specified by:

getJobRef in class UWSSerializer

Parameters:

job - The job to reference.

jobsListUrl - URL to the jobs lists which contains the given job.

Returns:

The serialization of a reference on the given job.

Throws:

org.json.JSONException

getJobID

public java.lang.String getJobID(UWSJob job,
                                 boolean root)
                          throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the ID of the given job.

Specified by:

getJobID in class UWSSerializer

Parameters:

job - The job whose the ID must be serialized.

root - false if the job ID to serialize will be included in a top level serialization (for a job ID: job), true otherwise.

Returns:

The serialization of the job ID.

Throws:

org.json.JSONException

getRunID

public java.lang.String getRunID(UWSJob job,
                                 boolean root)
                          throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the run ID of the given job.

Specified by:

getRunID in class UWSSerializer

Parameters:

job - The job whose the run ID must be serialized.

root - false if the run ID to serialize will be included in a top level serialization (for a run ID: job), true otherwise.

Returns:

The serialization of the run ID.

Throws:

org.json.JSONException

getOwnerID

public java.lang.String getOwnerID(UWSJob job,
                                   boolean root)
                            throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the owner ID of the given job.

Specified by:

getOwnerID in class UWSSerializer

Parameters:

job - The job whose the owner ID must be serialized.

root - false if the owner ID to serialize will be included in a top level serialization (for a owner ID: job), true otherwise.

Returns:

The serialization of the owner ID.

Throws:

org.json.JSONException

getPhase

public java.lang.String getPhase(UWSJob job,
                                 boolean root)
                          throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the phase of the given job.

Specified by:

getPhase in class UWSSerializer

Parameters:

job - The job whose the phase must be serialized.

root - false if the phase to serialize will be included in a top level serialization (for a phase: job), true otherwise.

Returns:

The serialization of the phase.

Throws:

org.json.JSONException

getQuote

public java.lang.String getQuote(UWSJob job,
                                 boolean root)
                          throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the quote of the given job.

Warning! UWSJob.getQuote() is a long, BUT the UWS standard explicitly requires a quote as an ISO-8601 date (cf section "2.2.1. Resources and URIs").
This function MUST return a quote only when the job is started/finished and MUST add the quote duration to the startTime and format it as an ISO-8601 date.

Specified by:

getQuote in class UWSSerializer

Parameters:

job - The job whose the quote must be serialized.

root - false if the quote to serialize will be included in a top level serialization (for a quote: job), true otherwise.

Returns:

The serialization of the quote.

Throws:

org.json.JSONException

getCreationTime

public java.lang.String getCreationTime(UWSJob job,
                                        boolean root)
                                 throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the creation date/time of the given job.

Specified by:

getCreationTime in class UWSSerializer

Parameters:

job - The job whose the creation date/time must be serialized.

root - false if the creation time to serialize will be included in a top level serialization (for a creation time: job), true otherwise.

Returns:

The serialization of the job creation date/time.

Throws:

org.json.JSONException

getExecutionDuration

public java.lang.String getExecutionDuration(UWSJob job,
                                             boolean root)
                                      throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the execution duration of the given job.

Specified by:

getExecutionDuration in class UWSSerializer

Parameters:

job - The job whose the execution duration must be serialized.

root - false if the execution duration to serialize will be included in a top level serialization (for a execution duration: job), true otherwise.

Returns:

The serialization of the execution duration.

Throws:

org.json.JSONException

getDestructionTime

public java.lang.String getDestructionTime(UWSJob job,
                                           boolean root)
                                    throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the destruction time of the given job.

Specified by:

getDestructionTime in class UWSSerializer

Parameters:

job - The job whose the destruction time must be serialized.

root - false if the destruction time to serialize will be included in a top level serialization (for a destruction time: job), true otherwise.

Returns:

The serialization of the destruction time.

Throws:

org.json.JSONException

getStartTime

public java.lang.String getStartTime(UWSJob job,
                                     boolean root)
                              throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the start time of the given job.

Specified by:

getStartTime in class UWSSerializer

Parameters:

job - The job whose the start time must be serialized.

root - false if the start time to serialize will be included in a top level serialization (for a start time: job), true otherwise.

Returns:

The serialization of the start time.

Throws:

org.json.JSONException

getEndTime

public java.lang.String getEndTime(UWSJob job,
                                   boolean root)
                            throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the end time of the given job.

Specified by:

getEndTime in class UWSSerializer

Parameters:

job - The job whose the end time must be serialized.

root - false if the end time to serialize will be included in a top level serialization (for a end time: job), true otherwise.

Returns:

The serialization of the end time.

Throws:

org.json.JSONException

getErrorSummary

public java.lang.String getErrorSummary(ErrorSummary error,
                                        boolean root)
                                 throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the given error summary.

Specified by:

getErrorSummary in class UWSSerializer

Parameters:

error - The error to serialize.

root - false if the error summary to serialize will be included in a top level serialization (for an error summary: job), true otherwise.

Returns:

The serialization of the error summary.

Throws:

org.json.JSONException

getAdditionalParameters

public java.lang.String getAdditionalParameters(UWSJob job,
                                                boolean root)
                                         throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the parameters of the given job.

Specified by:

getAdditionalParameters in class UWSSerializer

Parameters:

job - The job whose the parameters must be serialized.

root - false if the parameters list to serialize will be included in a top level serialization (for a list of parameters: job), true otherwise.

Returns:

The serialization of the parameters.

Throws:

org.json.JSONException

getAdditionalParameter

public java.lang.String getAdditionalParameter(java.lang.String paramName,
                                               java.lang.Object paramValue,
                                               boolean root)
                                        throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the specified parameter.

Specified by:

getAdditionalParameter in class UWSSerializer

Parameters:

paramName - The name of the parameter to serialize.

paramValue - The value of the parameter to serialize.

root - false if the parameter to serialize will be included in a top level serialization (for a parameter: parameters), true otherwise.

Returns:

The serialization of the parameter.

Throws:

org.json.JSONException

getResults

public java.lang.String getResults(UWSJob job,
                                   boolean root)
                            throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the results of the given job.

Specified by:

getResults in class UWSSerializer

Parameters:

job - The job whose the results must be serialized.

root - false if the results list to serialize will be included in a top level serialization (for a list of results: job), true otherwise.

Returns:

The serialization of the results.

Throws:

org.json.JSONException

getResult

public java.lang.String getResult(Result result,
                                  boolean root)
                           throws org.json.JSONException

Description copied from class: UWSSerializer

Serializes the given result.

Specified by:

getResult in class UWSSerializer

Parameters:

result - The result to serialize.

root - false if the result to serialize will be included in a top level serialization (for a result: results), true otherwise.

Returns:

The serialization of the result.

Throws:

org.json.JSONException