com.communote.server.core.user

Class UserManagementHelper

java.lang.Object

com.communote.server.core.user.UserManagementHelper

public final class UserManagementHelper
extends Object

Helper class for user management which amongst others provides methods for checking the limit of activated user accounts of the user.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static long	getCountLimit() Gets the user limit.
static int	getCurrentOffsetOfEffectiveUserTimeZone() Returns the offset in milliseconds to add to UTC to get the time for the current user respecting the effective user time zone and daylight savings.
static int	getCurrentUtcOffsetOfEffectiveUserTimeZone() Returns the offset in milliseconds to add to UTC to get the current time for the current user respecting the effective user time zone and daylight savings.
static DateFormat	getDateFormat(Long userId, Locale locale) Get the date formatter for the given locale which can be used to create a readable localized date-time string.
static TimeZone	getEffectiveUserTimeZone() Gets the effective time zone for the currently logged in user. If no time zone exists for the user, this method returns the client time zone as fall back. If no time zone exists for the client, this method returns the system time zone as fall back.
static TimeZone	getEffectiveUserTimeZone(Long userId) Gets the effective time zone for the user. If no time zone exists for the user, this method returns the client time zone as fall back. If no time zone exists for the client, this method returns the system time zone as fall back.
static TimeZone	getEffectiveUserTimeZone(Long userId, TimeZone fallback) Gets the effective time zone for the user. If no time zone exists for the user, this method returns the client time zone as fall back. If no time zone exists for the client, this method returns the defined time zone as fall back.
static TimeZone	getEffectiveUserTimeZone(TimeZone fallback) Gets the effective time zone for the currently logged in user. If no time zone exists for the user, this method returns the client time zone as fall back. If no time zone exists for the client, this method returns the defined time zone as fall back.
static Locale	getFallbackLocale()
static String	getLegalAliasFromEmailAddress(String address) Converts an email address, only the local part of it, into a valid user alias.
static Map<Locale,Collection<User>>	getUserByLocale(Collection<User> users) Groups a collection of users by their localization settings.
static Map<Locale,Collection<User>>	getUserByLocale(Collection<User> users, Collection<User> usersToSkip) Groups a collection of users by their localization settings.
static boolean	isAutomaticUserActivation() Get the Value of ConfigurationPropertyConstants.Client.AUTOMATIC_USER_ACTIVATION for better code reading.
static boolean	isSystemUser(User user)

Methods inherited from class java.lang.Object

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

Method Detail

getCountLimit

public static long getCountLimit()

Gets the user limit.

Returns:

the limit

getCurrentOffsetOfEffectiveUserTimeZone

public static int getCurrentOffsetOfEffectiveUserTimeZone()

Returns the offset in milliseconds to add to UTC to get the time for the current user respecting the effective user time zone and daylight savings.

Note: The offset is for the servers time.

Returns:

the offset in milliseconds

getCurrentUtcOffsetOfEffectiveUserTimeZone

public static int getCurrentUtcOffsetOfEffectiveUserTimeZone()

Returns the offset in milliseconds to add to UTC to get the current time for the current user respecting the effective user time zone and daylight savings.

Returns:

the offset in milliseconds

getDateFormat

public static DateFormat getDateFormat(Long userId,
                                       Locale locale)

Get the date formatter for the given locale which can be used to create a readable localized date-time string. e.g. for ...
German: 17. November 2009 15:00:02 MEZ
United Kingdom: 17 November 2009 15:26:32 CET
United States: November 17, 2009 3:26:32 PM CET

Parameters:

userId - the user id

locale - the locale

Returns:

the date formatter

getEffectiveUserTimeZone

public static TimeZone getEffectiveUserTimeZone()

Gets the effective time zone for the currently logged in user.

If no time zone exists for the user, this method returns the client time zone as fall back.
If no time zone exists for the client, this method returns the system time zone as fall back.

Returns:

timeZone the effective time zone for the current user

getEffectiveUserTimeZone

public static TimeZone getEffectiveUserTimeZone(Long userId)

Gets the effective time zone for the user.

If no time zone exists for the user, this method returns the client time zone as fall back.
If no time zone exists for the client, this method returns the system time zone as fall back.

Parameters:

userId - the id of a user

Returns:

timeZone the effective time zone for the user

getEffectiveUserTimeZone

public static TimeZone getEffectiveUserTimeZone(Long userId,
                                                TimeZone fallback)

Gets the effective time zone for the user.

If no time zone exists for the user, this method returns the client time zone as fall back.
If no time zone exists for the client, this method returns the defined time zone as fall back.

Parameters:

userId - the id of a user

fallback - the defined fall back

Returns:

The users time zone or the fall back if null.

getEffectiveUserTimeZone

public static TimeZone getEffectiveUserTimeZone(TimeZone fallback)

Gets the effective time zone for the currently logged in user.

If no time zone exists for the user, this method returns the client time zone as fall back.
If no time zone exists for the client, this method returns the defined time zone as fall back.

Parameters:

fallback - the defined fall back

Returns:

The users time zone or the fall back if null.

getFallbackLocale

public static Locale getFallbackLocale()

Returns:

the fall back locale if non is defined

getLegalAliasFromEmailAddress

public static String getLegalAliasFromEmailAddress(String address)

Converts an email address, only the local part of it, into a valid user alias. If the address does not have local part the string 'user' will be returned.

Parameters:

address - the email address to convert

Returns:

the legal alias

getUserByLocale

public static Map<Locale,Collection<User>> getUserByLocale(Collection<User> users)

Groups a collection of users by their localization settings.

Parameters:

users - the users

Returns:

the users grouped by localization

getUserByLocale

public static Map<Locale,Collection<User>> getUserByLocale(Collection<User> users,
                                                           Collection<User> usersToSkip)

Groups a collection of users by their localization settings.

Parameters:

users - the user collection

usersToSkip - a subset of the users collection containing those users that should be included in the result. Can be null.

Returns:

the users grouped by localization

isAutomaticUserActivation

public static boolean isAutomaticUserActivation()

Get the Value of ConfigurationPropertyConstants.Client.AUTOMATIC_USER_ACTIVATION for better code reading.

Returns:

value of ConfigurationPropertyConstants.Client.AUTOMATIC_USER_ACTIVATION

isSystemUser

public static boolean isSystemUser(User user)

Parameters:

user - the user to check

Returns:

true if the is is a system user