org.apache.commons.compress.archivers
Class ArchiveStreamFactory

java.lang.Object
  org.apache.commons.compress.archivers.ArchiveStreamFactory

public class ArchiveStreamFactory
extends Object

Factory to create Archive[In|Out]putStreams from names or the first bytes of the InputStream. In order add other implementations you should extend ArchiveStreamFactory and override the appropriate methods (and call their implementation from super of course).

 final OutputStream out = new FileOutputStream(output); 
 ArchiveOutputStream os = new ArchiveStreamFactory().createArchiveOutputStream(ArchiveStreamFactory.ZIP, out);
 
 os.putArchiveEntry(new ZipArchiveEntry("testdata/test1.xml"));
 IOUtils.copy(new FileInputStream(file1), os);
 os.closeArchiveEntry();

 os.putArchiveEntry(new ZipArchiveEntry("testdata/test2.xml"));
 IOUtils.copy(new FileInputStream(file2), os);
 os.closeArchiveEntry();
 os.close();
 

 final InputStream is = new FileInputStream(input); 
 ArchiveInputStream in = new ArchiveStreamFactory().createArchiveInputStream(ArchiveStreamFactory.ZIP, is);
 ZipArchiveEntry entry = (ZipArchiveEntry)in.getNextEntry();
 OutputStream out = new FileOutputStream(new File(dir, entry.getName()));
 IOUtils.copy(in, out);
 out.close();
 in.close();
 

AR

public static final String AR

Constant used to identify the AR archive format.

Since:

Commons Compress 1.1

See Also:

Constant Field Values

CPIO

public static final String CPIO

Constant used to identify the CPIO archive format.

Since:

Commons Compress 1.1

See Also:

Constant Field Values

DUMP

public static final String DUMP

Constant used to identify the Unix DUMP archive format.

Since:

Commons Compress 1.3

See Also:

Constant Field Values

JAR

public static final String JAR

Constant used to identify the JAR archive format.

Since:

Commons Compress 1.1

See Also:

Constant Field Values

TAR

public static final String TAR

Constant used to identify the TAR archive format.

Since:

Commons Compress 1.1

See Also:

Constant Field Values

ZIP

public static final String ZIP

Constant used to identify the ZIP archive format.

Since:

Commons Compress 1.1

See Also:

Constant Field Values

ArchiveStreamFactory

public ArchiveStreamFactory()

getEntryEncoding

public String getEntryEncoding()

Returns the encoding to use for zip and tar files, or null for the default.

Returns:

entry encoding, or null

Since:

1.5

setEntryEncoding

public void setEntryEncoding(String entryEncoding)

Sets the encoding to use for zip and tar files. Use null for the default.

Since:

1.5

createArchiveInputStream

public ArchiveInputStream createArchiveInputStream(String archiverName,
                                                   InputStream in)
                                            throws ArchiveException

Create an archive input stream from an archiver name and an input stream.

Parameters:

archiverName - the archive name, i.e. "ar", "zip", "tar", "jar", "dump" or "cpio"

in - the input stream

Returns:

the archive input stream

Throws:

ArchiveException - if the archiver name is not known

IllegalArgumentException - if the archiver name or stream is null

createArchiveOutputStream

public ArchiveOutputStream createArchiveOutputStream(String archiverName,
                                                     OutputStream out)
                                              throws ArchiveException

Create an archive output stream from an archiver name and an input stream.

Parameters:

archiverName - the archive name, i.e. "ar", "zip", "tar", "jar" or "cpio"

out - the output stream

Returns:

the archive output stream

Throws:

ArchiveException - if the archiver name is not known

IllegalArgumentException - if the archiver name or stream is null

createArchiveInputStream

public ArchiveInputStream createArchiveInputStream(InputStream in)
                                            throws ArchiveException

Create an archive input stream from an input stream, autodetecting the archive type from the first few bytes of the stream. The InputStream must support marks, like BufferedInputStream.

Parameters:

in - the input stream

Returns:

the archive input stream

Throws:

ArchiveException - if the archiver name is not known

IllegalArgumentException - if the stream is null or does not support mark