Package gavo :: Package protocols :: Module useruws :: Class UserUWS
[frames] | no frames]

Class UserUWS

source code

     object --+        
              |        
        uws.UWS --+    
                  |    
uws.UWSWithQueueing --+
                      |
                     UserUWS

A UWS for "user jobs", i.e., generic things an a core.

These dynamically create job classes based on the processing core's parameters. To make this happen, we'll need to override some of the common UWS functions.

Instance Methods
 
__init__(self, service, jobActions)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
getURLForId(self, jobId)
returns the handling URL for the job with jobId.
source code
 
getIdsAndPhases(self, *args, **kwargs)
returns pairs for id and phase for all jobs in the UWS.
source code

Inherited from uws.UWSWithQueueing: changeToPhase, checkProcessQueue, scheduleProcessQueueCheck

Inherited from uws.UWS: changeableJob, cleanupJobsTable, countQueuedJobs, countRunningJobs, destroy, getJob, getJobIds, getNewIdFromRequest, getNewJob, getNewJobId, runCanned

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables
  joblistPreamble = '<?xml-stylesheet href=\'/static/xsl/useruws...
  jobdocPreamble = '<?xml-stylesheet href=\'/static/xsl/useruws-...

Inherited from uws.UWSWithQueueing: runcountGoal

Inherited from uws.UWS: cleanupInterval

Properties

Inherited from object: __class__

Method Details

__init__(self, service, jobActions)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

getURLForId(self, jobId)

source code 

returns the handling URL for the job with jobId.

You must override this in deriving classes.

Overrides: uws.UWS.getURLForId
(inherited documentation)

getIdsAndPhases(self, *args, **kwargs)

source code 

returns pairs for id and phase for all jobs in the UWS.

phase, last, after are the respective parameters from UWS 1.1.

Overrides: uws.UWS.getIdsAndPhases
(inherited documentation)

Class Variable Details

joblistPreamble

Value:
'<?xml-stylesheet href=\'/static/xsl/useruws-joblist-to-html.xsl\' typ\
e=\'text/xsl\'?>'

jobdocPreamble

Value:
'<?xml-stylesheet href=\'/static/xsl/useruws-job-to-html.xsl\' type=\'\
text/xsl\'?>'