org.openlowcode.tools.messages

Class MessageBinaryField

java.lang.Object

org.openlowcode.tools.messages.MessageElement

org.openlowcode.tools.messages.MessageField<MessageFieldTypeBinary>

org.openlowcode.tools.messages.MessageBinaryField

public class MessageBinaryField
extends MessageField<MessageFieldTypeBinary>

a binary element contains a payload that will be transported from client to server It is transported as pure binary content after a 'D' and then an integer precising the size of the binary content in bytes and then a ':' and then the binary content. e.g B1000:[BinaryContent length = 1000 encoded in base64].When empty, just sent B0:;

Author:

Open Lowcode SAS

Field Summary

Fields inherited from class org.openlowcode.tools.messages.MessageField

CONTENT_SEPARATOR, FIELD_SEPARATOR, STRUCTURE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
MessageBinaryField(java.lang.String fieldname)
MessageBinaryField(java.lang.String attributename, byte[] binary, java.lang.String filename)
MessageBinaryField(java.lang.String fieldname, SFile payloadfile)

Method Summary

Modifier and Type	Method and Description
SFile	getFieldContent()
java.lang.String	serializepayload(java.lang.String contextstring)

Methods inherited from class org.openlowcode.tools.messages.MessageField

getFieldName, serialize

Methods inherited from class org.openlowcode.tools.messages.MessageElement

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageBinaryField

public MessageBinaryField(java.lang.String fieldname)

MessageBinaryField

public MessageBinaryField(java.lang.String fieldname,
                          SFile payloadfile)

Parameters:

fieldname - name of the field. It is recommended to check the field name when parsing the message to ensure no misunderstanding

payloadfile - the file payload

MessageBinaryField

public MessageBinaryField(java.lang.String attributename,
                          byte[] binary,
                          java.lang.String filename)

Method Detail

serializepayload

public java.lang.String serializepayload(java.lang.String contextstring)

Specified by:

serializepayload in class MessageField<MessageFieldTypeBinary>

Parameters:

contextstring - a string that will be included in the exception in case of error

Returns:

a value in string, potentially multi-line, of the field payload

getFieldContent

public SFile getFieldContent()