nl.nn.adapterframework.stream

Class Message

java.lang.Object

nl.nn.adapterframework.stream.Message

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FileMessage, PartMessage, PathMessage, UrlMessage

public class Message
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.logging.log4j.Logger	log
static long	MESSAGE_SIZE_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
	Message(byte[] request)
	Message(byte[] request, Map<String,Object> context)
	Message(byte[] request, String charset)
	Message(InputStream request)
	Message(InputStream request, Map<String,Object> context)
	Message(InputStream request, String charset)
	Message(Node request)
	Message(Node request, Map<String,Object> context)
	Message(Reader request)
	Message(Reader request, Map<String,Object> context)
	Message(String request)
	Message(String request, Map<String,Object> context)
protected	Message(ThrowingSupplier<InputStream,Exception> request, Map<String,Object> context, Class<?> requestClass) Constructor for Message using InputStream supplier.

Method Summary

Modifier and Type	Method and Description
byte[]	asByteArray() return the request object as a byte array.
static byte[]	asByteArray(Object object)
static byte[]	asByteArray(Object object, String defaultCharset)
byte[]	asByteArray(String defaultEncodingCharset)
InputSource	asInputSource() return the request object as a InputSource.
static InputSource	asInputSource(Object object)
InputStream	asInputStream() return the request object as a InputStream.
static InputStream	asInputStream(Object object)
static InputStream	asInputStream(Object object, String defaultCharset)
InputStream	asInputStream(String defaultEncodingCharset)
static Message	asMessage(Object object)
Object	asObject() Deprecated. Please avoid the use of the raw object.
static Object	asObject(Object object) Deprecated.
Reader	asReader() return the request object as a Reader.
static Reader	asReader(Object object)
static Reader	asReader(Object object, String defaultCharset)
Reader	asReader(String defaultDecodingCharset)
Source	asSource() return the request object as a Source.
static Source	asSource(Object object)
String	asString() return the request object as a String.
static String	asString(Object object)
static String	asString(Object object, String defaultCharset)
String	asString(String decodingCharset)
ByteArrayOutputStream	captureBinaryStream() Can be called when requiresStream() is true to retrieve a copy of (part of) the stream that is in this message, after the stream has been closed.
void	captureBinaryStream(OutputStream outputStream)
void	captureBinaryStream(OutputStream outputStream, int maxSize)
StringWriter	captureCharacterStream() Can be called when requiresStream() is true to retrieve a copy of (part of) the stream that is in this message, after the stream has been closed.
void	captureCharacterStream(Writer writer)
void	captureCharacterStream(Writer writer, int maxSize)
void	close()
void	closeOnClose(AutoCloseable resource)
void	closeOnCloseOf(PipeLineSession session, INamedObject requester)
void	closeOnCloseOf(PipeLineSession session, String requester)
protected String	computeDecodingCharset(String defaultDecodingCharset) If no charset was provided and the requested charset is auto, try to parse the charset.
MessageContext	copyContext()
String	getCharset() Representing a charset of binary requests
protected String	getId()
byte[]	getMagic() Reads the first 10k of a message.
byte[]	getMagic(int readLimit) Reads the first N bytes message, specified by parameter readLimit.
static boolean	hasDataAvailable(Message message) Check if a message has any data available.
boolean	isBinary()
boolean	isEmpty() Check if a message is empty.
static boolean	isEmpty(Message message) Check if the message passed is null or empty.
boolean	isNull()
static boolean	isNull(Message message)
boolean	isRepeatable()
boolean	isScheduledForCloseOnExitOf(PipeLineSession session)
static Message	nullMessage()
static Message	nullMessage(MessageContext context)
void	preserve() Notify the message object that the request object will be used multiple times.
boolean	requiresStream() If true, the Message should preferably be read using a streaming method, i.e.
long	size() Note that the size may not be an exact measure of the content size and may or may not account for any encoding of the content.
String	toString() toString can be used to inspect the message.
String	toStringPrefix()
void	toStringPrefix(Writer writer)
void	unscheduleFromCloseOnExitOf(PipeLineSession session)

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_SIZE_UNKNOWN

public static final long MESSAGE_SIZE_UNKNOWN

See Also:

Constant Field Values

log

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

Constructor Detail

Message

