org.eclipse.californium.elements

Class RawData

java.lang.Object

org.eclipse.californium.elements.RawData

public class RawData
extends Object

A container object for the data received or sent via a Connector. The following meta-data is included:

• the source/destination IP address
• the source/destination port
• a flag indicating whether the message is a multicast message (default is false)

A message received from a client via the network may also optionally contain the authenticated sender's identity as a java.security.Principal object.

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	bytes The raw message.

Constructor Summary

Constructors

Constructor and Description
RawData(byte[] data) Deprecated. Use one of the other constructors instead.
RawData(byte[] data, InetAddress address, int port) Instantiates a new raw data.
RawData(byte[] data, InetAddress address, int port, boolean multicast) Instantiates a new raw data.
RawData(byte[] data, InetAddress address, int port, Principal clientIdentity) Instantiates a new raw data.
RawData(byte[] data, InetAddress address, int port, Principal clientIdentity, boolean multicast) Instantiates a new raw data.
RawData(byte[] data, InetSocketAddress address) Instantiates a new raw data.
RawData(byte[] data, InetSocketAddress address, boolean multicast) Instantiates a new raw data.
RawData(byte[] data, InetSocketAddress address, Principal clientIdentity) Instantiates a new raw data.
RawData(byte[] data, InetSocketAddress address, Principal clientIdentity, boolean multicast) Instantiates a new raw data.

Method Summary

Methods

Modifier and Type	Method and Description
InetAddress	getAddress() Gets the address.
byte[]	getBytes() Gets the raw message.
InetSocketAddress	getInetSocketAddress() Gets the source/destination IP address and port.
int	getPort() Gets the port.
Principal	getSenderIdentity() Gets the identity of the sender of the message.
int	getSize() Gets the length of the serialized message
boolean	isMulticast() Checks if this is a multicast message
void	setAddress(InetAddress newAddress) Deprecated. Use constructor instead.
void	setMulticast(boolean multicast) Deprecated. Use constructor instead.
void	setPort(int port) Deprecated. Use constructor instead.

Methods inherited from class java.lang.Object

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

Field Detail

bytes

public final byte[] bytes

The raw message.

Constructor Detail

RawData

public RawData(byte[] data)

Deprecated. Use one of the other constructors instead.

Instantiates a new raw data.

Parameters:

data - the data that is to be sent or has been received

RawData

public RawData(byte[] data,
       InetSocketAddress address)

Instantiates a new raw data.

Parameters:

data - the data that is to be sent or has been received

address - the IP address and port the data is to be sent to or has been received from

Throws:

NullPointerException - if any of the given parameters is null

RawData

public RawData(byte[] data,
       InetSocketAddress address,
       Principal clientIdentity)

Instantiates a new raw data.

Parameters:

data - the data that is to be sent or has been received

address - the IP address and port the data is to be sent to or has been received from

clientIdentity - the identity of the authenticated sender of the message (or null if sender is not authenticated)

Throws:

NullPointerException - if any of the given parameters is null

RawData

public RawData(byte[] data,
       InetAddress address,
       int port)

Instantiates a new raw data.

Parameters:

data - the data that is to be sent or has been received

address - the IP address the data is to be sent to or has been received from

port - the port the data is to be sent to or has been received from

Throws:

NullPointerException - if data is null

RawData

public RawData(byte[] data,
       InetAddress address,
       int port,
       Principal clientIdentity)

Instantiates a new raw data.

Parameters:

data - the data that is to be sent or has been received

address - the IP address the data is to be sent to or has been received from

port - the port the data is to be sent to or has been received from

clientIdentity - the identity of the authenticated sender of the message (or null if sender is not authenticated)

Throws:

NullPointerException - if data is null

RawData

public RawData(byte[] data,
       InetSocketAddress address,
       boolean multicast)

Instantiates a new raw data.

Parameters:

data - the data that is to be sent or has been received

address - the IP address and port the data is to be sent to or has been received from

multicast - indicates whether the data represents a multicast message

Throws:

NullPointerException - if data or address is null

RawData

public RawData(byte[] data,
       InetSocketAddress address,
       Principal clientIdentity,
       boolean multicast)

Instantiates a new raw data.

Parameters:

data - the data that is to be sent or has been received

address - the IP address and port the data is to be sent to or has been received from

clientIdentity - the identity of the authenticated sender of the message (or null if sender is not authenticated)

multicast - indicates whether the data represents a multicast message

Throws:

NullPointerException - if data or address is null

RawData

public RawData(byte[] data,
       InetAddress address,
       int port,
       boolean multicast)

Instantiates a new raw data.

Parameters:

data - the data that is to be sent or has been received

address - the IP address the data is to be sent to or has been received from

port - the port the data is to be sent to or has been received from

multicast - indicates whether the data represents a multicast message

Throws:

NullPointerException - if data is null

RawData

public RawData(byte[] data,
       InetAddress address,
       int port,
       Principal clientIdentity,
       boolean multicast)

Instantiates a new raw data.

Parameters:

data - the data that is to be sent or has been received

address - the IP address the data is to be sent to or has been received from

port - the port the data is to be sent to or has been received from

clientIdentity - the identity of the authenticated sender of the message (or null if sender is not authenticated)

multicast - indicates whether the data represents a multicast message

Throws:

NullPointerException - if data is null

Method Detail

getBytes

public byte[] getBytes()

Gets the raw message.

Returns:

a copy of the raw message bytes

getSize

public int getSize()

Gets the length of the serialized message

Returns:

the size

getAddress

public InetAddress getAddress()

Gets the address.

Returns:

the address

setAddress

public void setAddress(InetAddress newAddress)

Deprecated. Use constructor instead.

Sets the address.

Parameters:

newAddress - the new address

getPort

public int getPort()

Gets the port.

Returns:

the port

setPort

public void setPort(int port)

Deprecated. Use constructor instead.

Sets the port.

Parameters:

port - the new port

isMulticast

public boolean isMulticast()

Checks if this is a multicast message

Returns:

true, if this is a multicast message

setMulticast

public void setMulticast(boolean multicast)

Deprecated. Use constructor instead.

Marks this message as a multicast message.

Parameters:

multicast - whether this message is a multicast message

getInetSocketAddress

public InetSocketAddress getInetSocketAddress()

Gets the source/destination IP address and port.

Returns:

the address

getSenderIdentity

public Principal getSenderIdentity()

Gets the identity of the sender of the message. This property is only meaningful for messages received from a client.

Returns:

the identity or null if the sender has not been authenticated