org.openlowcode.tools.messages

Class MessageWriter

java.lang.Object

org.openlowcode.tools.messages.MessageWriter

Direct Known Subclasses:

MessageBufferedWriter

public abstract class MessageWriter
extends java.lang.Object

An OLc message writer writes to the communication stream a OLc Message. This message should be sent to the communication stream without significant local storage, as a OLc Message may be bigger than the available memory in the JVM.

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
boolean	active
java.util.ArrayList<java.lang.String>	currentpath

Constructor Summary

Constructors

Constructor and Description
MessageWriter()

Method Summary

Modifier and Type	Method and Description
void	addBooleanField(java.lang.String fieldname, boolean fieldcontent)
void	addDateField(java.lang.String fieldname, java.util.Date fieldcontent)
void	addDecimalField(java.lang.String fieldname, java.math.BigDecimal fieldcontent)
void	addIntegerField(java.lang.String fieldname, int fieldcontent)
void	addLongBinaryField(java.lang.String fieldname, SFile binaryfile)
void	addStringField(java.lang.String fieldname, java.lang.String fieldcontent)
abstract void	checkConnection()
static void	checkLabelCorrect(java.lang.String label, java.lang.String context) This method checks that a label (field name or structure name) is compliant to the rules of a OLc messages.
protected java.lang.String	currentpath()
void	endMessage()
void	endStructure(java.lang.String structurename)
abstract void	flushMessage()
java.lang.String	getCurrentPadding()
boolean	isActive()
boolean	isIsfirstelementinstructure()
abstract void	sendMessageElement(MessageElement messageelement)
void	sendMessageError(int errorcode, java.lang.String errormessage)
void	startNewMessage() method to be implemented by a MessageWriter: ensures that a communication is open, reopen it if required, and start sending a message
void	startStructure(java.lang.String structurename)

Methods inherited from class java.lang.Object

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

Field Detail

currentpath

public java.util.ArrayList<java.lang.String> currentpath

active

public boolean active

Constructor Detail

MessageWriter

public MessageWriter()

Method Detail

isIsfirstelementinstructure

public boolean isIsfirstelementinstructure()

getCurrentPadding

public java.lang.String getCurrentPadding()

checkConnection

public abstract void checkConnection()
                              throws java.io.IOException

Throws:

java.io.IOException - if the connection has an issue

sendMessageElement

public abstract void sendMessageElement(MessageElement messageelement)
                                 throws java.io.IOException

Parameters:

messageelement - Element to be sent

Throws:

java.io.IOException - if any exception is received while sending the element.

flushMessage

public abstract void flushMessage()
                           throws java.io.IOException

Throws:

java.io.IOException

checkLabelCorrect

public static void checkLabelCorrect(java.lang.String label,
                                     java.lang.String context)

This method checks that a label (field name or structure name) is compliant to the rules of a OLc messages. If compliant, the method execute correctly. If an error is encountered, then an exception is thrown detailing the index of error, the character, and the list of authorized characters.

Parameters:

label - the label to check

startNewMessage

public void startNewMessage()
                     throws java.io.IOException

method to be implemented by a MessageWriter: ensures that a communication is open, reopen it if required, and start sending a message

Throws:

java.io.IOException - if any problem happens with the communication

startStructure

public void startStructure(java.lang.String structurename)
                    throws java.io.IOException

Parameters:

structurename - has to be a valid name (first character an upper case latine letter (A...Z), other characters either an upper-case latine letter (A...Z), a figure (0...9), a minus '-' or an underscore '_'

Throws:

java.io.IOException - if any problem happens with the communication

addStringField

public void addStringField(java.lang.String fieldname,
                           java.lang.String fieldcontent)
                    throws java.io.IOException

Parameters:

fieldname - has to be a valid name (first character an upper case latine letter (A...Z), other characters either an upper-case latine letter (A...Z), a figure (0...9), a minus '-' or an underscore '_'

fieldcontent - payload (potentially null string)

Throws:

java.io.IOException - if any problem happens with the communication

addDateField

public void addDateField(java.lang.String fieldname,
                         java.util.Date fieldcontent)
                  throws java.io.IOException

Parameters:

fieldname - has to be a valid name (first character an upper case latine letter (A...Z), other characters either an upper-case latine letter (A...Z), a figure (0...9), a minus '-' or an underscore '_'

fieldcontent - payload (potentially null date)

Throws:

java.io.IOException - if any problem happens with the communication

addBooleanField

public void addBooleanField(java.lang.String fieldname,
                            boolean fieldcontent)
                     throws java.io.IOException

Parameters:

fieldname - has to be a valid name (first character an upper case latine letter (A...Z), other characters either an upper-case latine letter (A...Z), a figure (0...9), a minus '-' or an underscore '_'

fieldcontent - payload (boolean true or false)

Throws:

java.io.IOException - if any problem happens with the communication

addIntegerField

public void addIntegerField(java.lang.String fieldname,
                            int fieldcontent)
                     throws java.io.IOException

Parameters:

fieldname - has to be a valid name (first character an upper case latine letter (A...Z), other characters either an upper-case latine letter (A...Z), a figure (0...9), a minus '-' or an underscore '_'

fieldcontent - payload (non null integer)

Throws:

java.io.IOException - if any problem happens with the communication

addDecimalField

public void addDecimalField(java.lang.String fieldname,
                            java.math.BigDecimal fieldcontent)
                     throws java.io.IOException

Parameters:

fieldname - has to be a valid name (first character an upper case latine letter (A...Z), other characters either an upper-case latine letter (A...Z), a figure (0...9), a minus '-' or an underscore '_'

fieldcontent - payload (potentially null BigDecimal)

Throws:

java.io.IOException - if any problem happens with the communication

addLongBinaryField

public void addLongBinaryField(java.lang.String fieldname,
                               SFile binaryfile)
                        throws java.io.IOException

Parameters:

fieldname - has to be a valid name (first character an upper case latine letter (A...Z), other characters either an upper-case latine letter (A...Z), a figure (0...9), a minus '-' or an underscore '_'

binaryfile - payload (potentially null SFile)

Throws:

java.io.IOException - if any problem happens with the communication

endStructure

public void endStructure(java.lang.String structurename)
                  throws java.io.IOException

Parameters:

structurename - has to be a valid name (first character an upper case latine letter (A...Z), other characters either an upper-case latine letter (A...Z), a figure (0...9), a minus '-' or an underscore '_'

Throws:

java.io.IOException - if any problem happens with the communication

endMessage

public void endMessage()
                throws java.io.IOException

Throws:

java.io.IOException - if any problem happens with the communication

sendMessageError

public void sendMessageError(int errorcode,
                             java.lang.String errormessage)
                      throws java.io.IOException

Parameters:

errorcode - code of the error (0 to signal error code is not used / not significant)

errormessage - human readable message

Throws:

java.io.IOException - if any problem happens with the communication

currentpath

protected java.lang.String currentpath()

Returns:

isActive

public boolean isActive()