com.highqsoft.xsd

Class Archive

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.Archive

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class Archive
extends AbstractImplementation
implements ExecutableIF

This is the abstract archiver executable. Extend this class to create a local zip file. The object is able to consume the following properties:

Property Keyword	Datatype	Default	Description
dir	String	none	The directory that is the root for that operation. The zip entries will be added relative to that point.
filename	String	none	The name of the archive file.
comment	String	none	An optional comment text that is added to the zip file.
prefix	String	none	An optional zip entry prefix.
absolute	Boolean	false	If this value is true the filename path is save absolute.
extract	Boolean	false	Set this value to true to extract the filename into the given directory.
deleteafterextract	Boolean	false	Set this value to true to delete archive file after unzip.
checksum	Boolean	true	Set this value to true to chekc the stream with a checksum.

The following table lists the properties that should be set in the main context.

Argument Keyword	Datatype	Default	Description
ERROR.MissingArgument	String	The argument {0} is missing.	The message that is used when an argument is missing.

Since:

$Date: 2017/04/06 13:30:29 $

Version:

$Revision: 1.21 $

Author:

Andreas Hofmann

See Also:

ImplementationIF

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	absolute
protected java.lang.String	comment
protected boolean	deleteAfterExtract
protected java.lang.String	dir
protected boolean	extract
protected java.lang.String	filename
protected java.io.File[]	files
protected java.lang.String	prefix
protected java.util.zip.ZipOutputStream	zip

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
Archive()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the program.
java.io.FileFilter	getFileFilter() Get the file filter to chek files for transfer.
java.io.File[]	getFiles() Get all the file to be a part of the zip file.
protected void	getFiles(java.util.Vector<java.io.File> vec, java.io.File dir, java.io.FileFilter filter) Get all the file to be a part of the zip file.
void	init() Initialize the work.
void	setArguments(java.util.Properties args) Set argument property map.
void	setFilename(java.lang.String filename) The the archive filename.
void	terminate() Terminate the execution.
protected void	unzip() UNZIP the files.
protected void	zip() ZIP the files.

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setContext, setDescriptor

Field Detail

dir

protected java.lang.String dir

filename

protected java.lang.String filename

prefix

protected java.lang.String prefix

comment

protected java.lang.String comment

absolute

protected boolean absolute

extract

protected boolean extract

deleteAfterExtract

protected boolean deleteAfterExtract

zip

protected java.util.zip.ZipOutputStream zip

files

protected java.io.File[] files

Constructor Detail

Archive

public Archive()

Method Detail

setArguments

public void setArguments(java.util.Properties args)
                  throws InvalidArgumentException

Set argument property map.

Specified by:

setArguments in interface ImplementationIF

Overrides:

setArguments in class AbstractImplementation

Parameters:

args - the property map

Throws:

InvalidArgumentException - if the arguments are not valid.

init

public void init()
          throws InitializationFailedException

Initialize the work.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

execute

public void execute()
             throws ExecutableException

Execute the program.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException

zip

protected void zip()
            throws ExecutableException

ZIP the files.

Throws:

ExecutableException

unzip

protected void unzip()
              throws ExecutableException

UNZIP the files.

Throws:

ExecutableException

terminate

public void terminate()
               throws TerminationException

Terminate the execution.

Specified by:

terminate in interface ExecutableIF

Throws:

TreminatinoException

TerminationException - if termination fails.

setFilename

public void setFilename(java.lang.String filename)

The the archive filename. The call of this method makes sense before execute method is called only.

Parameters:

filename - the name of the archive.

getFiles

public java.io.File[] getFiles()

Get all the file to be a part of the zip file.

Returns:

an array containing all the file for the archive.

getFiles

protected void getFiles(java.util.Vector<java.io.File> vec,
            java.io.File dir,
            java.io.FileFilter filter)

Get all the file to be a part of the zip file.

getFileFilter

public java.io.FileFilter getFileFilter()

Get the file filter to chek files for transfer. The default implementation accepts all files.

Returns:

the file filter that check files.