sfi.director.application.objevents.Workflow Class Reference

implementing some higher level functionality set on top of EventEnvironment. More...

Public Member Functions
	Workflow ()
	Workflow (boolean inQueue)
	Workflow (String description)
	Workflow (String description, String name)
	Workflow (String description, String name, boolean inQueue)
void	finalize ()
void	setInQueue (boolean queue)
void	dispose ()
void	setDescr (String name)
void	setName (String name)
synchronized void	flush () throws DirectorException
synchronized void	addJob (Job job)
synchronized void	addHead (JobNode job)
synchronized void	addWorkflow (Workflow wf)
synchronized void	doEvent (EventEnvironment env, String type) throws DirectorException
void	doEvent (DBObject dbo, final DBConnection dir, final Record data, final String type) throws DirectorException
void	doEvent (DBObject dbo, final DBConnection dir, final Record data, final String type, boolean warnIfNotApplicable) throws DirectorException
void	doEvent (Enumeration< DBObject > dbos, Enumeration< DBConnection > dirs, Enumeration< Record > data, final String type, boolean warnIfNotApplicable) throws DirectorException
	Execute an event for a given database entry and the given corresponding object editor data.
void	setMonitorOptions (String name)
void	setMonitorOptions (String name, String contents)
void	openMonitor () throws DirectorException
LogEntry	watch () throws DirectorException
JobStatus	getStatus ()
void	closeMonitor ()
String	getId ()
void	setId (String id)
JobNode	getMaster ()
void	setBackChain (Job job)
void	setBackChain (String jobid)

Detailed Description

implementing some higher level functionality set on top of EventEnvironment.

Basically you use doEvent() for stacking up jobs and flush() for passing a job stack to the Scheduler.

Constructor & Destructor Documentation

sfi.director.application.objevents.Workflow.Workflow

(

)

sfi.director.application.objevents.Workflow.Workflow

(

boolean

inQueue

)

sfi.director.application.objevents.Workflow.Workflow

(

String

description

)

sfi.director.application.objevents.Workflow.Workflow	(	String	description,
		String	name
	)

sfi.director.application.objevents.Workflow.Workflow	(	String	description,
		String	name,
		boolean	inQueue
	)

Member Function Documentation

synchronized void sfi.director.application.objevents.Workflow.addHead

(

JobNode

job

)

References sfi.director.application.objevents.Workflow.addJob().

synchronized void sfi.director.application.objevents.Workflow.addJob

(

Job

job

)

References sfi.director.util.Setup.localjobqueue.

Referenced by sfi.director.application.objevents.Workflow.addHead().

synchronized void sfi.director.application.objevents.Workflow.addWorkflow

(

Workflow

wf

)

References sfi.director.application.objevents.Workflow.getMaster().

void sfi.director.application.objevents.Workflow.closeMonitor

(

)

Referenced by sfi.director.application.objevents.Workflow.dispose(), and sfi.director.application.objevents.Workflow.openMonitor().

void sfi.director.application.objevents.Workflow.dispose

(

)

References sfi.director.application.objevents.Workflow.closeMonitor().

Referenced by sfi.director.application.objevents.Workflow.finalize().

synchronized void sfi.director.application.objevents.Workflow.doEvent	(	EventEnvironment	env,
		String	type
	)		throws DirectorException

References sfi.director.util.Logger.ERR, sfi.director.util.Logger.indent(), sfi.director.util.Setup.localjobqueue, sfi.director.util.Tools.log(), sfi.director.util.Setup.logger, and sfi.director.util.Logger.outdent().

Referenced by sfi.director.cli.build.buildAll(), sfi.director.application.scripttask.FireEvent.create(), sfi.director.application.scripttask.UpdateDomainsFor.create(), sfi.director.application.scripttask.RemoveUserRef.create(), sfi.director.application.scripttask.SetVHost.create(), sfi.director.application.scripttask.SetUserRef.create(), sfi.director.application.scripttask.ClassMemberApply.create(), sfi.director.application.objevents.Workflow.doEvent(), sfi.director.cli.create.edit(), sfi.director.application.scripttask.ChainEvent.exec(), sfi.director.application.scripttask.BuildDependingDomains.exec(), sfi.director.schedule.Scheduler.executePendingDSUpdate(), sfi.director.application.AdminServer.oneConnection(), sfi.director.application.FrontendHTTPServer.postEvent(), sfi.director.cli.app_import.run(), sfi.director.cli.mkdepend.run(), sfi.director.cli.build.run(), sfi.director.cli.app_subscribe.run(), and sfi.director.application.SetPassword.setPasswordByFilter().

void sfi.director.application.objevents.Workflow.doEvent	(	DBObject	dbo,
		final DBConnection	dir,
		final Record	data,
		final String	type
	)		throws DirectorException

References sfi.director.application.objevents.Workflow.doEvent().

void sfi.director.application.objevents.Workflow.doEvent	(	DBObject	dbo,
		final DBConnection	dir,
		final Record	data,
		final String	type,
		boolean	warnIfNotApplicable
	)		throws DirectorException

References sfi.director.application.objevents.Workflow.doEvent().

void sfi.director.application.objevents.Workflow.doEvent	(	Enumeration< DBObject >	dbos,
		Enumeration< DBConnection >	dirs,
		Enumeration< Record >	data,
		final String	type,
		boolean	warnIfNotApplicable
	)		throws DirectorException

Execute an event for a given database entry and the given corresponding object editor data.

