Package com.levigo.jadice.server.mail.worker

Class AttachmentDirectoryFactory

java.lang.Object

com.levigo.jadice.server.mail.worker.AttachmentDirectoryFactory

public final class AttachmentDirectoryFactory
extends Object

Utility class to create an AttachmentDirectory from a bunch of email attachments. If these attachments are PDFs (or converted to PDF) page counting will be performed in order to generate a proper TOC.

Field Summary

Fields

Modifier and Type	Field	Description
static String	COVER_FOR	Add another StreamDescriptor with this key in the given StreamDescriptor.getContext()s, so that that one will be taken as information to appear in the resulting AttachmentDirectory.

Method Summary

Modifier and Type	Method	Description
protected static int	countPages(com.levigo.jadice.document.io.SeekableInputStream documentStream, QualifiedLogEventReceiver logEventReceiver)
protected static int	createAttachment(StreamDescriptor sd, StreamDescriptor rootDescriptor, int nmbPages, int pageOffset, AttachmentDirectory rootDirectory)	Insert a StreamDescriptor into the given attachment directory that represents the root of the mail
static AttachmentDirectory	createAttachmentDirectory(StreamDescriptor rootDescriptor, List<Stream> streams, QualifiedLogEventReceiver controller)	Create an AttachmentDirectory that characterizes the given attachments.
protected static BundledStream	createStream(com.levigo.jadice.document.io.SeekableInputStream sis, StreamDescriptor sd)
static void	exportToXML(XMLStreamWriter xsw, AttachmentDirectory dir, int pageIndexOffset)
protected static StreamDescriptor	getAttachmentDescriptor(StreamDescriptor sd)	Find the StreamDescriptor that contains the attachment information for the given Stream (identified by the given StreamDescriptor).
protected static byte[]	toByteArray(InputStream stream)

Methods inherited from class java.lang.Object

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

Field Detail

COVER_FOR

public static final String COVER_FOR

Add another StreamDescriptor with this key in the given StreamDescriptor.getContext()s, so that that one will be taken as information to appear in the resulting AttachmentDirectory.

See Also:

Constant Field Values

Method Detail

createAttachmentDirectory

public static AttachmentDirectory createAttachmentDirectory(StreamDescriptor rootDescriptor,
                                                            List<Stream> streams,
                                                            QualifiedLogEventReceiver controller)
                                                     throws Throwable

Create an AttachmentDirectory that characterizes the given attachments.

Parameters:

rootDescriptor - the StreamDescriptor of the mail body

controller - the WorkerController associated with the current execution

streams - The pre-converted attachments as PDF. If the attachment has another MIME type, page counting will be disabled

Returns:

An AttachmentDirectory that shows how the given attachments are placed within the email that contains them

Throws:

Throwable - if the creation fails

createAttachment

protected static int createAttachment(StreamDescriptor sd,
                                      StreamDescriptor rootDescriptor,
                                      int nmbPages,
                                      int pageOffset,
                                      AttachmentDirectory rootDirectory)
                               throws Throwable

Insert a StreamDescriptor into the given attachment directory that represents the root of the mail

Parameters:

sd - The Descriptor to insert

rootDescriptor - the StreamDescriptor of the mail body

nmbPages - how many pages the PDF / TIFF associated with the descriptor has

pageOffset - the number of pages that were handled before

rootDirectory - the directory that contains all of the attachments of the mail

Returns:

the new total number of pages that are stored in the AttachmentDirectory

Throws:

Throwable - if the attachment creation fails

getAttachmentDescriptor

protected static StreamDescriptor getAttachmentDescriptor(StreamDescriptor sd)

Find the StreamDescriptor that contains the attachment information for the given Stream (identified by the given StreamDescriptor).

Parameters:

sd - StreamDescriptor to search in

Returns:

a StreamDescriptor or null

toByteArray

protected static byte[] toByteArray(InputStream stream)
                             throws IOException

Throws:

IOException

createStream

protected static BundledStream createStream(com.levigo.jadice.document.io.SeekableInputStream sis,
                                            StreamDescriptor sd)
                                     throws IOException

Throws:

IOException

countPages

protected static int countPages(com.levigo.jadice.document.io.SeekableInputStream documentStream,
                                QualifiedLogEventReceiver logEventReceiver)
                         throws IOException

Throws:

IOException

exportToXML

public static void exportToXML(XMLStreamWriter xsw,
                               AttachmentDirectory dir,
                               int pageIndexOffset)
                        throws XMLStreamException

Throws:

XMLStreamException