nl.nn.adapterframework.compression

Class ZipWriter

java.lang.Object

nl.nn.adapterframework.compression.ZipWriter

All Implemented Interfaces:

AutoCloseable, ICollector<IZipWritingElement>

public class ZipWriter
extends Object
implements ICollector<IZipWritingElement>

Helper class to create Zip archives.

Since:

4.9.10

Author:

Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.logging.log4j.Logger	log
static String	PARAMETER_CONTENTS
static String	PARAMETER_FILENAME

Constructor Summary

Constructors

Constructor and Description
ZipWriter(OutputStream resultStream, boolean closeOnExit)

Method Summary

Modifier and Type	Method and Description
void	close()
void	closeEntry()
static void	configure(CollectionActor.Action action, ParameterList parameterList)
static ZipWriter	createZipWriter(PipeLineSession session, String handlekey, OutputStream resultStream, boolean closeOnExit)
static ZipWriter	getZipWriter(PipeLineSession session, String handlekey)
static ZipWriter	openCollection(Message message, PipeLineSession session, ParameterValueList pvl, IZipWritingElement writingElement)
void	openEntry(String filename)
MessageOutputStream	provideOutputStream(PipeLineSession session, ParameterValueList pvl, IZipWritingElement writingElement) provide a MessageOutputStream message that can be used to write a single item to
OutputStream	streamItem(Message input, PipeLineSession session, ParameterValueList pvl, IZipWritingElement writingElement) return an OutputStream message that can be used to write a single item to
void	writeEntry(String filename, Message contents, boolean close, String charset)
void	writeEntryWithCompletedHeader(String filename, Message contents, boolean close, String charset)
Message	writeItem(Message input, PipeLineSession session, ParameterValueList pvl, IZipWritingElement writingElement) write (or add) a single item to the collection

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.logging.log4j.Logger log

PARAMETER_FILENAME

public static final String PARAMETER_FILENAME

See Also:

Constant Field Values

PARAMETER_CONTENTS

public static final String PARAMETER_CONTENTS

See Also:

Constant Field Values

Constructor Detail

ZipWriter

public ZipWriter(OutputStream resultStream,
                 boolean closeOnExit)

Method Detail

getZipWriter

public static ZipWriter getZipWriter(PipeLineSession session,
                                     String handlekey)

createZipWriter

public static ZipWriter createZipWriter(PipeLineSession session,
                                        String handlekey,
                                        OutputStream resultStream,
                                        boolean closeOnExit)

configure

public static void configure(CollectionActor.Action action,
                             ParameterList parameterList)
                      throws ConfigurationException

Throws:

ConfigurationException

openCollection

public static ZipWriter openCollection(Message message,
                                       PipeLineSession session,
                                       ParameterValueList pvl,
                                       IZipWritingElement writingElement)
                                throws CollectionException

Throws:

CollectionException

openEntry

public void openEntry(String filename)
               throws CompressionException

Throws:

CompressionException

closeEntry

public void closeEntry()
                throws CompressionException

Throws:

CompressionException

close

public void close()
           throws CompressionException

Specified by:

close in interface AutoCloseable

Throws:

CompressionException

writeItem

public Message writeItem(Message input,
                         PipeLineSession session,
                         ParameterValueList pvl,
                         IZipWritingElement writingElement)
                  throws CollectionException,
                         TimeoutException

Description copied from interface: ICollector

write (or add) a single item to the collection

Specified by:

writeItem in interface ICollector<IZipWritingElement>

Throws:

CollectionException

TimeoutException

provideOutputStream

public MessageOutputStream provideOutputStream(PipeLineSession session,
                                               ParameterValueList pvl,
                                               IZipWritingElement writingElement)
                                        throws CollectionException

Description copied from interface: ICollector

provide a MessageOutputStream message that can be used to write a single item to

Specified by:

provideOutputStream in interface ICollector<IZipWritingElement>

Throws:

CollectionException

streamItem

public OutputStream streamItem(Message input,
                               PipeLineSession session,
                               ParameterValueList pvl,
                               IZipWritingElement writingElement)
                        throws CollectionException

Description copied from interface: ICollector

return an OutputStream message that can be used to write a single item to

Specified by:

streamItem in interface ICollector<IZipWritingElement>

Throws:

CollectionException

writeEntry

public void writeEntry(String filename,
                       Message contents,
                       boolean close,
                       String charset)
                throws CompressionException,
                       IOException

Throws:

CompressionException

IOException

writeEntryWithCompletedHeader

public void writeEntryWithCompletedHeader(String filename,
                                          Message contents,
                                          boolean close,
                                          String charset)
                                   throws CompressionException,
                                          IOException

Throws:

CompressionException

IOException