org.eclipse.californium.elements

Class AddressEndpointContext

java.lang.Object

org.eclipse.californium.elements.AddressEndpointContext

All Implemented Interfaces:

EndpointContext

Direct Known Subclasses:

MapBasedEndpointContext

public class AddressEndpointContext
extends Object
implements EndpointContext

A endpoint context providing the inet socket address and a optional principal.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ID_TRUNC_LENGTH

Constructor Summary

Constructors

Constructor and Description
AddressEndpointContext(InetAddress address, int port) Creates a context for an IP address and port.
AddressEndpointContext(InetSocketAddress peerAddress) Creates a context for a socket address.
AddressEndpointContext(InetSocketAddress peerAddress, Principal peerIdentity) Creates a context for a socket address and an authenticated identity.
AddressEndpointContext(InetSocketAddress peerAddress, String virtualHost, Principal peerIdentity) Create endpoint context with principal.

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.
protected String	getPeerAddressAsString()
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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ID_TRUNC_LENGTH

protected static final int ID_TRUNC_LENGTH

See Also:

Constant Field Values

Constructor Detail

AddressEndpointContext

public AddressEndpointContext(InetAddress address,
                      int port)

Creates a context for an IP address and port.

Parameters:

address - IP address of peer

port - port of peer

Throws:

NullPointerException - if provided address is null.

AddressEndpointContext

public AddressEndpointContext(InetSocketAddress peerAddress)

Creates a context for a socket address.

Parameters:

peerAddress - socket address of peer's service

Throws:

NullPointerException - if provided peer address is null.

AddressEndpointContext

public AddressEndpointContext(InetSocketAddress peerAddress,
                      Principal peerIdentity)

Creates a context for a socket address and an authenticated identity.

Parameters:

peerAddress - socket address of peer's service

peerIdentity - peer's principal

Throws:

NullPointerException - if provided peer address is null.

AddressEndpointContext

public AddressEndpointContext(InetSocketAddress peerAddress,
                      String virtualHost,
                      Principal peerIdentity)

Create endpoint context with principal.

Parameters:

peerAddress - socket address of peer's service

virtualHost - the name of the virtual host at the peer

peerIdentity - peer's principal

Throws:

NullPointerException - if provided peer address is null.

Method Detail

get

public String get(String key)

Gets a value from this context.

Specified by:

get in interface EndpointContext

Parameters:

key - the key to retrieve the value for.

Returns:

null

entries

public 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".

Specified by:

entries in interface EndpointContext

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

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

public final Principal getPeerIdentity()

Description copied from interface: EndpointContext

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

Specified by:

getPeerIdentity in interface EndpointContext

Returns:

identity of peer. null, if not available.

getPeerAddress

public final InetSocketAddress getPeerAddress()

Description copied from interface: EndpointContext

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

Specified by:

getPeerAddress in interface EndpointContext

Returns:

address of peer

getVirtualHost

public final String getVirtualHost()

Description copied from interface: EndpointContext

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

Specified by:

getVirtualHost in interface EndpointContext

Returns:

the name or null if no virtual host is set.

toString

public String toString()

Overrides:

toString in class Object

getPeerAddressAsString

protected final String getPeerAddressAsString()