Package org.frankframework.stream

Class MessageOutputStream

java.lang.Object

org.frankframework.stream.MessageOutputStream

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

MessageOutputStreamCap

public class MessageOutputStream
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.apache.logging.log4j.Logger	log
protected Object	requestStream

Constructor Summary

Constructors

Modifier	Constructor	Description
	MessageOutputStream(INamedObject owner, OutputStream stream, IForwardTarget next)
	MessageOutputStream(INamedObject owner, OutputStream stream, IForwardTarget next, String conversionCharset)
	MessageOutputStream(INamedObject owner, OutputStream stream, MessageOutputStream nextStream)
	MessageOutputStream(INamedObject owner, OutputStream stream, MessageOutputStream nextStream, String conversionCharset)
	MessageOutputStream(INamedObject owner, Writer writer, IForwardTarget next)
	MessageOutputStream(INamedObject owner, Writer writer, IForwardTarget next, String conversionCharset)
	MessageOutputStream(INamedObject owner, Writer writer, MessageOutputStream nextStream)
	MessageOutputStream(INamedObject owner, Writer writer, MessageOutputStream nextStream, String conversionCharset)
protected	MessageOutputStream(INamedObject owner, IForwardTarget next, String conversionCharset)
	MessageOutputStream(INamedObject owner, JsonEventHandler handler, MessageOutputStream nextStream, ThreadLifeCycleEventListener<T> threadLifeCycleEventListener, IThreadConnectableTransactionManager txManager, PipeLineSession session, ThreadConnector<?> targetThreadConnector)
protected	MessageOutputStream(INamedObject owner, MessageOutputStream nextStream, String conversionCharset)
	MessageOutputStream(INamedObject owner, ContentHandler handler, MessageOutputStream nextStream, ThreadLifeCycleEventListener<T> threadLifeCycleEventListener, IThreadConnectableTransactionManager txManager, PipeLineSession session, ThreadConnector<?> targetThreadConnector)

Method Summary

Modifier and Type	Method	Description
void	afterClose()	can be overridden in descender classes to release resources, after the chain has been closed.
ContentHandler	asContentHandler()
JsonEventHandler	asJsonEventHandler()
Object	asNative()
OutputStream	asStream()
OutputStream	asStream(String charset)
Writer	asWriter()
ByteArrayOutputStream	captureBinaryStream()
void	captureBinaryStream(OutputStream outputStream)
void	captureBinaryStream(OutputStream outputStream, int maxSize)
StringWriter	captureCharacterStream()
void	captureCharacterStream(Writer writer)
void	captureCharacterStream(Writer writer, int maxSize)
final void	close()
void	closeOnClose(AutoCloseable resource)
void	closeRequestStream()
PipeForward	getForward()
PipeRunResult	getPipeRunResult()
Message	getResponse()
static MessageOutputStream	getTargetStream(INamedObject owner, PipeLineSession session, IForwardTarget next)	Provides a non-null MessageOutputStream, that the caller can use to obtain a Writer, OutputStream or ContentHandler.
boolean	isBinary()
void	setForward(PipeForward forward)
protected void	setRequestStream(Object requestStream)
void	setResponse(Message response)	Response message, e.g.

Methods inherited from class java.lang.Object

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

Field Details

log

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

requestStream

protected Object requestStream

Constructor Details

MessageOutputStream

protected MessageOutputStream(INamedObject owner,
 IForwardTarget next,
 String conversionCharset)

MessageOutputStream

protected MessageOutputStream(INamedObject owner,
 MessageOutputStream nextStream,
 String conversionCharset)

MessageOutputStream

public MessageOutputStream(INamedObject owner,
 OutputStream stream,
 IForwardTarget next)

MessageOutputStream

public MessageOutputStream(INamedObject owner,
 OutputStream stream,
 MessageOutputStream nextStream)

MessageOutputStream

public MessageOutputStream(INamedObject owner,
 OutputStream stream,
 IForwardTarget next,
 String conversionCharset)

MessageOutputStream

public MessageOutputStream(INamedObject owner,
 OutputStream stream,
 MessageOutputStream nextStream,
 String conversionCharset)

MessageOutputStream

public MessageOutputStream(INamedObject owner,
 Writer writer,
 IForwardTarget next)

MessageOutputStream

public MessageOutputStream(INamedObject owner,
 Writer writer,
 MessageOutputStream nextStream)

MessageOutputStream

public MessageOutputStream(INamedObject owner,
 Writer writer,
 IForwardTarget next,
 String conversionCharset)

MessageOutputStream

public MessageOutputStream(INamedObject owner,
 Writer writer,
 MessageOutputStream nextStream,
 String conversionCharset)

MessageOutputStream

public MessageOutputStream(INamedObject owner,
 ContentHandler handler,
 MessageOutputStream nextStream,
 ThreadLifeCycleEventListener<T> threadLifeCycleEventListener,
 IThreadConnectableTransactionManager txManager,
 PipeLineSession session,
 ThreadConnector<?> targetThreadConnector)

MessageOutputStream

public MessageOutputStream(INamedObject owner,
 JsonEventHandler handler,
 MessageOutputStream nextStream,
 ThreadLifeCycleEventListener<T> threadLifeCycleEventListener,
 IThreadConnectableTransactionManager txManager,
 PipeLineSession session,
 ThreadConnector<?> targetThreadConnector)

Method Details

setRequestStream

protected void setRequestStream(Object requestStream)

closeRequestStream

public void closeRequestStream()
                        throws IOException

Throws:

IOException

afterClose

public void afterClose()
                throws SQLException

can be overridden in descender classes to release resources, after the chain has been closed.

Throws:

SQLException

closeOnClose

public void closeOnClose(AutoCloseable resource)

close

public final void close()
                 throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

isBinary

public boolean isBinary()

asNative

public Object asNative()

asStream

public OutputStream asStream()
                      throws StreamingException

Throws:

StreamingException

asStream

public OutputStream asStream(String charset)
                      throws StreamingException

Throws:

StreamingException

asWriter

public Writer asWriter()
                throws StreamingException

Throws:

StreamingException

asContentHandler

public ContentHandler asContentHandler()
                                throws StreamingException

Throws:

StreamingException

asJsonEventHandler

public JsonEventHandler asJsonEventHandler()

captureCharacterStream

public StringWriter captureCharacterStream()

captureCharacterStream

public void captureCharacterStream(Writer writer)

captureCharacterStream

public void captureCharacterStream(Writer writer,
 int maxSize)

captureBinaryStream

public ByteArrayOutputStream captureBinaryStream()

captureBinaryStream

public void captureBinaryStream(OutputStream outputStream)

captureBinaryStream

public void captureBinaryStream(OutputStream outputStream,
 int maxSize)

setResponse

public void setResponse(Message response)

Response message, e.g. the filename, of the {IOutputStreamTarget target} after processing the stream. It is the responsibility of the target to set this message.

getResponse

public Message getResponse()

setForward

public void setForward(PipeForward forward)

getPipeRunResult

public PipeRunResult getPipeRunResult()

getForward

public PipeForward getForward()

getTargetStream

public static MessageOutputStream getTargetStream(INamedObject owner,
 PipeLineSession session,
 IForwardTarget next)
                                           throws StreamingException

Provides a non-null MessageOutputStream, that the caller can use to obtain a Writer, OutputStream or ContentHandler.

Throws:

StreamingException