|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AQArchive
Archive
Synopsis: A collection of different methods and algorithms to archive files. Description:
Method Summary | |
---|---|
void |
bunzip2(String zipFile,
String destination)
Expands a file that has been compressed with the BZIP2 algorithm. |
void |
bzip2(String sourceFile,
String zipFile)
Compresses a file with the BZIP2 algorithm. |
void |
cab(AQFileSet fileSet,
String cabFile)
Creates a Microsoft CAB archive file. |
void |
cab(String sourceDirectory,
String cabFile)
Creates a Microsoft CAB archive file. |
void |
ear(AQFileSet[] fileSets,
String earFile,
String appXMLFile)
An extension of the Jar task with special treatment for a collection of AQFileSets that ends up as an EAR (Enterprise Archive). |
void |
ear(AQFileSet fileSet,
String earFile,
String appXMLFile)
An extension of the Jar task with special treatment for an AQFileSet that ends up as an EAR file. |
void |
ear(String sourceDirectory,
String earFile,
String appXMLFile)
An extension of the Jar task with special treatment for a directory that ends up as an EAR file. |
void |
gunzip(String zipFile,
String destination)
Expands a file that has been compressed with the GZIP algorithm. |
void |
gzip(String sourceFile,
String zipFile)
Compresses a file with the GZIP algorithm. |
void |
jar(AQFileSet[] fileSets,
String jarFile)
Jars a set of files as defined in an AQFileSet. |
void |
jar(AQFileSet fileset,
String jarFile)
Jars a set of file as defined in an array of fileset |
void |
jar(String sourceDirectory,
String jarFile)
Jars a set of files specified in a directory. |
void |
manifest(String manifestFile,
Map<String,String> attributeMap,
Map<String,Map<String,String>> sectionMap)
Creates a manifest file, a specific file contained within a JAR archive. |
void |
signjar(String jarFile,
String alias,
String keyStore,
String storePass)
Signs a jar file with jarsigner, the JAR Signing and Verification command-line tool. |
void |
tar(AQFileSet[] fileSets,
String tarFile)
Create a tar archive from a set of files defined as an AQFileSet. |
void |
tar(AQFileSet fileSet,
String tarFile)
Creates a tar archive from an AQFileSet. |
void |
tar(String sourceDirectory,
String tarFile)
Creates a tar archive from a directory. |
void |
unjar(String jarFile,
String destinationDirectory)
Unzips a jar file. |
void |
untar(String tarFile,
String destinationDirectory)
Untars a tar file. |
void |
unwar(String warFile,
String destinationDirectory)
Unzips a war file. |
void |
unzip(String zipFile,
String destinationDirectory)
Unzips a zip file. |
void |
war(AQFileSet[] fileSets,
String warFile,
String webXMLFile)
An extension of the Jar task with special treatment for a collection of AQFileSets that ends up WAR (Web Application Archive) file. |
void |
war(AQFileSet fileSet,
String warFile,
String webXMLFile)
An extension of the Jar task with special treatment for a single AQFileSet that should end up in the WEB-INF/lib, WEB-INF/classes, or WEB-INF directories of the Web Application Archive. |
void |
war(String sourceDirectory,
String warFile,
String webXMLFile)
An extension of the Jar task with special treatment for files that should end up in the WEB-INF/lib, WEB-INF/classes, or WEB-INF directories of the Web Application Archive. |
void |
zip(AQFileSet[] fileSets,
String zipFile)
Creates a zip file from a list of AQFileSet. |
void |
zip(AQFileSet fileSet,
String zipFile)
Creates a zip file from a single AQFileSet. |
void |
zip(String[] sourceDirectoryList,
String[] sourceFileList,
String zipFile)
Creates a zip file from a list of directories. |
void |
zip(String source,
String zipFile)
Creates a zip file. |
Method Detail |
---|
void bunzip2(String zipFile, String destination) throws Exception
destination
is a directory the name of the destination file is the same as zipFile
(with the ".bz2"
extension removed if present). If destination
is omitted, the parent directory of zipFile
is taken. The file is only expanded if the source resource is newer than the destination file,
or when the destination file does not exist.
zipFile
- The file to expand; required.destination
- The destination file or directory.
Exception
- on errorvoid bzip2(String sourceFile, String zipFile) throws Exception
sourceFile
- The file to compress; required.zipFile
- The location of the compressed file; required.
Exception
- on errorvoid cab(String sourceDirectory, String cabFile) throws Exception
sourceDirectory
- The directory from which to archive files; requiredcabFile
- The location/file of where to create the CAB file; required.
Exception
- If cabFile
is a directory or is null
. If sourceDirectory
does not exist or is
null
.void cab(AQFileSet fileSet, String cabFile) throws Exception
fileSet
- The set of files to be added to the CAB archive.cabFile
- The location/file for where to create the CAB file; required.
Exception
- If cabFile
is a directory or is null
. If sourceDirectory
does not exist or is null
.void ear(String sourceDirectory, String earFile, String appXMLFile) throws Exception
sourceDirectory
- The directory from which to archive files.earFile
- The archived file; required.appXMLFile
- File to incorporate as application.xml; optional if earFile
already exists, otherwise required. Hence, if the EAR file
is created for the first time, this parameter is required.
If the parameter is optional, use null
.
Exception
- on errorvoid ear(AQFileSet[] fileSets, String earFile, String appXMLFile) throws Exception
fileSets
- The list of files to be added to the archive.earFile
- The archived file; required.appXMLFile
- File to incorporate as application.xml; optional if earFile
already exists, otherwise required. Hence, if the EAR file
is created for the first time, this parameter is required.
If the parameter is optional, use null
.
Exception
- on errorvoid ear(AQFileSet fileSet, String earFile, String appXMLFile) throws Exception
fileSet
- The list of files to be added to the archive.earFile
- The archived file; required.appXMLFile
- File to incorporate as application.xml; optional if earFile
already exists, otherwise required. Hence, if the EAR file is created
for the first time, this parameter is required. If the parameter is optional,
use null
.
Exception
- on errorvoid gunzip(String zipFile, String destination) throws Exception
destination
is a directory the name of the destination file is the same as zipFile
(with the ".gz"
extension removed if present). If destination
is omitted, the parent directory of
zipFile
is taken. The file is only expanded if the source resource is newer than the
destination file, or when the destination file does not exist.
zipFile
- The archived file; required.destination
- The destination file or directory.
Exception
- on errorvoid gzip(String sourceFile, String zipFile) throws Exception
sourceFile
- The file to compress; required;zipFile
- The compressed file; required;
Exception
- on errorvoid jar(String sourceDirectory, String jarFile) throws Exception
jarFile
exists, it will be overwritten.
sourceDirectory
- The directory from which to archive files; required.jarFile
- The archived file; required.
Exception
- on errorvoid jar(AQFileSet[] fileSets, String jarFile) throws Exception
fileSets
- The list of files to be added to the archive; required.jarFile
- The archived file; required.
Exception
- on errorvoid jar(AQFileSet fileset, String jarFile) throws Exception
fileset
- The list of files to be added to the archive; required.jarFile
- The archived file; required.
Exception
- on errorvoid manifest(String manifestFile, Map<String,String> attributeMap, Map<String,Map<String,String>> sectionMap) throws Exception
manifestFile
exists, it will be replaced.
manifestFile
- The name of the manifest file to create/update; required.attributeMap
- Configure attributes to be added to the manifest.sectionMap
- Configure sections to be added to the manifest.
Exception
- on errorvoid signjar(String jarFile, String alias, String keyStore, String storePass) throws Exception
jarFile
- The archived file; required.alias
- The alias to sign under; requiredkeyStore
- The keystore file; required.storePass
- The password for keystore integrity; required.
Exception
- on errorvoid tar(String sourceDirectory, String tarFile) throws Exception
sourceDirectory
- The directory from which to archive files; required.tarFile
- The archived file; required.
Exception
- on errorvoid tar(AQFileSet[] fileSets, String tarFile) throws Exception
fileSets
- The list of files to be added to the archive; required.tarFile
- The archived file; required.
Exception
- on errorvoid tar(AQFileSet fileSet, String tarFile) throws Exception
fileSet
- The list of files to be added to the archive; required.tarFile
- The archived file; required.
Exception
- on errorvoid unjar(String jarFile, String destinationDirectory) throws Exception
destinationDirectory
will be overwritten regardless of timestamp.
jarFile
- The archived file; required.destinationDirectory
- The destination file or directory.
Exception
- on errorvoid untar(String tarFile, String destinationDirectory) throws Exception
destinationDirectory
will be overwritten regardless of timestamp.
tarFile
- The archived file; required.destinationDirectory
- The destination file or directory; required.
Exception
- on errorvoid unwar(String warFile, String destinationDirectory) throws Exception
destinationDirectory
will be overwritten regardless of timestamp.
warFile
- The archived file; required.destinationDirectory
- The destination file or directory.
Exception
- on errorvoid unzip(String zipFile, String destinationDirectory) throws Exception
destinationDirectory
will be overwritten regardless of timestamp.
zipFile
- The archived file; required.destinationDirectory
- The destination file or directory.
Exception
- on errorvoid war(String sourceDirectory, String warFile, String webXMLFile) throws Exception
warFile
will be overwritten if there are changes or new files in the sourceDirectory
.
sourceDirectory
- The directory from which to archive files; required.warFile
- The archived file; required.webXMLFile
- Set the deployment descriptor to use (WEB-INF/web.xml); optional.
If the parameter is optional, use null
.
Exception
- on errorvoid war(AQFileSet[] fileSets, String warFile, String webXMLFile) throws Exception
fileSets
- The list of files to be added to the archive; required.warFile
- The archived file; required.webXMLFile
- Set the deployment descriptor to use (WEB-INF/web.xml); optional.
If the parameter is optional, use null
.
Exception
- on errorvoid war(AQFileSet fileSet, String warFile, String webXMLFile) throws Exception
fileSet
- The list of files to be added to the archive; required.warFile
- The archived file; required.webXMLFile
- Set the deployment descriptor to use (WEB-INF/web.xml); optional.
If the parameter is optional, use null
.
Exception
- on errorvoid zip(String source, String zipFile) throws Exception
zipFile
cannot be created. zipFile
will be overwritten if files are added or updated in source
.
source
- The file or directory from which to archive; required.zipFile
- The archived file; required.
Exception
- on errorvoid zip(String[] sourceDirectoryList, String[] sourceFileList, String zipFile) throws Exception
zipFile
cannot be created.
zipFile
will be overwritten if files are added or updated in sourceDirectoryList
or in sourceFileList
.
sourceDirectoryList
- An array of directories from which to archive files.sourceFileList
- An array of files from which to archive.zipFile
- The archived file; required.
Exception
- on errorvoid zip(AQFileSet[] fileSets, String zipFile) throws Exception
zipFile
cannot be created.
zipFile
will be overwritten if files are added or updated in fileSets
.
fileSets
- The list of files to be added to the archive; required.zipFile
- The archived file; required.
Exception
- on errorvoid zip(AQFileSet fileSet, String zipFile) throws Exception
zipFile
cannot be created.
zipFile
will be overwritten if files are added or updated in fileSet
.
fileSet
- The list of files to be added to the archive; required.zipFile
- The archived file; required.
Exception
- on error
|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |