javawrapper.TarArchive Class Reference

The TarArchive class implements the concept of a tar archive. More...

List of all members.

Public Member Functions

 TarArchive (InputStream inStream)
 The InputStream based constructors create a TarArchive for the purposes of e'x'tracting or lis't'ing a tar archive.
 TarArchive (InputStream inStream, int blockSize)
 TarArchive (InputStream inStream, int blockSize, int recordSize)
 TarArchive (OutputStream outStream)
 The OutputStream based constructors create a TarArchive for the purposes of 'c'reating a tar archive.
 TarArchive (OutputStream outStream, int blockSize)
 TarArchive (OutputStream outStream, int blockSize, int recordSize)
void setDebug (boolean debugF)
 Set the debugging flag.
boolean isVerbose ()
 Returns the verbosity setting.
void setVerbose (boolean verbose)
 Set the verbosity flag.
void setTarProgressDisplay (TarProgressDisplay display)
 Set the current progress display interface.
void setKeepOldFiles (boolean keepOldFiles)
 Set the flag that determines whether existing files are kept, or overwritten during extraction.
void setAsciiTranslation (boolean asciiTranslate)
 Set the ascii file translation flag.
void setTransFileTyper (TarTransFileTyper transTyper)
 Set the object that will determine if a file is of type ascii text for translation purposes.
void setUserInfo (int userId, String userName, int groupId, String groupName)
 Set user and group information that will be used to fill in the tar archive's entry headers.
int getUserId ()
 Get the user id being used for archive entry headers.
String getUserName ()
 Get the user name being used for archive entry headers.
int getGroupId ()
 Get the group id being used for archive entry headers.
String getGroupName ()
 Get the group name being used for archive entry headers.
String getTempDirectory ()
 Get the current temporary directory path.
void setTempDirectory (String path)
 Set the current temporary directory path.
int getRecordSize ()
 Get the archive's record size.
void closeArchive () throws IOException
 Close the archive.
void listContents () throws IOException, InvalidHeaderException
 Perform the "list" command and list the contents of the archive.
Vector< String > ListContentsAsString () throws IOException, InvalidHeaderException
 Perform the "list" command and list the contents of the archive.
void extractContents (File destDir) throws IOException, InvalidHeaderException
 Perform the "extract" command and extract the contents of the archive.
String ExtractFile (File destDir, String sName) throws IOException
 Extracts a single entry by searching for it by name.
String GetPath () throws IOException
 Gets the path info for this archive.
void writeEntry (TarEntry oldEntry, boolean recurse) throws IOException
 Write an entry to the archive.

Protected Attributes

boolean verbose
boolean debug
boolean keepOldFiles
boolean asciiTranslate
int userId
String userName
int groupId
String groupName
String rootPath
String tempPath
String pathPrefix
int recordSize
byte[] recordBuf
TarInputStream tarIn
TarOutputStream tarOut
TarTransFileTyper transTyper
TarProgressDisplay progressDisplay

Private Member Functions

void initialize (int recordSize)
 Common constructor initialization code.
String getTempFilePath (File eFile)
 Get a path for a temporary file for a given File.
void extractEntry (File destDir, TarEntry entry, String sName) throws IOException
 Extract an entry from the archive.
String ExtractHeaderEntry (TarEntry entry) throws IOException
 Extract a header entry from the archive and read its contents.


Detailed Description

The TarArchive class implements the concept of a tar archive.

A tar archive is a series of entries, each of which represents a file system object. Each entry in the archive consists of a header record. Directory entries consist only of the header record, and are followed by entries for the directory's contents. File entries consist of a header record followed by the number of records needed to contain the file's contents. All entries are written on record boundaries. Records are 512 bytes long.

TarArchives are instantiated in either read or write mode, based upon whether they are instantiated with an InputStream or an OutputStream. Once instantiated TarArchives read/write mode can not be changed.

There is currently no support for random access to tar archives. However, it seems that subclassing TarArchive, and using the TarBuffer.getCurrentRecordNum() and TarBuffer.getCurrentBlockNum() methods, this would be rather trvial.

LEM: I modified this file, which otherwise works extremely well, to be able to deal with the fact that older versions of TAR can't handle long file names. Instead, the tar entry header's name is just ././@longlink, and there is an extra entry inserted with the actual filename. This watches for this problem and works around it during extraction.

Version:
Revision
1.15
Author:
Timothy Gerard Endres, <time@gjt.org>
See also:
TarBuffer

TarHeader

TarEntry


Constructor & Destructor Documentation

javawrapper.TarArchive.TarArchive ( InputStream  inStream  ) 

The InputStream based constructors create a TarArchive for the purposes of e'x'tracting or lis't'ing a tar archive.

Thus, use these constructors when you wish to extract files from or list the contents of an existing tar archive.

javawrapper.TarArchive.TarArchive ( InputStream  inStream,
int  blockSize 
)

javawrapper.TarArchive.TarArchive ( InputStream  inStream,
int  blockSize,
int  recordSize 
)

javawrapper.TarArchive.TarArchive ( OutputStream  outStream  ) 

The OutputStream based constructors create a TarArchive for the purposes of 'c'reating a tar archive.

Thus, use these constructors when you wish to create a new tar archive and write files into it.

javawrapper.TarArchive.TarArchive ( OutputStream  outStream,
int  blockSize 
)

javawrapper.TarArchive.TarArchive ( OutputStream  outStream,
int  blockSize,
int  recordSize 
)


Member Function Documentation

void javawrapper.TarArchive.initialize ( int  recordSize  )  [private]

Common constructor initialization code.

void javawrapper.TarArchive.setDebug ( boolean  debugF  ) 

Set the debugging flag.

Parameters:
debugF The new debug setting.

boolean javawrapper.TarArchive.isVerbose (  ) 

Returns the verbosity setting.

Returns:
The current verbosity setting.

void javawrapper.TarArchive.setVerbose ( boolean  verbose  ) 

Set the verbosity flag.

Parameters:
verbose The new verbosity setting.

void javawrapper.TarArchive.setTarProgressDisplay ( TarProgressDisplay  display  ) 

Set the current progress display interface.

This allows the programmer to use a custom class to display the progress of the archive's processing.

Parameters:
display The new progress display interface.
See also:
TarProgressDisplay

void javawrapper.TarArchive.setKeepOldFiles ( boolean  keepOldFiles  ) 

Set the flag that determines whether existing files are kept, or overwritten during extraction.

Parameters:
keepOldFiles If true, do not overwrite existing files.

void javawrapper.TarArchive.setAsciiTranslation ( boolean  asciiTranslate  ) 

Set the ascii file translation flag.

If ascii file translatio is true, then the MIME file type will be consulted to determine if the file is of type 'text/*'. If the MIME type is not found, then the TransFileTyper is consulted if it is not null. If either of these two checks indicates the file is an ascii text file, it will be translated. The translation converts the local operating system's concept of line ends into the UNIX line end, '
', which is the defacto standard for a TAR archive. This makes text files compatible with UNIX, and since most tar implementations for other platforms, compatible with most other platforms.

Parameters:
asciiTranslate If true, translate ascii text files.

void javawrapper.TarArchive.setTransFileTyper ( TarTransFileTyper  transTyper  ) 

Set the object that will determine if a file is of type ascii text for translation purposes.

Parameters:
transTyper The new TransFileTyper object.

void javawrapper.TarArchive.setUserInfo ( int  userId,
String  userName,
int  groupId,
String  groupName 
)

Set user and group information that will be used to fill in the tar archive's entry headers.

Since Java currently provides no means of determining a user name, user id, group name, or group id for a given File, TarArchive allows the programmer to specify values to be used in their place.

Parameters:
userId The user Id to use in the headers.
userName The user name to use in the headers.
groupId The group id to use in the headers.
groupName The group name to use in the headers.

int javawrapper.TarArchive.getUserId (  ) 

Get the user id being used for archive entry headers.

Returns:
The current user id.

String javawrapper.TarArchive.getUserName (  ) 

Get the user name being used for archive entry headers.

Returns:
The current user name.

int javawrapper.TarArchive.getGroupId (  ) 

Get the group id being used for archive entry headers.

Returns:
The current group id.

String javawrapper.TarArchive.getGroupName (  ) 

Get the group name being used for archive entry headers.

Returns:
The current group name.

String javawrapper.TarArchive.getTempDirectory (  ) 

Get the current temporary directory path.

Because Java's File did not support temporary files until version 1.2, TarArchive manages its own concept of the temporary directory. The temporary directory defaults to the 'user.dir' System property.

Returns:
The current temporary directory path.

void javawrapper.TarArchive.setTempDirectory ( String  path  ) 

Set the current temporary directory path.

Parameters:
path The new temporary directory path.

int javawrapper.TarArchive.getRecordSize (  ) 

Get the archive's record size.

Because of its history, tar supports the concept of buffered IO consisting of BLOCKS of RECORDS. This allowed tar to match the IO characteristics of the physical device being used. Of course, in the Java world, this makes no sense, WITH ONE EXCEPTION - archives are expected to be propertly "blocked". Thus, all of the horrible TarBuffer support boils down to simply getting the "boundaries" correct.

Returns:
The record size this archive is using.

String javawrapper.TarArchive.getTempFilePath ( File  eFile  )  [private]

Get a path for a temporary file for a given File.

The temporary file is NOT created. The algorithm attempts to handle filename collisions so that the name is unique.

Returns:
The temporary file's path.

void javawrapper.TarArchive.closeArchive (  )  throws IOException

Close the archive.

This simply calls the underlying tar stream's close() method.

void javawrapper.TarArchive.listContents (  )  throws IOException, InvalidHeaderException

Perform the "list" command and list the contents of the archive.

NOTE That this method uses the progress display to actually list the conents. If the progress display is not set, nothing will be listed!

Vector<String> javawrapper.TarArchive.ListContentsAsString (  )  throws IOException, InvalidHeaderException

Perform the "list" command and list the contents of the archive.

This returns the headers as actual strings. This is @longlink safe.

Author:
Lora Murphy.

void javawrapper.TarArchive.extractContents ( File  destDir  )  throws IOException, InvalidHeaderException

Perform the "extract" command and extract the contents of the archive.

Parameters:
destDir The destination directory into which to extract.

String javawrapper.TarArchive.ExtractFile ( File  destDir,
String  sName 
) throws IOException

Extracts a single entry by searching for it by name.

The name doesn't have to match exactly (in case the path info is not present). The first entry that completely contains the entry's name string will be extracted.

Parameters:
destDir The destination directory into which to extract.
sName The name of the entry.
Returns:
Name of file extracted.
Exceptions:
java.io.IOException if there is a problem writing the file.

String javawrapper.TarArchive.GetPath (  )  throws IOException

Gets the path info for this archive.

@longlink safe.

Returns:
Path info for this archive.
Author:
Lora Murphy

void javawrapper.TarArchive.extractEntry ( File  destDir,
TarEntry  entry,
String  sName 
) throws IOException [private]

Extract an entry from the archive.

This method assumes that the tarIn stream has been properly set with a call to getNextEntry().

LEM: Added the sName parameter - this is what the extracted file will be named at all times.

Parameters:
destDir The destination directory into which to extract.
entry The TarEntry returned by tarIn.getNextEntry().
sName The name to extract to.

String javawrapper.TarArchive.ExtractHeaderEntry ( TarEntry  entry  )  throws IOException [private]

Extract a header entry from the archive and read its contents.

This method assumes that the tarIn stream has been properly set with a call to getNextEntry(), and that the next entry is in fact a text string. This doesn't have the good error checking normally in place in this library.

Created this to circumvent the need to write out and read back in the header string.

Author:
Lora Murphy
Parameters:
entry The TarEntry returned by tarIn.getNextEntry().

void javawrapper.TarArchive.writeEntry ( TarEntry  oldEntry,
boolean  recurse 
) throws IOException

Write an entry to the archive.

This method will call the putNextEntry() and then write the contents of the entry, and finally call closeEntry() for entries that are files. For directories, it will call putNextEntry(), and then, if the recurse flag is true, process each entry that is a child of the directory.

Parameters:
oldEntry The TarEntry representing the entry to write to the archive.
recurse If true, process the children of directory entries.


Member Data Documentation

boolean javawrapper.TarArchive.verbose [protected]

boolean javawrapper.TarArchive.debug [protected]

String javawrapper.TarArchive.userName [protected]

String javawrapper.TarArchive.rootPath [protected]

String javawrapper.TarArchive.tempPath [protected]

byte [] javawrapper.TarArchive.recordBuf [protected]

TarInputStream javawrapper.TarArchive.tarIn [protected]

TarOutputStream javawrapper.TarArchive.tarOut [protected]

TarTransFileTyper javawrapper.TarArchive.transTyper [protected]

TarProgressDisplay javawrapper.TarArchive.progressDisplay [protected]


The documentation for this class was generated from the following file:

Generated on Tue Apr 19 13:59:45 2011 for SORTIE Java Interface by  doxygen 1.5.6