tap.backup

Class DefaultTAPBackupManager

java.lang.Object

uws.service.backup.DefaultUWSBackupManager

tap.backup.DefaultTAPBackupManager

All Implemented Interfaces:

UWSBackupManager

public class DefaultTAPBackupManager
extends DefaultUWSBackupManager

Let backup all TAP asynchronous jobs.

note: Basically the saved data are the same, but in addition some execution statistics are also added.

Version:

2.0 (12/2014)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

DefaultUWSBackupManager

Nested Class Summary

Nested classes/interfaces inherited from class uws.service.backup.DefaultUWSBackupManager

DefaultUWSBackupManager.JSONArrayReader, DefaultUWSBackupManager.JSONObjectReader, DefaultUWSBackupManager.SingleInputIterator

Field Summary

Fields inherited from class uws.service.backup.DefaultUWSBackupManager

AT_USER_ACTION, backupFreq, byUser, DEFAULT_FREQUENCY, enabled, lastBackup, lastRestoration, MANUAL, timAutoBackup, uws

Constructor Summary

Constructors

Constructor and Description
DefaultTAPBackupManager(UWS uws) Build a default TAP jobs backup manager.
DefaultTAPBackupManager(UWS uws, boolean byUser) Build a default TAP jobs backup manager.
DefaultTAPBackupManager(UWS uws, boolean byUser, long frequency) Build a default TAP jobs backup manager.
DefaultTAPBackupManager(UWS uws, long frequency) Build a default TAP jobs backup manager.

Method Summary

Modifier and Type	Method and Description
protected org.json.JSONObject	getDALIUploadJson(DALIUpload upl) Get the JSON representation of the given DALIUpload.
protected org.json.JSONObject	getJSONJob(UWSJob job, java.lang.String jlName) Serializes the given job into a JSON object.
protected void	restoreOtherJobParams(org.json.JSONObject json, UWSJob job) Restores other job parameters, either from the given JSON object or from the parameters map of the given job.

Methods inherited from class uws.service.backup.DefaultUWSBackupManager

fromBase64, getBackupFreq, getError, getJSONJobInfo, getJSONUser, getLastBackup, getLastRestoration, getLogger, getParameters, getResult, getResults, getUploadFile, getUploadJson, getUser, isEnabled, restoreAll, restoreJob, restoreJobInfo, saveAll, saveOwner, saveOwner, setBackupFreq, setEnabled, toBase64

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTAPBackupManager

public DefaultTAPBackupManager(UWS uws)

Build a default TAP jobs backup manager.

Parameters:

uws - The UWS containing all the jobs to backup.

See Also:

DefaultUWSBackupManager.DefaultUWSBackupManager(UWS)

DefaultTAPBackupManager

public DefaultTAPBackupManager(UWS uws,
                               long frequency)

Build a default TAP jobs backup manager.

Parameters:

uws - The UWS containing all the jobs to backup.

frequency - The backup frequency (in ms ; MUST BE positive and different from 0. If negative or 0, the frequency will be automatically set to DEFAULT_FREQUENCY).

See Also:

DefaultUWSBackupManager.DefaultUWSBackupManager(UWS, long)

DefaultTAPBackupManager

public DefaultTAPBackupManager(UWS uws,
                               boolean byUser)
                        throws UWSException

Build a default TAP jobs backup manager.

Parameters:

uws - The UWS containing all the jobs to backup.

byUser - Backup mode.

Throws:

UWSException

See Also:

DefaultUWSBackupManager.DefaultUWSBackupManager(UWS, boolean)

DefaultTAPBackupManager

public DefaultTAPBackupManager(UWS uws,
                               boolean byUser,
                               long frequency)
                        throws UWSException

Build a default TAP jobs backup manager.

Parameters:

uws - The UWS containing all the jobs to backup.

byUser - Backup mode.

frequency - The backup frequency (in ms ; MUST BE positive and different from 0. If negative or 0, the frequency will be automatically set to DEFAULT_FREQUENCY).

Throws:

UWSException

See Also:

DefaultUWSBackupManager.DefaultUWSBackupManager(UWS, boolean, long)

Method Detail

getJSONJob

protected org.json.JSONObject getJSONJob(UWSJob job,
                                         java.lang.String jlName)
                                  throws UWSException,
                                         org.json.JSONException

Description copied from class: DefaultUWSBackupManager

Serializes the given job into a JSON object.

note: the structure of the returned JSON object is decided by Json4Uws.getJson(UWSJob). Only one attribute is added: "jobListName".

Overrides:

getJSONJob in class DefaultUWSBackupManager

Parameters:

job - The job to save.

jlName - Name of the jobs list containing the given job.

Returns:

The JSON representation of the given job.

Throws:

UWSException - If there is an error while getting job parameters and serializing them.

org.json.JSONException - If there is an error while building the JSON object.

getDALIUploadJson

protected org.json.JSONObject getDALIUploadJson(DALIUpload upl)
                                         throws org.json.JSONException

Get the JSON representation of the given DALIUpload.

Parameters:

upl - The DALI upload specification to serialize in JSON.

Returns:

Its JSON representation.

Throws:

org.json.JSONException - If there is an error while building the JSON object.

Since:

2.0

restoreOtherJobParams

protected void restoreOtherJobParams(org.json.JSONObject json,
                                     UWSJob job)
                              throws UWSException

Description copied from class: DefaultUWSBackupManager

Restores other job parameters, either from the given JSON object or from the parameters map of the given job. The job is supposed to be updated after the call of this function.

note: By default, this function does nothing ! It is called by DefaultUWSBackupManager.restoreJob(JSONObject, Map) just after the default restoration from the given JSON and just before to add the job in its dedicated jobs list.

Overrides:

restoreOtherJobParams in class DefaultUWSBackupManager

Parameters:

json - JSON backup of the given job.

job - Default restoration of the job.

Throws:

UWSException - If there is an error while restoring other job parameters.

See Also:

DefaultUWSBackupManager.restoreJob(JSONObject, Map)