public Message(String request,
               Map<String,Object> context)

Message

public Message(String request)

Message

public Message(byte[] request,
               String charset)

Message

public Message(byte[] request,
               Map<String,Object> context)

Message

public Message(byte[] request)

Message

public Message(Reader request,
               Map<String,Object> context)

Message

public Message(Reader request)

Message

protected Message(ThrowingSupplier<InputStream,Exception> request,
                  Map<String,Object> context,
                  Class<?> requestClass)

Constructor for Message using InputStream supplier. It is assumed the InputStream can be supplied multiple times.

Message

public Message(InputStream request,
               String charset)

Message

public Message(InputStream request,
               Map<String,Object> context)

Message

public Message(InputStream request)

Message

public Message(Node request,
               Map<String,Object> context)

Message

public Message(Node request)

Method Detail

nullMessage

public static Message nullMessage()

nullMessage

public static Message nullMessage(MessageContext context)

copyContext

public MessageContext copyContext()

getCharset

public String getCharset()

Representing a charset of binary requests

Returns:

the charset provided when the message was created

computeDecodingCharset

protected String computeDecodingCharset(String defaultDecodingCharset)
                                 throws IOException

If no charset was provided and the requested charset is auto, try to parse the charset. If unsuccessful return the default; UTF-8.

Throws:

IOException

preserve

public void preserve()
              throws IOException

Notify the message object that the request object will be used multiple times. If the request object can only be read one time, it can turn it into a less volatile representation. For instance, it could replace an InputStream with a byte array or String.

Throws:

IOException

asObject

@Deprecated
public Object asObject()

Deprecated. Please avoid the use of the raw object.

isBinary

public boolean isBinary()

isRepeatable

public boolean isRepeatable()

requiresStream

public boolean requiresStream()

If true, the Message should preferably be read using a streaming method, i.e. asReader() or asInputStream(), to avoid copying it into memory.

close

public void close()
           throws Exception

Throws:

Exception

closeOnClose

public void closeOnClose(AutoCloseable resource)

closeOnCloseOf

public void closeOnCloseOf(PipeLineSession session,
                           INamedObject requester)

closeOnCloseOf

public void closeOnCloseOf(PipeLineSession session,
                           String requester)

isScheduledForCloseOnExitOf

public boolean isScheduledForCloseOnExitOf(PipeLineSession session)

unscheduleFromCloseOnExitOf

public void unscheduleFromCloseOnExitOf(PipeLineSession session)

asReader

public Reader asReader()
                throws IOException

return the request object as a Reader. Should not be called more than once, if request is not preserved.

Throws:

IOException

asReader

public Reader asReader(String defaultDecodingCharset)
                throws IOException

Throws:

IOException

asInputStream

public InputStream asInputStream()
                          throws IOException

return the request object as a InputStream. Should not be called more than once, if request is not preserved.

Throws:

IOException

asInputStream

public InputStream asInputStream(String defaultEncodingCharset)
                          throws IOException

Parameters:

defaultEncodingCharset - is only used when the Message object is of character type (String)

Throws:

IOException

getMagic

@Nonnull
public byte[] getMagic()
                         throws IOException

Reads the first 10k of a message. If the message does not support markSupported it is wrapped in a buffer.

Throws:

IOException

getMagic

@Nonnull
public byte[] getMagic(int readLimit)
                         throws IOException

Reads the first N bytes message, specified by parameter readLimit. If the message does not support markSupported it is wrapped in a buffer.

Parameters:

readLimit - amount of bytes to read.

Throws:

IOException

asInputSource

public InputSource asInputSource()
                          throws IOException

return the request object as a InputSource. Should not be called more than once, if request is not preserved.

Throws:

IOException

asSource

public Source asSource()
                throws IOException,
                       SAXException

return the request object as a Source. Should not be called more than once, if request is not preserved.

Throws:

IOException

SAXException

asByteArray

public byte[] asByteArray()
                   throws IOException

return the request object as a byte array. Has the side effect of preserving the input as byte array.

Throws:

IOException

asByteArray

public byte[] asByteArray(String defaultEncodingCharset)
                   throws IOException

Throws:

IOException

asString

public String asString()
                throws IOException

return the request object as a String. Has the side effect of preserving the input as a String.

