org.netxms.base

Class NXCPMessage

java.lang.Object

org.netxms.base.NXCPMessage

public class NXCPMessage
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENCRYPTION_HEADER_SIZE
static int	HEADER_SIZE
static int	MF_BINARY
static int	MF_CONTROL
static int	MF_DONT_ENCRYPT
static int	MF_END_OF_FILE
static int	MF_END_OF_SEQUENCE
static int	MF_REVERSE_ORDER

Constructor Summary

Constructors

Constructor and Description
NXCPMessage(byte[] nxcpMessage, EncryptionContext ectx) Create NXCPMessage from binary NXCP message
NXCPMessage(int msgCode)
NXCPMessage(int msgCode, long msgId)

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	createNXCPMessage() Create binary NXCP message
NXCPVariable	findVariable(long varId)
byte[]	getBinaryData() Get data of raw message.
long	getControlData()
int	getMessageCode()
long	getMessageId()
long	getTimestamp()
byte[]	getVariableAsBinary(long varId)
boolean	getVariableAsBoolean(long varId)
java.util.Date	getVariableAsDate(long varId)
java.net.InetAddress	getVariableAsInetAddress(long varId)
long	getVariableAsInt64(long varId)
int	getVariableAsInteger(long varId)
java.lang.Double	getVariableAsReal(long varId)
java.lang.String	getVariableAsString(long varId)
long[]	getVariableAsUInt32Array(long varId)
java.lang.Long[]	getVariableAsUInt32ArrayEx(long varId)
java.util.UUID	getVariableAsUUID(long varId)
boolean	isBinaryMessage() Return true if message is a raw message
boolean	isControlMessage() Return true if message is a control message
boolean	isEncryptionDisabled() Return true if message has "don't encrypt" flag set
boolean	isEndOfFile() Return true if message has "end of file" flag set
boolean	isEndOfSequence() Return true if message has "end of sequence" flag set
void	setBinaryData(byte[] binaryData) Set data for raw message.
void	setBinaryMessage(boolean isRaw) Set or clear raw (binary) message flag
void	setControl(boolean isControl) Set or clear control message flag
void	setControlData(long controlData)
void	setEncryptionDisabled(boolean disabled) Set "don't encrypt" message flag
void	setEndOfFile(boolean isEOF) Set end of file message flag
void	setEndOfSequence(boolean isEOS) Set end of sequence message flag
void	setMessageCode(int msgCode)
void	setMessageId(long msgId)
void	setTimestamp(long timestamp)
void	setVariable(long varId, byte[] value)
void	setVariable(long varId, java.lang.Double value)
void	setVariable(long varId, java.net.InetAddress value)
void	setVariable(long varId, long[] value)
void	setVariable(long varId, java.lang.Long[] value)
void	setVariable(long varId, java.lang.String value)
void	setVariable(long varId, java.util.UUID value)
void	setVariable(NXCPVariable variable)
void	setVariableInt16(long varId, int value)
void	setVariableInt32(long varId, int value)
void	setVariableInt64(long varId, long value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_SIZE

public static final int HEADER_SIZE

See Also:

Constant Field Values

ENCRYPTION_HEADER_SIZE

public static final int ENCRYPTION_HEADER_SIZE

See Also:

Constant Field Values

MF_BINARY

public static final int MF_BINARY

See Also:

Constant Field Values

MF_END_OF_FILE

public static final int MF_END_OF_FILE

See Also:

Constant Field Values

MF_DONT_ENCRYPT

public static final int MF_DONT_ENCRYPT

See Also:

Constant Field Values

MF_END_OF_SEQUENCE

public static final int MF_END_OF_SEQUENCE

See Also:

Constant Field Values

MF_REVERSE_ORDER

public static final int MF_REVERSE_ORDER

See Also:

Constant Field Values

MF_CONTROL

public static final int MF_CONTROL

See Also:

Constant Field Values

Constructor Detail

NXCPMessage

public NXCPMessage(int msgCode)

Parameters:

msgCode -

NXCPMessage

public NXCPMessage(int msgCode,
           long msgId)

Parameters:

msgCode -

msgId -

NXCPMessage

public NXCPMessage(byte[] nxcpMessage,
           EncryptionContext ectx)
            throws java.io.IOException,
                   NXCPException

Create NXCPMessage from binary NXCP message

Parameters:

nxcpMessage - binary NXCP message

Throws:

java.io.IOException

java.security.GeneralSecurityException

NXCPException

Method Detail

getMessageCode

public int getMessageCode()

Returns:

the msgCode

setMessageCode

public void setMessageCode(int msgCode)

Parameters:

msgCode - the msgCode to set

getMessageId

public long getMessageId()

Returns:

the msgId

setMessageId

public void setMessageId(long msgId)

Parameters:

msgId - the msgId to set

getTimestamp

public long getTimestamp()

Returns:

the timestamp

setTimestamp

public void setTimestamp(long timestamp)

Parameters:

timestamp - the timestamp to set

findVariable

public NXCPVariable findVariable(long varId)

Parameters:

varId - variable Id to find

setVariable

public void setVariable(NXCPVariable variable)

setVariable

public void setVariable(long varId,
               byte[] value)

setVariable

public void setVariable(long varId,
               long[] value)

setVariable

public void setVariable(long varId,
               java.lang.Long[] value)

setVariable

public void setVariable(long varId,
               java.lang.String value)

setVariable

public void setVariable(long varId,
               java.lang.Double value)

setVariable

public void setVariable(long varId,
               java.net.InetAddress value)

setVariable

public void setVariable(long varId,
               java.util.UUID value)

setVariableInt64

public void setVariableInt64(long varId,
                    long value)

setVariableInt32

public void setVariableInt32(long varId,
                    int value)

setVariableInt16

public void setVariableInt16(long varId,
                    int value)

getVariableAsBinary

public byte[] getVariableAsBinary(long varId)

getVariableAsString

public java.lang.String getVariableAsString(long varId)

getVariableAsReal

public java.lang.Double getVariableAsReal(long varId)

getVariableAsInteger

public int getVariableAsInteger(long varId)

getVariableAsInt64

public long getVariableAsInt64(long varId)

getVariableAsInetAddress

public java.net.InetAddress getVariableAsInetAddress(long varId)

getVariableAsUUID

public java.util.UUID getVariableAsUUID(long varId)

getVariableAsUInt32Array

public long[] getVariableAsUInt32Array(long varId)

getVariableAsUInt32ArrayEx

public java.lang.Long[] getVariableAsUInt32ArrayEx(long varId)

getVariableAsBoolean

public boolean getVariableAsBoolean(long varId)

getVariableAsDate

public java.util.Date getVariableAsDate(long varId)

createNXCPMessage

public byte[] createNXCPMessage()
                         throws java.io.IOException

Create binary NXCP message

Returns:

byte stream ready to send

Throws:

java.io.IOException

getBinaryData

public byte[] getBinaryData()

Get data of raw message. Will return null if message is not a raw message.

Returns:

Binary data of raw message

setBinaryData

public void setBinaryData(byte[] binaryData)

Set data for raw message.

Parameters:

binaryData -

isBinaryMessage

public boolean isBinaryMessage()

Return true if message is a raw message

Returns:

raw message flag

setBinaryMessage

public void setBinaryMessage(boolean isRaw)

Set or clear raw (binary) message flag

Parameters:

isControl - true to set control message flag

isControlMessage

public boolean isControlMessage()

Return true if message is a control message

Returns:

control message flag

setControl

public void setControl(boolean isControl)

Set or clear control message flag

Parameters:

isControl - true to set control message flag

isEndOfFile

public boolean isEndOfFile()

Return true if message has "end of file" flag set

Returns:

"end of file" flag

setEndOfFile

public void setEndOfFile(boolean isEOF)

Set end of file message flag

Parameters:

isEOF - true to set end of file message flag

isEndOfSequence

public boolean isEndOfSequence()

Return true if message has "end of sequence" flag set

Returns:

"end of file" flag

setEndOfSequence

public void setEndOfSequence(boolean isEOS)

Set end of sequence message flag

Parameters:

isEOS - true to set end of sequence message flag

isEncryptionDisabled

public boolean isEncryptionDisabled()

Return true if message has "don't encrypt" flag set

Returns:

"don't encrypr" flag

setEncryptionDisabled

public void setEncryptionDisabled(boolean disabled)

Set "don't encrypt" message flag

Parameters:

disabled - true to set "don't encrypt" message flag

getControlData

public long getControlData()

Returns:

the controlData

setControlData

public void setControlData(long controlData)

Parameters:

controlData - the controlData to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object