Package org.ametys.core.user

Class User<T extends UserFactory>

java.lang.Object

org.ametys.core.user.User<T>

Type Parameters:

T - The type of the factory

All Implemented Interfaces:

Principal

public class User<T extends UserFactory>
extends Object
implements Principal

Implementation of the principal abstraction to represent an user with a login and a StoredUser

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	User.UserCreationOrigin	Enumeration for the user creation origin
static class	User.UserImage	Basic structure holding necessary data representing an user profile image

Field Summary

Fields

Modifier and Type	Field	Description
protected T	_factory	The factory
protected UserIdentity	_identity	The identity of this principal.
protected UserDirectory	_userDirectory	The user directory this user belongs to.
static final String	CREATION_DATE_DATA_ID	The id of the creation date data.
static final String	CREATION_ORIGIN_DATA_ID	The id of the creation origin data.
static final String	EMAIL_DATA_ID	The id of the email data.
static final String	FIRST_NAME_DATA_ID	The id of the first name data.
static final String	IMAGE_DATA_ID	The id of the image data.
static final String	LANGUAGE_DATA_ID	The id of the language data.
static final String	LAST_NAME_DATA_ID	The id of the last name data.
static final String	TIMEZONE_DATA_ID	The id of the timezone data.

Method Summary

Modifier and Type	Method	Description
protected String	_getFullName(boolean firstnameThenLastname)	The full name of the user represented by this Principal.
boolean	equals(Object another)	Test if two principal are equals.
ZonedDateTime	getCreationDate()	Get the user's creation date
User.UserCreationOrigin	getCreationOrigin()	Get the user's creation origin
String	getEmail()	The email of the user represented by this Principal.
String	getFirstName()	The first name of the user
String	getFullName()	The fullname of this user.
UserIdentity	getIdentity()	The identity of the user.
User.UserImage	getImage(int size, int maxSize)	Get user's avatar from the UserDataProvider with the biggest priority
String	getLanguage()	Get user's language from the UserDataProvider with the biggest priority
ZonedDateTime	getLastConnectionDate()	Get the last connection date of the user
String	getLastName()	The last name of the user
String	getName()
UserDataProvider	getProviderFor(String dataId)	Get the UserDataProvider with the biggest priority and a value not null for the data requested
String	getSortableName()	The fullname to use to display if sort is needed.
StoredUser	getStoredUser()	Get the StoredUser of the User
TimeZone	getTimeZone()	Get user's TimeZone from the UserDataProvider with the biggest priority
UserDirectory	getUserDirectory()	The user directory this user belongs to.
Object	getValue(String dataId)	Get a user's data from the UserDataProvider with the biggest priority
int	hashCode()
String	toString()	Return a String representation of this object, which exposes only information that should be public.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Field Details

LAST_NAME_DATA_ID

public static final String LAST_NAME_DATA_ID

The id of the last name data. This data is of type String

See Also:

• Constant Field Values

FIRST_NAME_DATA_ID

public static final String FIRST_NAME_DATA_ID

The id of the first name data. This data is of type String

See Also:

• Constant Field Values

EMAIL_DATA_ID

public static final String EMAIL_DATA_ID

The id of the email data. This data is of type String

See Also:

• Constant Field Values

IMAGE_DATA_ID

public static final String IMAGE_DATA_ID

The id of the image data. This data is of type User.UserImage

See Also:

• Constant Field Values

LANGUAGE_DATA_ID

public static final String LANGUAGE_DATA_ID

The id of the language data. This data is of type String

See Also:

• Constant Field Values

TIMEZONE_DATA_ID

public static final String TIMEZONE_DATA_ID

The id of the timezone data. This data is of type TimeZone or is a TimeZoneId of type String

See Also:

• Constant Field Values

CREATION_DATE_DATA_ID

public static final String CREATION_DATE_DATA_ID

The id of the creation date data. This data is of type ZonedDateTime

See Also:

• Constant Field Values

CREATION_ORIGIN_DATA_ID

public static final String CREATION_ORIGIN_DATA_ID

The id of the creation origin data. This data is of type User.UserCreationOrigin

See Also:

• Constant Field Values

_identity

protected UserIdentity _identity

The identity of this principal.

_userDirectory

protected UserDirectory _userDirectory

The user directory this user belongs to.

_factory

protected T extends UserFactory _factory

The factory

Method Details

getIdentity

public UserIdentity getIdentity()

The identity of the user.

Returns:

The identity.

getStoredUser

public StoredUser getStoredUser()

Get the StoredUser of the User

Returns:

The StoredUser

getName

public String getName()

Specified by:

getName in interface Principal

getUserDirectory

public UserDirectory getUserDirectory()

The user directory this user belongs to.

Returns:

The user directory

getLastName

public String getLastName()

The last name of the user

Returns:

The last name.

getFirstName

public String getFirstName()

The first name of the user

Returns:

The first name.

getEmail

public String getEmail()

The email of the user represented by this Principal.

Returns:

The email.

getFullName

public String getFullName()

The fullname of this user.

Returns:

The full name

getSortableName

public String getSortableName()

The fullname to use to display if sort is needed. Ensure the sort will be on

Returns:

The sortable name

getImage

public User.UserImage getImage(int size,
 int maxSize)

Get user's avatar from the UserDataProvider with the biggest priority

Parameters:

size - The size

maxSize - The maxSize

Returns:

A User.UserImage the user's avatar

getLanguage

public String getLanguage()

Get user's language from the UserDataProvider with the biggest priority

Returns:

The user's language

getTimeZone

public TimeZone getTimeZone()

Get user's TimeZone from the UserDataProvider with the biggest priority

Returns:

The user's timezone

getLastConnectionDate

public ZonedDateTime getLastConnectionDate()

Get the last connection date of the user

Returns:

the last connection date or null if the user never logged in

getCreationDate

public ZonedDateTime getCreationDate()

Get the user's creation date

Returns:

the creation date

getCreationOrigin

public User.UserCreationOrigin getCreationOrigin()

Get the user's creation origin

Returns:

the creation origin

getValue

public Object getValue(String dataId)

Get a user's data from the UserDataProvider with the biggest priority

Parameters:

dataId - The data id

Returns:

A user's data

getProviderFor

public UserDataProvider getProviderFor(String dataId)

Get the UserDataProvider with the biggest priority and a value not null for the data requested

Parameters:

dataId - The data id

Returns:

A UserDataProvider the user data provider which is going to provide the data requested

_getFullName

protected String _getFullName(boolean firstnameThenLastname)

The full name of the user represented by this Principal.

Parameters:

firstnameThenLastname - Define the name order in the full name. Set to true to retrieve the fullname with firstname first and lastname second. Set to false to retrieve the fullname with lastname first and firstname second.

Returns:

The full name.

toString

public String toString()

Return a String representation of this object, which exposes only information that should be public.

Specified by:

toString in interface Principal

Overrides:

toString in class Object

Returns:

A string representing the user.

equals

public boolean equals(Object another)

Test if two principal are equals.

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Returns:

true if the given Object represents the same Principal.

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object