Package org.docx4j.openpackaging.io3.stores

Class ZipPartStore

java.lang.Object

org.docx4j.openpackaging.io3.stores.ZipPartStore

All Implemented Interfaces:

PartStore

public class ZipPartStore
extends Object
implements PartStore

Load a zipped up package from a file or input stream; save it to some output stream.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZipPartStore.ByteArray

Field Summary

Fields

Modifier and Type	Field	Description
private static org.slf4j.Logger	log
(package private) long	MAX_BYTES_Unzip_Error
(package private) HashMap<String,ZipPartStore.ByteArray>	partByteArrays
private PartStore	sourcePartStore
private org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream	zos

Constructor Summary

Constructors

Constructor	Description
ZipPartStore()
ZipPartStore(File f)
ZipPartStore(InputStream is)

Method Summary

Modifier and Type	Method	Description
void	dispose()
void	finishSave()	Anything necessary to perfect the save operation.
ZipPartStore.ByteArray	getByteArray(String partName)	This method is to facilitate updating the part without JAXB unmarshalling then marshalling.
private byte[]	getBytesFromInputStream(InputStream is, long size)
long	getPartSize(String partName)	The size of this part in bytes.
private void	initMaxBytes()
InputStream	loadPart(String partName)	Returns null if the part does not exist.
boolean	partExists(String partName)
private void	policePartSize(File f, long length, String entryName)
void	rename(PartName oldName, PartName newName)	Rename a part in the part store.
void	saveBinaryPart(Part part)
void	saveContentTypes(ContentTypeManager ctm)
void	saveCustomXmlDataStoragePart(CustomXmlDataStoragePart part)
void	saveJaxbXmlPart(JaxbXmlPart part)
void	saveXmlPart(XmlPart part)
void	setOutputStream(OutputStream os)
void	setSourcePartStore(PartStore partStore)	Set this if its different to the target part store (ie this object)
private static boolean	shouldCompress(Part part)

Methods inherited from class java.lang.Object

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

Field Details

log

private static org.slf4j.Logger log

partByteArrays

HashMap<String,ZipPartStore.ByteArray> partByteArrays

MAX_BYTES_Unzip_Error

long MAX_BYTES_Unzip_Error

sourcePartStore

private PartStore sourcePartStore

zos

private org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zos

Constructor Details

ZipPartStore

public ZipPartStore()

ZipPartStore

public ZipPartStore(File f)
             throws Docx4JException

Throws:

Docx4JException

ZipPartStore

public ZipPartStore(InputStream is)
             throws Docx4JException

Throws:

Docx4JException

Method Details

initMaxBytes

private void initMaxBytes()

policePartSize

private void policePartSize(File f,
 long length,
 String entryName)
                     throws PartTooLargeException

Throws:

PartTooLargeException

setSourcePartStore

public void setSourcePartStore(PartStore partStore)

Set this if its different to the target part store (ie this object)

Specified by:

setSourcePartStore in interface PartStore

partExists

public boolean partExists(String partName)

getBytesFromInputStream

private byte[] getBytesFromInputStream(InputStream is,
 long size)
                                throws Exception

Throws:

Exception

loadPart

public InputStream loadPart(String partName)
                     throws Docx4JException

Description copied from interface: PartStore

Returns null if the part does not exist. This will happen when calling code optimistically tries to fetch a rels part (which may or may not exist). Note: JaxbXmlPart and JaxbXmlPartXPathAware both unmarshal lazily (ie can invoke this sometime after the docx is loaded). Caller (generally docx4j itself) should close the resulting InputStream after use.

Specified by:

loadPart in interface PartStore

Returns:

Throws:

Docx4JException

getPartSize

public long getPartSize(String partName)
                 throws Docx4JException

Description copied from interface: PartStore

The size of this part in bytes. Return -1 if the part does not exist.

Specified by:

getPartSize in interface PartStore

Returns:

Throws:

Docx4JException

getByteArray

public ZipPartStore.ByteArray getByteArray(String partName)
                                    throws Docx4JException

This method is to facilitate updating the part without JAXB unmarshalling then marshalling. Not intended for direct use by user code.

Parameters:

partName -

Returns:

Throws:

Docx4JException

Since:

3.3.2

rename

public void rename(PartName oldName,
 PartName newName)

Description copied from interface: PartStore

Rename a part in the part store. Useful where a part is being renamed, but its content has not been loaded. (The existing approach is to manually force the content to be loaded)

Specified by:

rename in interface PartStore

Parameters:

oldName -

newName -

Since:

8.1.4

setOutputStream

public void setOutputStream(OutputStream os)

Specified by:

setOutputStream in interface PartStore

Parameters:

zipOutputStream - the zipOutputStream to set

saveContentTypes

public void saveContentTypes(ContentTypeManager ctm)
                      throws Docx4JException

Specified by:

saveContentTypes in interface PartStore

Throws:

Docx4JException

saveJaxbXmlPart

public void saveJaxbXmlPart(JaxbXmlPart part)
                     throws Docx4JException

Specified by:

saveJaxbXmlPart in interface PartStore

Throws:

Docx4JException

saveCustomXmlDataStoragePart

public void saveCustomXmlDataStoragePart(CustomXmlDataStoragePart part)
                                  throws Docx4JException

Specified by:

saveCustomXmlDataStoragePart in interface PartStore

Throws:

Docx4JException

saveXmlPart

public void saveXmlPart(XmlPart part)
                 throws Docx4JException

Specified by:

saveXmlPart in interface PartStore

Throws:

Docx4JException

saveBinaryPart

public void saveBinaryPart(Part part)
                    throws Docx4JException

Specified by:

saveBinaryPart in interface PartStore

Throws:

Docx4JException

shouldCompress

private static boolean shouldCompress(Part part)

finishSave

public void finishSave()
                throws Docx4JException

Description copied from interface: PartStore

Anything necessary to perfect the save operation. For example,

Specified by:

finishSave in interface PartStore

Throws:

Docx4JException

dispose

public void dispose()

Specified by:

dispose in interface PartStore