com.cleo.lexicom.external

Class LexiComPipedOutputStream

java.lang.Object

java.io.OutputStream

java.io.PipedOutputStream

com.cleo.lexicom.external.LexiComPipedOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class LexiComPipedOutputStream
extends java.io.PipedOutputStream

Pipe an incoming payload file out through another mailbox while still writing to the original destination; fail the transfer if the pipe fails and vice versa

Constructor Summary

Constructors

Constructor and Description
LexiComPipedOutputStream(java.io.File file, java.util.Map map, IMailboxController imc, boolean deleteOnError) Pipe an incoming payload file out through another mailbox

Method Summary

Modifier and Type	Method and Description
void	close() Closes file and mailbox controller output streams.
protected boolean	delete(java.io.File file)
void	flush() Flushes file and mailbox controller output streams.
static java.util.concurrent.ExecutorService	getExecutorService() Get the service for executing the mailbox controller pipes
protected java.io.OutputStream	getFileOutputStream(java.io.File file)
java.lang.String	getGeneralErrorMessage() Get the error message to be logged by the receiving protocol thread if the IMailboxController send fails
void	setGeneralErrorMessage(java.lang.String generalErrorMessage) Set the error message to be logged by the receiving protocol thread if the IMailboxController send fails
void	setIncludeMailboxControllerErrorMessage(boolean includeMailboxControllerErrorMessage) Set whether the IMailboxController send error message should be included in the error message logged by the receiving protocol thread
void	write(byte[] b) Writes file and mailbox controller output streams.
void	write(byte[] b, int off, int len) Writes file and mailbox controller output streams.
void	write(int b) Writes file and mailbox controller output streams.

Methods inherited from class java.io.PipedOutputStream

connect

Methods inherited from class java.lang.Object

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

Constructor Detail

LexiComPipedOutputStream

public LexiComPipedOutputStream(java.io.File file,
                                java.util.Map map,
                                IMailboxController imc,
                                boolean deleteOnError)
                         throws java.lang.Exception

Pipe an incoming payload file out through another mailbox

Parameters:

file - original destination file which should still be written

map - original destination properties

imc - IMailboxController to also pipe out the payload

deleteOnError - true if the original destination file should be deleted if the IMailboxController send fails

Throws:

java.lang.Exception

Method Detail

setGeneralErrorMessage

public void setGeneralErrorMessage(java.lang.String generalErrorMessage)

Set the error message to be logged by the receiving protocol thread if the IMailboxController send fails

Parameters:

generalErrorMessage - error message to be logged, which cannot be a null or empty string; defaults to "Error processing incoming file"

getGeneralErrorMessage

public java.lang.String getGeneralErrorMessage()

Get the error message to be logged by the receiving protocol thread if the IMailboxController send fails

Returns:

error message to be logged

setIncludeMailboxControllerErrorMessage

public void setIncludeMailboxControllerErrorMessage(boolean includeMailboxControllerErrorMessage)

Set whether the IMailboxController send error message should be included in the error message logged by the receiving protocol thread

Parameters:

includeMailboxControllerErrorMessage - true if should include mailbox controller send error message; defaults to false

close

public void close()
           throws java.io.IOException

Closes file and mailbox controller output streams. Do not call directly.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.PipedOutputStream

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Flushes file and mailbox controller output streams. Do not call directly.

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.PipedOutputStream

Throws:

java.io.IOException

write

public void write(byte[] b)
           throws java.io.IOException

Writes file and mailbox controller output streams. Do not call directly.

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Writes file and mailbox controller output streams. Do not call directly.

Overrides:

write in class java.io.PipedOutputStream

Throws:

java.io.IOException

write

public void write(int b)
           throws java.io.IOException

Writes file and mailbox controller output streams. Do not call directly.

Overrides:

write in class java.io.PipedOutputStream

Throws:

java.io.IOException

getExecutorService

public static java.util.concurrent.ExecutorService getExecutorService()

Get the service for executing the mailbox controller pipes

Returns:

the executor service

getFileOutputStream

protected java.io.OutputStream getFileOutputStream(java.io.File file)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

delete

protected boolean delete(java.io.File file)
                  throws java.lang.Exception

Throws:

java.lang.Exception