org.eclipse.californium.elements

Interface EndpointContext

All Known Implementing Classes:

AddressEndpointContext, DtlsEndpointContext, MapBasedEndpointContext, TcpEndpointContext, TlsEndpointContext, UdpEndpointContext

public interface EndpointContext

A container for storing transport specific information about the context in which a message has been sent or received. Contains several endpoint identity candidates:

Candidate	Description	Long-Term-Stable
InetSocketAddress	identity for plain coap according RFC7252	With IPv4 and NATs too frequently not long-term-stable
Principal	identity for secure endpoint, requires unique credentials per client	As stable as the credentials
DTLS Session, cipher suite, epoch	identity for secure coaps according RFC7252	With new or resumed DTLS session not long-term-stable

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	entries() Gets a Set of a Map.Entry which contains the key-value pair of the CorrelationContext.
String	get(String key) Gets a value from this context.
InetSocketAddress	getPeerAddress() Gets the inet address of the peer that the message is for or from.
Principal	getPeerIdentity() Gets the identity of the peer that the message is for or from.
String	getVirtualHost() Gets the name of the virtual host that this endpoint is scoped to.
boolean	hasCriticalEntries() Check, if the correlation information contained, contains critical entries relevant for matching.

Method Detail

get

String get(String key)

Gets a value from this context.

Parameters:

key - the key to retrieve the value for.

Returns:

the value or null if this context does not contain a value for the given key.

entries

Map<String,String> entries()

Gets a Set of a Map.Entry which contains the key-value pair of the CorrelationContext. The Set is intended to be "unmodifiable".

Returns:

A set of a map entry containing the key value pair.

hasCriticalEntries

boolean hasCriticalEntries()

Check, if the correlation information contained, contains critical entries relevant for matching. A context with critical entries will inhibit a new connection.

Returns:

true, if critical entries contained, and no new connection could match the correlation context provided in this instance. false, if a new connection may match this correlation context.

getPeerIdentity

Principal getPeerIdentity()

Gets the identity of the peer that the message is for or from.

Returns:

identity of peer. null, if not available.

getPeerAddress

InetSocketAddress getPeerAddress()

Gets the inet address of the peer that the message is for or from.

Returns:

address of peer

getVirtualHost

String getVirtualHost()

Gets the name of the virtual host that this endpoint is scoped to.

Returns:

the name or null if no virtual host is set.