org.eclipse.californium.elements.auth

Class PreSharedKeyIdentity

java.lang.Object

org.eclipse.californium.elements.auth.PreSharedKeyIdentity

All Implemented Interfaces:

Principal

public final class PreSharedKeyIdentity
extends Object
implements Principal

A principal representing an authenticated peer's identity as used in a pre-shared key handshake.

Constructor Summary

Constructors

Constructor and Description
PreSharedKeyIdentity(String identity) Creates a new instance for an identity.
PreSharedKeyIdentity(String virtualHost, String identity) Creates a new instance for an identity scoped to a virtual host.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares another object to this identity.
String	getIdentity() Gets the identity.
String	getName() Gets the name of this principal.
String	getVirtualHost() Gets the virtual host name that the identity is scoped to.
int	hashCode()
boolean	isScopedIdentity() Checks, if the identity is scoped by the virtual host name.
String	toString() Gets a string representation of this principal.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PreSharedKeyIdentity

public PreSharedKeyIdentity(String identity)

Creates a new instance for an identity.

Parameters:

identity - the identity

Throws:

NullPointerException - if the identity is null

PreSharedKeyIdentity

public PreSharedKeyIdentity(String virtualHost,
                    String identity)

Creates a new instance for an identity scoped to a virtual host.

Parameters:

virtualHost - The virtual host name that the identity is scoped to. The host name will be converted to lower case.

identity - the identity.

Throws:

NullPointerException - if the identity is null

IllegalArgumentException - if virtual host is not a valid host name as per RFC 1123.

Method Detail

isScopedIdentity

public boolean isScopedIdentity()

Checks, if the identity is scoped by the virtual host name.

Returns:

true, if the identity is scoped by the virtual host name.

getVirtualHost

public String getVirtualHost()

Gets the virtual host name that the identity is scoped to.

Returns:

The name or null if not set.

getIdentity

public String getIdentity()

Gets the identity.

Returns:

The identity.

getName

public String getName()

Gets the name of this principal.

If the identity is not scoped by the server name, the getIdentity() is returned. If the identity is scoped by the server name, the name consists of that server name and the identity, separated by a colon character. If no server name has been provided, then the name consists of a colon character followed by the identity.

Specified by:

getName in interface Principal

Returns:

the name

toString

public String toString()

Gets a string representation of this principal. Clients should not assume any particular format of the returned string since it may change over time.

Specified by:

toString in interface Principal

Overrides:

toString in class Object

Returns:

the string representation

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Compares another object to this identity.

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Returns:

true if the other object is a PreSharedKeyIdentity and its name property has the same value as this instance.