org.oddjob.persist

Class ArchiveJob

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.persist.ArchiveJob

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, ArooaContextAware, ArooaSessionAware, PropertyChangeNotifier, Iconic, LogEnabled, Resetable, Stateful, Stoppable, Structural

public class ArchiveJob
extends BasePrimary
implements java.lang.Runnable, java.io.Serializable, Stoppable, Resetable, Stateful, Structural

Description

A Job that is capable of taking a snapshot of the state of it's child jobs. An ArchiveBrowserJob can be used to browse an archive created with this job.

Example

Create an archive after each scheduled run. The time of the schedule is used to identify the archive.

<oddjob id="this">
    <job>
        <sequential>
            <jobs>
                <scheduling:timer id="the-timer" xmlns:scheduling="http://rgordon.co.uk/oddjob/scheduling">
                    <clock>
                      <value value="${clock}"/>
                    </clock>
                    <schedule>
                        <schedules:count count="3" xmlns:schedules="http://rgordon.co.uk/oddjob/schedules">
                        	<refinement>
                        		<schedules:interval interval="00:00:00.100"/>
                        	</refinement>
                        </schedules:count>
                    </schedule>
                    <job>
                    	<archive archiveName="Batch_01">
                    		<archiver>
                    			<file-persister dir="${this.args[0]}"/>
                    		</archiver>
                    	    <archiveIdentifier>
                    	    	<format date="${the-timer.current.fromDate}" format="mm_ss_SSS"/>
                    	    </archiveIdentifier>
                    		<job>
		                        <echo>Run at ${the-timer.current.fromDate}</echo>
                        	</job>
                        </archive>
                    </job>
                </scheduling:timer>
            </jobs>
        </sequential>
    </job>
</oddjob>

See Also:

Serialized Form

Author:

rob

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	stop Stop flag.

Constructor Summary

Constructors

Constructor and Description
ArchiveJob() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addStructuralListener(StructuralListener listener) Add a listener.
protected void	execute()
protected void	fireDestroyedState() Internal method to fire state.
java.lang.Object	getArchiveIdentifier()
java.lang.String	getArchiveName()
OddjobPersister	getArchiver()
protected StateChanger<ParentState>	getStateChanger()
boolean	hardReset() Perform a hard reset on the job.
protected IconHelper	iconHelper() Subclasses must provide a IconHelper.
protected void	onDestroy() Subclasses override this method to clear up resources.
void	removeStructuralListener(StructuralListener listener) Remove a listener.
void	run() Implement the main execute method for a job.
void	setArchiveIdentifier(java.lang.Object archive)
void	setArchiveName(java.lang.String path)
void	setArchiver(OddjobPersister archiver)
void	setJob(java.lang.Runnable job)
boolean	softReset() Perform a soft reset on the job.
protected ParentStateHandler	stateHandler() Subclasses must provide a StateHandler.
void	stop() Implementation for a typical stop.

Methods inherited from class org.oddjob.framework.extend.BasePrimary

configure, getName, logger, logger, loggerName, save, setName, toString

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Field Detail

stop

protected transient volatile boolean stop

Stop flag.

Constructor Detail

ArchiveJob

public ArchiveJob()

Constructor.

Method Detail

stateHandler

protected ParentStateHandler stateHandler()

Description copied from class: BaseComponent

Subclasses must provide a StateHandler.

Specified by:

stateHandler in class BaseComponent

Returns:

A State Handler. Never null.

iconHelper

protected IconHelper iconHelper()

Description copied from class: BaseComponent

Subclasses must provide a IconHelper.

Specified by:

iconHelper in class BaseComponent

Returns:

An Icon Helper. Never null.

getStateChanger

protected StateChanger<ParentState> getStateChanger()

run

public final void run()

Implement the main execute method for a job. This surrounds the doExecute method of the sub class and sets state for the job.

Specified by:

run in interface java.lang.Runnable

execute

protected void execute()
                throws java.lang.Throwable

Throws:

java.lang.Throwable

stop

public void stop()
          throws FailedToStopException

Implementation for a typical stop.

This stop implementation doesn't check that the job is executing as stop messages must cascade down the hierarchy to manually started jobs.

Specified by:

stop in interface Stoppable

Throws:

FailedToStopException

softReset

public boolean softReset()

Perform a soft reset on the job.

Specified by:

softReset in interface Resetable

Returns:

true if successful.

hardReset

public boolean hardReset()

Perform a hard reset on the job.

Specified by:

hardReset in interface Resetable

Returns:

true if successful.

getArchiveIdentifier

public java.lang.Object getArchiveIdentifier()

setArchiveIdentifier

public void setArchiveIdentifier(java.lang.Object archive)

getArchiveName

public java.lang.String getArchiveName()

setArchiveName

public void setArchiveName(java.lang.String path)

getArchiver

public OddjobPersister getArchiver()

setArchiver

public void setArchiver(OddjobPersister archiver)

addStructuralListener

public void addStructuralListener(StructuralListener listener)

Add a listener. The listener will immediately receive add notifications for all existing children.

Specified by:

addStructuralListener in interface Structural

Parameters:

listener - The listener.

removeStructuralListener

public void removeStructuralListener(StructuralListener listener)

Remove a listener.

Specified by:

removeStructuralListener in interface Structural

Parameters:

listener - The listener.

setJob

public void setJob(java.lang.Runnable job)

Property: job

Description: The child job.

Required: No, but pointless if missing.

Parameters:

job -

onDestroy

protected void onDestroy()

Description copied from class: BaseComponent

Subclasses override this method to clear up resources. This is called by the framework before child elements have been destroyed.

Overrides:

onDestroy in class BaseComponent

fireDestroyedState

protected void fireDestroyedState()

Internal method to fire state.

Specified by:

fireDestroyedState in class BaseComponent