FourMS
Class FourMSMessage

java.lang.Object
  FourMS.FourMSMessage

public class FourMSMessage
extends java.lang.Object

This a container class which is used for passing the details of message coming back from the 4MS or 4MS simulation. It has no methods, it only contains data.

Version:

$Id: FourMSMessage.java,v 1.6 2006/04/07 08:05:39 cb Exp $

Author:

Craige Bevil

Field Summary

java.lang.String	DestinationName This is the intended destination of the message stripped from the 4MS message.
java.lang.String[]	FourMSInstructions These are the embedded 4MS type messages which can be found in the message.
(package private) java.util.regex.Pattern	FourMSMessageACKMatchRE This will be used for matching ACKs and broadcast messages which are messages were there is no message body
(package private) java.util.regex.Pattern	FourMSMessageMatchRE This a precompiled regular expression which will be used to find the first 4MS message which adheres to ER412 protocol contained in a string in the input buffer.
ER412MessageComponent[]	MessageComponents This holds the details of the ER412 sub-messages which are associated with a particular incoming message
int	MessageSequenceNumber This is the message sequence number which was returned by the 4MS.
int	MessageType This is the type of the message.
boolean	ReplyWellFormatted Whether or not the reply which was sent to the object was well formed or not.
java.lang.String	SourceName This is the origin of the message, the 4MS which originated from

Constructor Summary

FourMSMessage()

FourMSMessage(java.lang.String ER412MessageString)
This sets up the components in the class according to the incoming message string which describes a message which should be in the ER412 format

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DestinationName

public java.lang.String DestinationName

This is the intended destination of the message stripped from the 4MS message.

MessageSequenceNumber

public int MessageSequenceNumber

This is the message sequence number which was returned by the 4MS. This number increments each time that the 4MS sends a message

MessageType

public int MessageType

This is the type of the message. This can be one of the following;

• ACK
• NACK
• STATUS
• MONITOR

ReplyWellFormatted

public boolean ReplyWellFormatted

Whether or not the reply which was sent to the object was well formed or not. This may be the case if a badly formed message is sent to the 4MS or is garbled on transmission.

SourceName

public java.lang.String SourceName

This is the origin of the message, the 4MS which originated from

FourMSInstructions

public java.lang.String[] FourMSInstructions

These are the embedded 4MS type messages which can be found in the message. It is possible that more than once message can be embedded in a single transation between a client and a server For example, there may be something along the following lines used SYN PFIP SYS.PFIP 12 FF AFS101(121) AFS200() AFS201() EOT

MessageComponents

public ER412MessageComponent[] MessageComponents

This holds the details of the ER412 sub-messages which are associated with a particular incoming message

FourMSMessageMatchRE

final java.util.regex.Pattern FourMSMessageMatchRE

This a precompiled regular expression which will be used to find the first 4MS message which adheres to ER412 protocol contained in a string in the input buffer.

FourMSMessageACKMatchRE

final java.util.regex.Pattern FourMSMessageACKMatchRE

This will be used for matching ACKs and broadcast messages which are messages were there is no message body

Constructor Detail

FourMSMessage

public FourMSMessage(java.lang.String ER412MessageString)
              throws Malformed4MSMessageException

This sets up the components in the class according to the incoming message string which describes a message which should be in the ER412 format

Parameters:

ER412MessageString -

Throws:

Malformed4MSMessageException

FourMSMessage

public FourMSMessage()