Package net.sf.basedb.clients.web.extensions

Class LoadServletsProcessor

java.lang.Object

net.sf.basedb.clients.web.extensions.LoadServletsProcessor

All Implemented Interfaces:

ExtensionsFileProcessor

public class LoadServletsProcessor
extends Object
implements ExtensionsFileProcessor

Processor implementation that define servlets based on what it can find in the META-INF/servlets.xml file. The processor only works with JAR files.

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 ServletContext	context
private static org.slf4j.Logger	log
private int	numError
private int	numFiles
private int	numServlets
private ProcessResults	results

Constructor Summary

Constructors

Constructor	Description
LoadServletsProcessor(ServletContext context, 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.
int	getNumError()	Get the number of files that was had an error.
int	getNumFiles()	Get the number of files that was successfully processed.
int	getNumServlets()	Get the total number of servlets found during the last processing.
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 org.slf4j.Logger log

context

private final ServletContext context

results

private final ProcessResults results

numFiles

private int numFiles

numError

private int numError

numServlets

private int numServlets

Constructor Details

LoadServletsProcessor

public LoadServletsProcessor(ServletContext context,
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

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.

getNumServlets

public int getNumServlets()

Get the total number of servlets found during the last processing.