Package org.eclipse.scanning.api.event.core

Class AbstractLockingPausableProcess<T extends StatusBean>

java.lang.Object

org.eclipse.scanning.api.event.core.AbstractLockingPausableProcess<T>

All Implemented Interfaces:

IBeanProcess<T>, IPublishable<T>

Direct Known Subclasses:

CommandProcess

public abstract class AbstractLockingPausableProcess<T extends StatusBean>
extends Object
implements IBeanProcess<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final T	bean
protected PrintStream	out
protected final IPublisher<T>	publisher

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLockingPausableProcess(T bean, IPublisher<T> publisher)

Method Summary

Modifier and Type	Method	Description
void	broadcast(StatusBean tbean)	Notify any clients of the beans status
protected void	checkPaused()	Blocks until process is not paused.
protected void	doPause()	Override this method to do work on a pause once the pause lock has been received.
protected void	doResume()	Override this method to do work on a resume once the pause lock has been received.
protected void	doTerminate()
protected void	dryRun()
protected void	dryRun(int size)
protected void	dryRun(int size, boolean complete)
T	getBean()
IPublisher<T>	getPublisher()
protected final File	getUnique(File dir, String template, int i)
boolean	isCancelled()
boolean	isPaused()	Returns whether the process is paused.
protected static final boolean	isWindowsOS()
void	pause()	Implements paused using a standard design
void	resume()	Implements resume using a standard design
void	setCancelled(boolean isCancelled)
protected void	setLoggingFile(File logFile)
protected void	setLoggingFile(File logFile, boolean append)	Calling this method redirects the logging of this Java object which is available through the field 'out' to a known file.
void	terminate()	Please provide a termination for the process by implementing this method.
protected void	writeProjectBean(File dir, String fileName)	Writes the project bean at the point where it is run.
protected void	writeProjectBean(String dir, String fileName)	Writes the project bean at the point where it is run.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scanning.api.event.core.IBeanProcess

execute, isBlocking, start

Field Details

bean

protected final T extends StatusBean bean

publisher

protected final IPublisher<T extends StatusBean> publisher

out

protected PrintStream out

Constructor Details

AbstractLockingPausableProcess

protected AbstractLockingPausableProcess(T bean,
 IPublisher<T> publisher)

Method Details

getBean

public T getBean()

Specified by:

getBean in interface IPublishable<T extends StatusBean>

Returns:

the bean which this process is currently running.

getPublisher

public IPublisher<T> getPublisher()

Specified by:

getPublisher in interface IPublishable<T extends StatusBean>

Returns:

the bean which this process is currently running.

checkPaused

protected void checkPaused()
                    throws EventException

Blocks until process is not paused.

Throws:

EventException

pause

public void pause()
           throws EventException

Implements paused using a standard design

Specified by:

pause in interface IBeanProcess<T extends StatusBean>

Throws:

EventException

doPause

protected void doPause()
                throws Exception

Override this method to do work on a pause once the pause lock has been received.

Throws:

Exception

resume

public void resume()
            throws EventException

Implements resume using a standard design

Specified by:

resume in interface IBeanProcess<T extends StatusBean>

Throws:

EventException

isPaused

public boolean isPaused()

Description copied from interface: IBeanProcess

Returns whether the process is paused. If using AbstractLockingPausableProcess, it will be automatically.

Specified by:

isPaused in interface IBeanProcess<T extends StatusBean>

Returns:

true if the process is paused, false otherwise

doResume

protected void doResume()
                 throws Exception

Override this method to do work on a resume once the pause lock has been received.

Throws:

Exception

terminate

public void terminate()
               throws EventException

Description copied from interface: IBeanProcess

Please provide a termination for the process by implementing this method. If the process has a stop file, write it now; if it needs to be killed, get its pid and kill it; if it is running on a cluster, use the qdel or dramaa api.

Specified by:

terminate in interface IBeanProcess<T extends StatusBean>

Throws:

EventException

doTerminate

protected void doTerminate()
                    throws Exception

Throws:

Exception

isWindowsOS

protected static final boolean isWindowsOS()

Returns:

true if windows

getUnique

protected final File getUnique(File dir,
 String template,
 int i)

Parameters:

dir -

template -

i -

ext -

Returns:

file

setLoggingFile

protected void setLoggingFile(File logFile)
                       throws IOException

Throws:

IOException

setLoggingFile

protected void setLoggingFile(File logFile,
 boolean append)
                       throws IOException

Calling this method redirects the logging of this Java object which is available through the field 'out' to a known file.

Parameters:

logFile -

Throws:

IOException

writeProjectBean

protected void writeProjectBean(String dir,
 String fileName)
                         throws Exception

Writes the project bean at the point where it is run.

Parameters:

dir - directory to write to

fileName - file name to write bean to

Throws:

Exception

writeProjectBean

protected void writeProjectBean(File dir,
 String fileName)
                         throws Exception

Writes the project bean at the point where it is run.

Parameters:

dir - directory to write to

fileName - file name to write bean to

Throws:

Exception

broadcast

public void broadcast(StatusBean tbean)

Notify any clients of the beans status

Parameters:

bean -

dryRun

protected void dryRun()
               throws EventException,
InterruptedException

Throws:

EventException

InterruptedException

dryRun

protected void dryRun(int size)
               throws EventException,
InterruptedException

Throws:

EventException

InterruptedException

dryRun

protected void dryRun(int size,
 boolean complete)
               throws EventException,
InterruptedException

Throws:

EventException

InterruptedException

isCancelled

public boolean isCancelled()

setCancelled

public void setCancelled(boolean isCancelled)