3.2.4: 2013-12-06

net.sf.basedb.clients.web.extensions
Class InstalledFileProcessor

java.lang.Object
  extended by net.sf.basedb.util.extensions.manager.processor.MarkAsProcessedProcessor
      extended by net.sf.basedb.clients.web.extensions.InstalledFileProcessor
All Implemented Interfaces:
ExtensionsFileProcessor

public class InstalledFileProcessor
extends MarkAsProcessedProcessor

File processor implementation that sets a final result status for each processed file (eg. "Installed", "Updated", "Deleted", etc). It will also mark all files as processed and installed.

Since:
3.0
Author:
Nicklas
Last modified
$Date: 2011-04-27 11:27:56 +0200 (Wed, 27 Apr 2011) $

Field Summary
private  ProcessResults results
           
 
Constructor Summary
InstalledFileProcessor(ProcessResults results)
           
 
Method Summary
 void processFile(ExtensionsManager manager, ExtensionsFile.WriteableExtensionsFile wFile)
          Called by the extensions manager for each extensions file that it manages.
 
Methods inherited from class net.sf.basedb.util.extensions.manager.processor.MarkAsProcessedProcessor
begin, done, done, getNumFiles
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

results

private final ProcessResults results
Constructor Detail

InstalledFileProcessor

public InstalledFileProcessor(ProcessResults results)
Method Detail

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
Overrides:
processFile in class MarkAsProcessedProcessor
Parameters:
manager - The manager that is executing the action
wFile - The file to be processed

3.2.4: 2013-12-06