| java.lang.Object org.clapper.curn.plugins.ZipOutputPlugIn
ZipOutputPlugIn | public class ZipOutputPlugIn implements MainConfigItemPlugIn,PostOutputPlugIn(Code) | | The ZipOutputPlugIn handles zipping up the output from a
curn run, if one or more email addresses are specified in the
configuration file. It intercepts the following main ([curn])
section configuration parameter:
ZipOutputTo |
The path to the zip file to receive the output files. The zip
file is overwritten if it exists. |
version: $Revision: 7041 $ |
Constructor Summary | |
public | ZipOutputPlugIn() Default constructor (required). |
ZipOutputPlugIn | public ZipOutputPlugIn()(Code) | | Default constructor (required).
|
getPlugInName | public String getPlugInName()(Code) | | Get a displayable name for the plug-in.
the name |
getPlugInSortKey | public String getPlugInSortKey()(Code) | | Get the sort key for this plug-in.
the sort key string. |
initPlugIn | public void initPlugIn() throws CurnException(Code) | | Initialize the plug-in. This method is called before any of the
plug-in methods are called.
throws: CurnException - on error |
runMainConfigItemPlugIn | public void runMainConfigItemPlugIn(String sectionName, String paramName, CurnConfig config) throws CurnException(Code) | | Called immediately after curn has read and processed a
configuration item in the main [curn] configuration section. All
configuration items are passed, one by one, to each loaded plug-in.
If a plug-in class is not interested in a particular configuration
item, this method should simply return without doing anything. Note
that some configuration items may simply be variable assignment;
there's no real way to distinguish a variable assignment from a
blessed configuration item.
Parameters: sectionName - the name of the configuration section wherethe item was found Parameters: paramName - the name of the parameter Parameters: config - the CurnConfig object throws: CurnException - on error See Also: CurnConfig |
runPostOutputPlugIn | public void runPostOutputPlugIn(Collection<OutputHandler> outputHandlers) throws CurnException(Code) | | Called after curn has flushed all output handlers. A
post-output plug-in is a useful place to consolidate the output from
all output handlers. For instance, such a plug-in might pack all the
output into a zip file, or email it.
Parameters: outputHandlers - a Collection of theOutputHandler objects (useful forobtaining the output files, for instance). throws: CurnException - on error See Also: OutputHandler |
|
|