de.ipcon.db

Class ExecutionPolicy

java.lang.Object

de.ipcon.db.ExecutionPolicy

Direct Known Subclasses:

ExecutionPolicyCronJob, ExecutionPolicyKeepRunning

public abstract class ExecutionPolicy
extends java.lang.Object

Abstract base class for all ExecutionPolicies available for Services. The semantic of an ExecutionPolicy is two fold. It mainly handles the starting and stopping of the service, including scheduling its next run. Secondly it is the actual runnable/Thread implementation the Service itself runs in. Use getInstance() with the ExecutionPolicy XML from the Service to return a configured instance, which can then be enabled using enable(). Example Configurations:

 
 <ExecutionPolicy>
   <CronJob>
     <Command>55 19 * * *</Command>
   </CronJob>
 </ExecutionPolicy>
 
 

Starts this service at 19:55:00 local time each day.

 
 <ExecutionPolicy>
   <CronJob>
     <Commands>
       <Command>55 19 * * *</Command>
       <Command>56 19 * * *</Command>
     </Commands>
   </CronJob>
 </ExecutionPolicy>
 
 

Starts this Service at 19:55:00 and 19:56:00 local time each day. If the Service from 19:55 is still running at 19:56, then the execution on 19:56 is skipped. ExecutionPolicyCronJob for an example of how to abort the running thread in this case.

Constructor Summary

Constructors

Constructor and Description
ExecutionPolicy(ServiceInstanceI _si, electric.xml.Element _confRoot, ServiceI _service, java.lang.String _description)

Method Summary

Modifier and Type	Method and Description
void	disable() Disables a running Service and stops its worker thread.
void	enable() Enables and starts this Executionpolicy, causing the BS to be executed at the next scheduled time.
void	finish()
electric.xml.Element	getConfRoot()
java.lang.String	getDescription()
static ExecutionPolicy	getInstance(ServiceInstanceI _si, electric.xml.Element _confRoot, ServiceI _service, java.lang.String _description) Parses the XML Configuration element and returns the ExecutionPolicy defined for it.
ServiceI	getService()
ServiceInstanceI	getSi()
java.lang.Long	getWDTimeoutMillis()
void	resetUnrecoverableError() Clears any unrecoverable errors on the ServiceI instance, setting it to null.
void	setConfRoot(electric.xml.Element $4)
void	setDescription(java.lang.String $6)
void	setService(ServiceI $5)
void	setSi(ServiceInstanceI $3)
void	setWDTimeoutMillis(java.lang.Long $7)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecutionPolicy

public ExecutionPolicy(ServiceInstanceI _si,
                       electric.xml.Element _confRoot,
                       ServiceI _service,
                       java.lang.String _description)

Method Detail

getInstance

public static ExecutionPolicy getInstance(ServiceInstanceI _si,
                                          electric.xml.Element _confRoot,
                                          ServiceI _service,
                                          java.lang.String _description)

Parses the XML Configuration element and returns the ExecutionPolicy defined for it.

Parameters:

_si - the (wrapper) class for services.

_confRoot - the root Element of the ExecutionPolicy configuration.

_service - the ServiceI instance, i.e. the 'api' the service should use.

Returns:

depending on the configuration, either an Instance of ExecutionPolicyKeepRunning or an ExecutionPolicyCronJob

disable

public void disable()

Disables a running Service and stops its worker thread.

enable

public void enable()

Enables and starts this Executionpolicy, causing the BS to be executed at the next scheduled time.

finish

public void finish()

resetUnrecoverableError

public void resetUnrecoverableError()

Clears any unrecoverable errors on the ServiceI instance, setting it to null.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSi

public ServiceInstanceI getSi()

setSi

public void setSi(ServiceInstanceI $3)

getConfRoot

public electric.xml.Element getConfRoot()

setConfRoot

public void setConfRoot(electric.xml.Element $4)

getService

public ServiceI getService()

setService

public void setService(ServiceI $5)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String $6)

getWDTimeoutMillis

public java.lang.Long getWDTimeoutMillis()

setWDTimeoutMillis

public void setWDTimeoutMillis(java.lang.Long $7)