References sfi.director.application.objevents.EventEnvironment.add(), sfi.director.repository.DBObject.clone(), sfi.director.util.Tools.debug(), sfi.director.application.objevents.Workflow.doEvent(), sfi.director.repository.DBConnection.get(), sfi.director.repository.DBAccessor.getDBObject(), sfi.director.repository.DBObject.getDN(), sfi.director.repository.DBObject.getValue(), sfi.director.util.Logger.log(), sfi.director.util.Tools.log(), sfi.director.util.Setup.logger, sfi.director.util.Logger.NOTICE, sfi.director.util.Logger.setTitle(), and sfi.director.util.Logger.WARNING.

void sfi.director.application.objevents.Workflow.finalize

(

)

References sfi.director.application.objevents.Workflow.dispose().

synchronized void sfi.director.application.objevents.Workflow.flush

(

)

throws DirectorException

References sfi.director.jobs.Job.commit(), sfi.director.jobs.Job.getDescr(), sfi.director.jobs.Job.getId(), sfi.director.jobs.Job.getName(), sfi.director.util.Setup.localjobqueue, sfi.director.schedule.Scheduler.scheduleJob(), sfi.director.util.Setup.scheduler, sfi.director.jobs.JobNode.setBackChain(), sfi.director.jobs.Job.setDescr(), sfi.director.jobs.JobNode.setJob(), sfi.director.jobs.Job.setName(), sfi.director.jobs.JobNode.setSub(), and sfi.director.jobs.JobNode.WakeUp().

Referenced by sfi.director.cli.build.buildAll(), sfi.director.application.scripttask.FireEvent.create(), sfi.director.application.scripttask.UpdateDomainsFor.create(), sfi.director.application.scripttask.RemoveUserRef.create(), sfi.director.application.scripttask.SetVHost.create(), sfi.director.application.scripttask.SetUserRef.create(), sfi.director.application.scripttask.ClassMemberApply.create(), sfi.director.application.scripttask.ConfigHost.create(), sfi.director.cli.create.edit(), sfi.director.application.scripttask.ChainEvent.exec(), sfi.director.application.scripttask.BuildDependingDomains.exec(), sfi.director.schedule.Scheduler.executePendingDSUpdate(), sfi.director.application.AdminServer.oneConnection(), sfi.director.application.FrontendHTTPServer.postEvent(), sfi.director.cli.app_import.run(), sfi.director.cli.mkdepend.run(), sfi.director.cli.build.run(), sfi.director.cli.app_subscribe.run(), sfi.director.cli.app_freeze.run(), and sfi.director.cli.app_dist.run().

String sfi.director.application.objevents.Workflow.getId

(

)

Referenced by sfi.director.cli.create.edit(), sfi.director.schedule.Scheduler.executePendingDSUpdate(), sfi.director.cli.mkdepend.run(), sfi.director.cli.build.run(), sfi.director.cli.app_subscribe.run(), and sfi.director.cli.app_dist.run().

JobNode sfi.director.application.objevents.Workflow.getMaster

(

)

Referenced by sfi.director.application.objevents.Workflow.addWorkflow(), sfi.director.application.scripttask.FireEvent.create(), sfi.director.application.scripttask.UpdateDomainsFor.create(), sfi.director.application.scripttask.SetVHost.create(), sfi.director.application.scripttask.RemoveUserRef.create(), sfi.director.application.scripttask.SetUserRef.create(), sfi.director.application.scripttask.ClassMemberApply.create(), sfi.director.application.scripttask.ConfigHost.create(), and sfi.director.application.scripttask.ChainEvent.exec().

JobStatus sfi.director.application.objevents.Workflow.getStatus

(

)

Referenced by sfi.director.schedule.Scheduler.executePendingDSUpdate().

void sfi.director.application.objevents.Workflow.openMonitor

(

)

throws DirectorException

References sfi.director.application.objevents.Workflow.closeMonitor(), sfi.director.util.Tools.debug(), sfi.director.util.MyProperties.getProperty(), sfi.director.util.Logger.INFO, sfi.director.util.Tools.log(), sfi.director.util.Setup.masterhost, and sfi.director.util.Setup.properties.

Referenced by sfi.director.application.objevents.Workflow.watch().

void sfi.director.application.objevents.Workflow.setBackChain

(

Job

job

)

References sfi.director.jobs.Job.getId().

Referenced by sfi.director.application.scripttask.ChainEvent.exec().

void sfi.director.application.objevents.Workflow.setBackChain

(

String

jobid

)

void sfi.director.application.objevents.Workflow.setDescr

(

String

name

)

Referenced by sfi.director.application.scripttask.BuildDependingDomains.exec().

void sfi.director.application.objevents.Workflow.setId

(

String

id

)

Referenced by sfi.director.application.FrontendHTTPServer.LogMonitor(), and sfi.director.cli.monitor.run().

void sfi.director.application.objevents.Workflow.setInQueue

(

boolean

queue

)

void sfi.director.application.objevents.Workflow.setMonitorOptions

(

String

name

)

References sfi.director.util.Options.setOption().

void sfi.director.application.objevents.Workflow.setMonitorOptions	(	String	name,
		String	contents
	)

References sfi.director.util.Options.setOption().

void sfi.director.application.objevents.Workflow.setName

(

String

name

)

LogEntry sfi.director.application.objevents.Workflow.watch

(

)

throws DirectorException

References sfi.director.jobs.JobStatus.equals(), sfi.director.util.LogEntry.getMessage(), sfi.director.jobs.Job.getStatus(), sfi.director.jobs.JobStatus.isFinal(), sfi.director.util.Logger.NOTICE, sfi.director.application.objevents.Workflow.openMonitor(), and sfi.director.jobs.JobMonitor.retrieveJob().

Referenced by sfi.director.application.FrontendHTTPServer.LogMonitor().

---

The documentation for this class was generated from the following file:

• director/src/sfi/director/application/objevents/Workflow.java