org.eclipse.californium.elements

Class MapBasedEndpointContext

java.lang.Object

org.eclipse.californium.elements.AddressEndpointContext

org.eclipse.californium.elements.MapBasedEndpointContext

All Implemented Interfaces:

EndpointContext

Direct Known Subclasses:

DtlsEndpointContext, TcpEndpointContext, UdpEndpointContext

public class MapBasedEndpointContext
extends AddressEndpointContext

A map based endpoint context.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_PREFIX_NONE_CRITICAL Prefix for none critical attributes.

Fields inherited from class org.eclipse.californium.elements.AddressEndpointContext

ID_TRUNC_LENGTH

Constructor Summary

Constructors

Constructor and Description
MapBasedEndpointContext(InetSocketAddress peerAddress, Principal peerIdentity, Map<String,String> attributes) Creates a new endpoint context with correlation context support.
MapBasedEndpointContext(InetSocketAddress peerAddress, Principal peerIdentity, String... attributes) Creates a context for a socket address, authenticated identity and arbitrary key/value pairs.
MapBasedEndpointContext(InetSocketAddress peerAddress, String virtualHost, Principal peerIdentity, Map<String,String> attributes) Creates a new endpoint context with correlation context support.
MapBasedEndpointContext(InetSocketAddress peerAddress, String virtualHost, Principal peerIdentity, String... attributes) Creates a context for a socket address, authenticated identity and arbitrary key/value pairs.

Method Summary

Methods

Modifier and Type	Method and Description
static MapBasedEndpointContext	addEntries(EndpointContext context, String... attributes) Add entries to endpoint context.
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.
boolean	hasCriticalEntries() Check, if the correlation information contained, contains critical entries relevant for matching.
String	toString()

Methods inherited from class org.eclipse.californium.elements.AddressEndpointContext

getPeerAddress, getPeerAddressAsString, getPeerIdentity, getVirtualHost

Methods inherited from class java.lang.Object

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

Field Detail

KEY_PREFIX_NONE_CRITICAL

public static final String KEY_PREFIX_NONE_CRITICAL

Prefix for none critical attributes. These attributes are not considered for context matching nor hasCriticalEntries().

See Also:

Constant Field Values

Constructor Detail

MapBasedEndpointContext

public MapBasedEndpointContext(InetSocketAddress peerAddress,
                       Principal peerIdentity,
                       String... attributes)

Creates a context for a socket address, authenticated identity and arbitrary key/value pairs.

Parameters:

peerAddress - peer address of endpoint context

peerIdentity - peer identity of endpoint context

attributes - list of attributes (key/value pairs, e.g. key_1, value_1, key_2, value_2 ...)

Throws:

NullPointerException - if provided peer address is null, the provided attributes is null, or one of the attributes is null.

IllegalArgumentException - if provided attributes list has odd size or contains a duplicate key.

MapBasedEndpointContext

public MapBasedEndpointContext(InetSocketAddress peerAddress,
                       String virtualHost,
                       Principal peerIdentity,
                       String... attributes)

Creates a context for a socket address, authenticated identity and arbitrary key/value pairs.

Parameters:

peerAddress - peer address of endpoint context

virtualHost - the name of the virtual host at the peer

peerIdentity - peer identity of endpoint context

attributes - list of attributes (key/value pairs, e.g. key_1, value_1, key_2, value_2 ...)

Throws:

NullPointerException - if provided peer address is null, the provided attributes is null, or one of the attributes is null.

IllegalArgumentException - if provided attributes list has odd size or contains a duplicate key.

MapBasedEndpointContext

public MapBasedEndpointContext(InetSocketAddress peerAddress,
                       Principal peerIdentity,
                       Map<String,String> attributes)

Creates a new endpoint context with correlation context support.

Parameters:

peerAddress - peer address of endpoint context

peerIdentity - peer identity of endpoint context

attributes - map of attributes

Throws:

NullPointerException - if provided peer address, or attributes map is null.

MapBasedEndpointContext

public MapBasedEndpointContext(InetSocketAddress peerAddress,
                       String virtualHost,
                       Principal peerIdentity,
                       Map<String,String> attributes)

Creates a new endpoint context with correlation context support.

Parameters:

peerAddress - peer address of endpoint context

virtualHost - the name of the virtual host at the peer

peerIdentity - peer identity of endpoint context

attributes - map of attributes

Throws:

NullPointerException - if provided peer address, or attributes map is null.

Method Detail

get

public String get(String key)

Description copied from class: AddressEndpointContext

Gets a value from this context.

Specified by:

get in interface EndpointContext

Overrides:

get in class AddressEndpointContext

Parameters:

key - the key to retrieve the value for.

Returns:

null

entries

public Map<String,String> entries()

Description copied from class: AddressEndpointContext

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

Specified by:

entries in interface EndpointContext

Overrides:

entries in class AddressEndpointContext

Returns:

an empty map

hasCriticalEntries

public boolean hasCriticalEntries()

Description copied from interface: EndpointContext

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

Specified by:

hasCriticalEntries in interface EndpointContext

Overrides:

hasCriticalEntries in class AddressEndpointContext

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.

toString

public String toString()

Overrides:

toString in class AddressEndpointContext

addEntries

public static MapBasedEndpointContext addEntries(EndpointContext context,
                                 String... attributes)

Add entries to endpoint context.

Parameters:

context - original endpoint context.

attributes - list of attributes (key/value pairs, e.g. key_1, value_1, key_2, value_2 ...)

Returns:

new endpoint context with additional attributes.

Throws:

NullPointerException - if the provided attributes is null, or one of the attributes is null.

IllegalArgumentException - if provided attributes list has odd size or contains a duplicate key.