]>
git.argeo.org Git - lgpl/argeo-commons.git/blob - org.argeo.cms/src/org/argeo/cms/auth/UserAdminUtils.java
1 package org
.argeo
.cms
.auth
;
5 import javax
.naming
.InvalidNameException
;
6 import javax
.naming
.ldap
.LdapName
;
7 import javax
.naming
.ldap
.Rdn
;
9 import org
.argeo
.api
.acr
.ldap
.LdapAttr
;
10 import org
.argeo
.api
.cms
.CmsConstants
;
11 import org
.argeo
.cms
.CurrentUser
;
12 import org
.osgi
.service
.useradmin
.Role
;
13 import org
.osgi
.service
.useradmin
.User
;
14 import org
.osgi
.service
.useradmin
.UserAdmin
;
16 /** Centralise common patterns to manage users with a {@link UserAdmin} */
18 // TODO use CmsRole after migrating to qualified properties
19 public class UserAdminUtils
{
21 // CURRENTUSER HELPERS
22 /** Checks if current user is the same as the passed one */
23 public static boolean isCurrentUser(User user
) {
24 String userUsername
= getProperty(user
, LdapAttr
.DN
);
25 LdapName userLdapName
= getLdapName(userUsername
);
26 LdapName selfUserName
= getCurrentUserLdapName();
27 return userLdapName
.equals(selfUserName
);
30 /** Retrieves the current logged-in {@link User} */
31 public static User
getCurrentUser(UserAdmin userAdmin
) {
32 return (User
) userAdmin
.getRole(CurrentUser
.getUsername());
35 /** Retrieves the current logged-in user {@link LdapName} */
36 public final static LdapName
getCurrentUserLdapName() {
37 String name
= CurrentUser
.getUsername();
38 return getLdapName(name
);
41 /** Retrieves the current logged-in user mail */
42 public static String
getCurrentUserMail(UserAdmin userAdmin
) {
43 String username
= CurrentUser
.getUsername();
44 return getUserMail(userAdmin
, username
);
47 /** Retrieves the current logged-in user common name */
48 public final static String
getCommonName(User user
) {
49 return getProperty(user
, LdapAttr
.cn
.name());
52 // OTHER USERS HELPERS
54 * Retrieves the local id of a user or group, that is respectively the uid or cn
55 * of the passed dn with no {@link UserAdmin}
57 public static String
getUserLocalId(String dn
) {
58 LdapName ldapName
= getLdapName(dn
);
59 Rdn last
= ldapName
.getRdn(ldapName
.size() - 1);
60 if (last
.getType().toLowerCase().equals(LdapAttr
.uid
.name())
61 || last
.getType().toLowerCase().equals(LdapAttr
.cn
.name()))
62 return (String
) last
.getValue();
64 throw new IllegalArgumentException("Cannot retrieve user local id, non valid dn: " + dn
);
68 * Returns the local username if no user with this dn is found or if the found
69 * user has no defined display name
71 public static String
getUserDisplayName(UserAdmin userAdmin
, String dn
) {
72 Role user
= userAdmin
.getRole(dn
);
74 return getUserLocalId(dn
);
75 return getUserDisplayName(user
);
78 public static String
getUserDisplayName(org
.argeo
.api
.cms
.directory
.CmsRole user
) {
79 return getUserDisplayName((Role
) user
);
82 public static String
getUserDisplayName(Role user
) {
83 String dName
= getProperty(user
, LdapAttr
.displayName
.name());
85 dName
= getProperty(user
, LdapAttr
.cn
.name());
87 dName
= getProperty(user
, LdapAttr
.uid
.name());
89 dName
= getUserLocalId(user
.getName());
94 * Returns null if no user with this dn is found or if the found user has no
97 public static String
getUserMail(UserAdmin userAdmin
, String dn
) {
98 Role user
= userAdmin
.getRole(dn
);
102 return getProperty(user
, LdapAttr
.mail
.name());
105 // LDAP NAMES HELPERS
107 * Easily retrieves one of the {@link Role}'s property or an empty String if the
108 * requested property is not defined
110 public final static String
getProperty(Role role
, String key
) {
111 Object obj
= role
.getProperties().get(key
);
118 public final static String
getProperty(Role role
, Enum
<?
> key
) {
119 Object obj
= role
.getProperties().get(key
.name());
126 public final static void setProperty(Role role
, String key
, String value
) {
127 role
.getProperties().put(key
, value
);
130 public final static void setProperty(Role role
, Enum
<?
> key
, String value
) {
131 setProperty(role
, key
.name(), value
);
135 * Simply retrieves a LDAP name from a {@link LdapAttr.DN} with no exception
137 private static LdapName
getLdapName(String dn
) {
139 return new LdapName(dn
);
140 } catch (InvalidNameException e
) {
141 throw new IllegalArgumentException("Cannot parse LDAP name " + dn
, e
);
145 /** Simply retrieves a display name of the relevant domain */
146 public final static String
getDomainName(User user
) {
147 String dn
= user
.getName();
148 if (dn
.endsWith(CmsConstants
.SYSTEM_ROLES_BASEDN
))
149 return "System roles";
150 if (dn
.endsWith(CmsConstants
.TOKENS_BASEDN
))
153 // FIXME deal with non-DC
154 LdapName name
= new LdapName(dn
);
155 List
<Rdn
> rdns
= name
.getRdns();
158 loop
: while (i
< rdns
.size()) {
159 Rdn currrRdn
= rdns
.get(i
);
160 if (LdapAttr
.uid
.name().equals(currrRdn
.getType()) || LdapAttr
.cn
.name().equals(currrRdn
.getType())
161 || LdapAttr
.ou
.name().equals(currrRdn
.getType()))
164 String currVal
= (String
) currrRdn
.getValue();
165 dname
= dname
== null ? currVal
: currVal
+ "." + dname
;
170 } catch (InvalidNameException e
) {
171 throw new IllegalArgumentException("Unable to get domain name for " + dn
, e
);
176 public final static String
buildDefaultCn(String firstName
, String lastName
) {
177 return (firstName
.trim() + " " + lastName
.trim() + " ").trim();
180 /** Simply checks if a string is null or empty */
181 private static boolean isEmpty(String stringToTest
) {
182 return stringToTest
== null || "".equals(stringToTest
.trim());