org.xmlBlaster.util
Class MsgUnitRaw

java.lang.Object
  org.xmlBlaster.util.MsgUnitRaw

public final class MsgUnitRaw

extends java.lang.Object

Encapsulates the xmlKey, content and qos.

Keep this class slim, it is serialized and passed with RMI

The constructor arguments are checked to be not null and corrected to "" or 'new byte[0]' if they are null

Field Summary

static java.lang.String	CONTENT_TAG
static java.lang.String	KEY_TAG
static java.lang.String	QOS_TAG

Constructor Summary

MsgUnitRaw(java.lang.Object msgUnit, java.lang.String key, byte[] content, java.lang.String qos)

MsgUnitRaw(java.lang.String key, byte[] content, java.lang.String qos)

MsgUnitRaw(java.lang.String key, EncodableData encodedContent, java.lang.String qos)

Method Summary

static void	dumpContent(java.lang.String extraOffset, java.io.OutputStream out, byte[] content, boolean forceReadable)
byte[]	getContent() Get the raw content, never null
java.lang.String	getContentStr() Get the raw content, never null
java.lang.String	getKey() The raw XML string, never null
java.lang.Object	getMsgUnit() You can decide to pass with the constructor a parsed MsgUnit
java.lang.String	getQos() The raw QoS XML string, never null
long	size() The number of bytes of qos+key+content
java.lang.String	toXml()
java.lang.String	toXml(java.lang.String extraOffset)
void	toXml(java.lang.String extraOffset, java.io.OutputStream out, java.util.Properties props) Standard message dump.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_TAG

public static final java.lang.String KEY_TAG

See Also:

Constant Field Values

CONTENT_TAG

public static final java.lang.String CONTENT_TAG

See Also:

Constant Field Values

QOS_TAG

public static final java.lang.String QOS_TAG

See Also:

Constant Field Values

Constructor Detail

MsgUnitRaw

public MsgUnitRaw(java.lang.Object msgUnit,
                  java.lang.String key,
                  byte[] content,
                  java.lang.String qos)

Parameters:

msgUnit - Temporary object with parsed information, this is not evaluated internally

key -

content -

qos -

MsgUnitRaw

public MsgUnitRaw(java.lang.String key,
                  byte[] content,
                  java.lang.String qos)

MsgUnitRaw

public MsgUnitRaw(java.lang.String key,
                  EncodableData encodedContent,
                  java.lang.String qos)

Method Detail

getKey

public java.lang.String getKey()

The raw XML string, never null

getContent

public byte[] getContent()

Get the raw content, never null

getContentStr

public java.lang.String getContentStr()

Get the raw content, never null

getQos

public java.lang.String getQos()

The raw QoS XML string, never null

size

public long size()

The number of bytes of qos+key+content

getMsgUnit

public java.lang.Object getMsgUnit()

You can decide to pass with the constructor a parsed MsgUnit

Returns:

MsgUnit with holds the parsed information, please treat as immutable, or null

toXml

public java.lang.String toXml()

toXml

public java.lang.String toXml(java.lang.String extraOffset)

Parameters:

extraOffset -

Returns:

toXml

public void toXml(java.lang.String extraOffset,
                  java.io.OutputStream out,
                  java.util.Properties props)
           throws java.io.IOException

Standard message dump. Used for logging and XmlScripting

Parameters:

extraOffset -

out -

Throws:

java.io.IOException

dumpContent

public static void dumpContent(java.lang.String extraOffset,
                               java.io.OutputStream out,
                               byte[] content,
                               boolean forceReadable)
                        throws java.io.IOException

Throws:

java.io.IOException