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

Class DeleteResourcesProcessor

java.lang.Object

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

All Implemented Interfaces:

ExtensionsFileProcessor

public class DeleteResourcesProcessor
extends Object
implements ExtensionsFileProcessor

A file processor implementation that removes all resources that was previously extracted from a JAR file. The main target directory must be specified when an instance is constructed. Each processed JAR file is assumed to have been extracted into a subdirectory with the same name as the JAR file. This directory will be removed.

This processor is usually paired with a DeletedFilter to only delete resources related to extension files that have been deleted. Using this processor without a filter will remove resources for all extensions.

Extensions files that are not a JAR file are always ignored by this processer.

Since:

3.0

Author:

Nicklas

Last modified

$Date: 2014-04-09 14:21:20 +0200 (on, 09 apr 2014) $

Field Summary

Fields

Modifier and Type	Field	Description
private static final Logger	log
private final File	mainDir
private int	numDeleted
private int	numError
private int	numFiles
private final ProcessResults	results

Constructor Summary

Constructors

Constructor	Description
DeleteResourcesProcessor(File mainDir, ProcessResults results)	Create a new processor.

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.
int	getNumDeleted()	Get the total number of resources that was deleted.
int	getNumError()	Get the number of files that was had an error.
int	getNumFiles()	Get the number of files that was successfully processed.
void	processFile(ExtensionsManager manager, ExtensionsFile.WriteableExtensionsFile wFile)	Called by the extensions manager for each extensions file that it manages.

Methods inherited from class java.lang.Object

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

Field Details

log

private static final Logger log

mainDir

private final File mainDir

results

private final ProcessResults results

numFiles

private int numFiles

numError

private int numError

numDeleted

private int numDeleted

Constructor Details

DeleteResourcesProcessor

public DeleteResourcesProcessor(File mainDir,
 ProcessResults results)

Create a new processor.

Parameters:

mainDir - The main directory to where the resources are located

results - Optional object for storing 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

getNumFiles

public int getNumFiles()

Get the number of files that was successfully processed.

getNumError

public int getNumError()

Get the number of files that was had an error.

getNumDeleted

public int getNumDeleted()

Get the total number of resources that was deleted.