Throws:

IOException

asString

public String asString(String decodingCharset)
                throws IOException

Throws:

IOException

isNull

public boolean isNull()

isEmpty

public boolean isEmpty()

Check if a message is empty. If message size cannot be determined, return false to be on the safe side although this might not be strictly correct.

Returns:

true if the message is empty, if message is not empty or if the size cannot be determined up-front.

toStringPrefix

public void toStringPrefix(Writer writer)
                    throws IOException

Throws:

IOException

toStringPrefix

public String toStringPrefix()

toString

public String toString()

toString can be used to inspect the message. It does not convert the 'request' to a string.

Overrides:

toString in class Object

getId

protected String getId()

asMessage

public static Message asMessage(Object object)

asObject

@Deprecated
public static Object asObject(Object object)

Deprecated.

asReader

public static Reader asReader(Object object)
                       throws IOException

Throws:

IOException

asReader

public static Reader asReader(Object object,
                              String defaultCharset)
                       throws IOException

Throws:

IOException

asInputStream

public static InputStream asInputStream(Object object)
                                 throws IOException

Throws:

IOException

asInputStream

public static InputStream asInputStream(Object object,
                                        String defaultCharset)
                                 throws IOException

Throws:

IOException

asInputSource

public static InputSource asInputSource(Object object)
                                 throws IOException

Throws:

IOException

asSource

public static Source asSource(Object object)
                       throws IOException,
                              SAXException

Throws:

IOException

SAXException

asString

public static String asString(Object object)
                       throws IOException

Throws:

IOException

asString

public static String asString(Object object,
                              String defaultCharset)
                       throws IOException

Throws:

IOException

asByteArray

public static byte[] asByteArray(Object object)
                          throws IOException

Throws:

IOException

asByteArray

public static byte[] asByteArray(Object object,
                                 String defaultCharset)
                          throws IOException

Throws:

IOException

isEmpty

public static boolean isEmpty(Message message)

Check if the message passed is null or empty.

Parameters:

message - Message to check. Can be null.

Returns:

Returns true if the message is null, otherwise the result of isEmpty().

hasDataAvailable

public static boolean hasDataAvailable(Message message)
                                throws IOException

Check if a message has any data available. This will correctly return true or false even when the message size cannot be determined.

However, to do so, some I/O may have to be performed on the message thus making this a potentially expensive operation which may throw an IOException.

All I/O is done in such a way that no message data is lost (see also getMagic(int)).

Parameters:

message - Message to check. May be null.

Returns:

Returns false if the message is null or of size() returns 0. Returns true if size() returns a positive value. If size() returns MESSAGE_SIZE_UNKNOWN then checks if any data can be read via getMagic(int).

Throws:

IOException - Throws an IOException if checking for data in the message throws an IOException.

isNull

public static boolean isNull(Message message)

size

public long size()

Note that the size may not be an exact measure of the content size and may or may not account for any encoding of the content. The size is appropriate for display in a user interface to give the user a rough idea of the size of this part.

Returns:

Message size or -1 if it can't determine the size.

captureBinaryStream

public ByteArrayOutputStream captureBinaryStream()
                                          throws IOException

Can be called when requiresStream() is true to retrieve a copy of (part of) the stream that is in this message, after the stream has been closed. Primarily for debugging purposes.

Throws:

IOException

captureBinaryStream

public void captureBinaryStream(OutputStream outputStream)
                         throws IOException

Throws:

IOException

captureBinaryStream

public void captureBinaryStream(OutputStream outputStream,
                                int maxSize)
                         throws IOException

Throws:

IOException

captureCharacterStream

public StringWriter captureCharacterStream()
                                    throws IOException

Can be called when requiresStream() is true to retrieve a copy of (part of) the stream that is in this message, after the stream has been closed. Primarily for debugging purposes.

When isBinary() is true the Message's charset is used when present to create a Reader that reads the InputStream. When charset not present StreamUtil.DEFAULT_INPUT_STREAM_ENCODING is used.

Throws:

IOException

captureCharacterStream

public void captureCharacterStream(Writer writer)
                            throws IOException

Throws:

IOException

captureCharacterStream

public void captureCharacterStream(Writer writer,
                                   int maxSize)
                            throws IOException

Throws:

IOException