org.argeo.cms.auth

Class UserAdminUtils

java.lang.Object

org.argeo.cms.auth.UserAdminUtils

public class UserAdminUtils
extends java.lang.Object

Centralise common patterns to manage users with a UserAdmin

Constructor Summary

Constructors

Constructor and Description
UserAdminUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildDefaultCn(java.lang.String firstName, java.lang.String lastName)
static java.lang.String	getCommonName(User user) Retrieves the current logged-in user common name
static User	getCurrentUser(UserAdmin userAdmin) Retrieves the current logged-in User
static javax.naming.ldap.LdapName	getCurrentUserLdapName() Retrieves the current logged-in user LdapName
static java.lang.String	getCurrentUserMail(UserAdmin userAdmin) Retrieves the current logged-in user mail
static java.lang.String	getDomainName(User user) Simply retrieves a display name of the relevant domain
static java.lang.String	getProperty(Role role, java.lang.Enum<?> key)
static java.lang.String	getProperty(Role role, java.lang.String key) Easily retrieves one of the Role's property or an empty String if the requested property is not defined
static java.lang.String	getUserDisplayName(UserAdmin userAdmin, java.lang.String dn) Returns the local username if no user with this dn is found or if the found user has no defined display name
static java.lang.String	getUserLocalId(java.lang.String dn) Retrieves the local id of a user or group, that is respectively the uid or cn of the passed dn with no UserAdmin
static java.lang.String	getUserMail(UserAdmin userAdmin, java.lang.String dn) Returns null if no user with this dn is found or if the found user has no defined mail
static boolean	isCurrentUser(User user) Checks if current user is the same as the passed one
static void	setProperty(Role role, java.lang.Enum<?> key, java.lang.String value)
static void	setProperty(Role role, java.lang.String key, java.lang.String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAdminUtils

public UserAdminUtils()

Method Detail

isCurrentUser

public static boolean isCurrentUser(User user)

Checks if current user is the same as the passed one

getCurrentUser

public static User getCurrentUser(UserAdmin userAdmin)

Retrieves the current logged-in User

getCurrentUserLdapName

public static final javax.naming.ldap.LdapName getCurrentUserLdapName()

Retrieves the current logged-in user LdapName

getCurrentUserMail

public static java.lang.String getCurrentUserMail(UserAdmin userAdmin)

Retrieves the current logged-in user mail

getCommonName

public static final java.lang.String getCommonName(User user)

Retrieves the current logged-in user common name

getUserLocalId

public static java.lang.String getUserLocalId(java.lang.String dn)

Retrieves the local id of a user or group, that is respectively the uid or cn of the passed dn with no UserAdmin

getUserDisplayName

public static java.lang.String getUserDisplayName(UserAdmin userAdmin,
                                                  java.lang.String dn)

Returns the local username if no user with this dn is found or if the found user has no defined display name

getUserMail

public static java.lang.String getUserMail(UserAdmin userAdmin,
                                           java.lang.String dn)

Returns null if no user with this dn is found or if the found user has no defined mail

getProperty

public static final java.lang.String getProperty(Role role,
                                                 java.lang.String key)

Easily retrieves one of the Role's property or an empty String if the requested property is not defined

getProperty

public static final java.lang.String getProperty(Role role,
                                                 java.lang.Enum<?> key)

setProperty

public static final void setProperty(Role role,
                                     java.lang.String key,
                                     java.lang.String value)

setProperty

public static final void setProperty(Role role,
                                     java.lang.Enum<?> key,
                                     java.lang.String value)

getDomainName

public static final java.lang.String getDomainName(User user)

Simply retrieves a display name of the relevant domain

buildDefaultCn

public static final java.lang.String buildDefaultCn(java.lang.String firstName,
                                                    java.lang.String lastName)