Package net.sf.basedb.util.extensions.manager.processor

Class IgnoreFileProcessor

java.lang.Object

net.sf.basedb.util.extensions.manager.processor.IgnoreFileProcessor

All Implemented Interfaces:

ExtensionsFileProcessor

public class IgnoreFileProcessor
extends Object
implements ExtensionsFileProcessor

Processor implementation for ignoring files. This processor need to be done in two steps due to ordering issues when an already installed extension has been selected for both uninstallation and ignoring.

The first step is executed via the manager: ExtensionsManager.processFiles(ExtensionsFileProcessor) and should be done before the UninstalledFileProcessor is exectued.

The second step is either automatically executed when all files have been processed or by calling finalizeRegistration(ExtensionsManager) and should be done as the last step of the installation procedure.

Since:

3.10

Author:

Nicklas

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	delayRegistration
private Set<ExtensionsFile.WriteableExtensionsFile>	filesToIgnore
private int	numFiles
private ProcessResults	results

Constructor Summary

Constructors

Constructor	Description
IgnoreFileProcessor(ProcessResults results)

Method Summary

Modifier and Type	Method	Description
void	begin(ExtensionsManager manager, int numFiles)	Called by the extensions manager before the processing starts.
void	done(ExtensionsManager manager)	Called by the extensions manager after a successful completion of the processing.
void	done(ExtensionsManager manager, Throwable t)	Called by the extensions manager if an exception was thrown by the processor.
void	finalizeRegistration(ExtensionsManager manager)	Finalize the ignore registration.
int	getNumFiles()	Get the number of files that was processed.
boolean	isRegistrationDelayed()	Is the actual registration delayed or not?
void	processFile(ExtensionsManager manager, ExtensionsFile.WriteableExtensionsFile wFile)	Called by the extensions manager for each extensions file that it manages.
void	setDelayRegistration(boolean delayRegistration)	Set a flag to indicate if the actual registration of the found extensions and extension points should be delayed or not.

Methods inherited from class java.lang.Object

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

Field Details

results

private final ProcessResults results

filesToIgnore

private Set<ExtensionsFile.WriteableExtensionsFile> filesToIgnore

numFiles

private int numFiles

delayRegistration

private boolean delayRegistration

Constructor Details

IgnoreFileProcessor

public IgnoreFileProcessor(ProcessResults results)

Method Details

begin

public void begin(ExtensionsManager manager,
int numFiles)

Description copied from interface: ExtensionsFileProcessor

Called by the extensions manager before the processing starts.

Specified by:

begin in interface ExtensionsFileProcessor

Parameters:

manager - The manager that is executing the action

numFiles - The number of extension files that is going to be processed this time

processFile

public void processFile(ExtensionsManager manager,
ExtensionsFile.WriteableExtensionsFile wFile)

Description copied from interface: ExtensionsFileProcessor

Called by the extensions manager for each extensions file that it manages. The order of the files is generally not predicatable and may change from one invokation to the next.

If the processor throws an exception the manager will abort processing and call ExtensionsFileProcessor.done(ExtensionsManager, Throwable). Error that are related to a specific file should be catched by the processor and registered by calling .......

If all files was processed without exceptions the manager will call ExtensionsFileProcessor.done(ExtensionsManager).

Note that the file is read-only to begin with. If the processor wants to call any write-operation the file must be opened by calling ExtensionsFile.WriteableExtensionsFile.open(). It is recommended that the processor calls ExtensionsFile.WriteableExtensionsFile.close() once it is done writing.

Specified by:

processFile in interface ExtensionsFileProcessor

Parameters:

manager - The manager that is executing the action

wFile - The file to be processed

done

public void done(ExtensionsManager manager)

Description copied from interface: ExtensionsFileProcessor

Called by the extensions manager after a successful completion of the processing.

Specified by:

done in interface ExtensionsFileProcessor

Parameters:

manager - The manager that is executing the action

done

public void done(ExtensionsManager manager,
Throwable t)

Description copied from interface: ExtensionsFileProcessor

Called by the extensions manager if an exception was thrown by the processor.

Specified by:

done in interface ExtensionsFileProcessor

Parameters:

manager - The manager that is executing the action

t - The exception

setDelayRegistration

public void setDelayRegistration(boolean delayRegistration)

Set a flag to indicate if the actual registration of the found extensions and extension points should be delayed or not. The default is to not delay registration, which means that it happend when the done(ExtensionsManager) method is called by the manager. If this flag is set the finalizeRegistration(ExtensionsManager) method must be explicitely called.

isRegistrationDelayed

public boolean isRegistrationDelayed()

Is the actual registration delayed or not?

getNumFiles

public int getNumFiles()

Get the number of files that was processed.

finalizeRegistration

public void finalizeRegistration(ExtensionsManager manager)

Finalize the ignore registration.