Package org.jgrapes.webconsole.base

Class ConsoleUser

java.lang.Object

org.jgrapes.webconsole.base.ConsoleUser

All Implemented Interfaces:

Principal

public class ConsoleUser
extends Object
implements Principal

A Principal representing an identity used by web console components.

Console users are usually not managed. Rather, the information is derived from some authentication system and provided to console components in a way that is independent from a particular authentication strategy.

Constructor Summary

Constructors

Constructor	Description
ConsoleUser(String name)	Instantiates a new console user with the name also being used as display name.
ConsoleUser(String name, String displayName)	Instantiates a new console user.

Method Summary

Modifier and Type	Method	Description
jakarta.mail.Address	email()	Gets the email address.
boolean	equals(Object obj)
String	getDisplayName()	The name to use when showing the user to humans.
String	getName()	Gets the unique name.
int	hashCode()
ConsoleUser	setEmail(jakarta.mail.Address email)	Sets the email address.
String	toString()	Returns the name followed by the display name in parenthesis.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Constructor Details

ConsoleUser

public ConsoleUser(String name,
 String displayName)

Instantiates a new console user.

Note that name must be unique.

Parameters:

name - the name

displayName - the display name

ConsoleUser

public ConsoleUser(String name)

Instantiates a new console user with the name also being used as display name.

Parameters:

name - the name

Method Details

getName

public String getName()

Gets the unique name.

Used as key when storing or retrieving user specific information.

Specified by:

getName in interface Principal

Returns:

the name

getDisplayName

public String getDisplayName()

The name to use when showing the user to humans.

Returns:

the display name

email

public jakarta.mail.Address email()

Gets the email address.

Returns:

the email

setEmail

public ConsoleUser setEmail(jakarta.mail.Address email)

Sets the email address.

Parameters:

email - the new email

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Principal

Overrides:

equals in class Object

toString

public String toString()

Returns the name followed by the display name in parenthesis.

Specified by:

toString in interface Principal

Overrides:

toString in class Object

Returns:

the string