1 package org
.argeo
.osgi
.useradmin
;
3 import static org
.argeo
.osgi
.useradmin
.LdifName
.inetOrgPerson
;
4 import static org
.argeo
.osgi
.useradmin
.LdifName
.objectClass
;
5 import static org
.argeo
.osgi
.useradmin
.LdifName
.organizationalPerson
;
6 import static org
.argeo
.osgi
.useradmin
.LdifName
.person
;
7 import static org
.argeo
.osgi
.useradmin
.LdifName
.top
;
11 import java
.net
.URISyntaxException
;
12 import java
.util
.ArrayList
;
13 import java
.util
.Arrays
;
14 import java
.util
.Dictionary
;
15 import java
.util
.Enumeration
;
16 import java
.util
.Hashtable
;
17 import java
.util
.Iterator
;
18 import java
.util
.List
;
20 import javax
.naming
.InvalidNameException
;
21 import javax
.naming
.directory
.Attributes
;
22 import javax
.naming
.directory
.BasicAttribute
;
23 import javax
.naming
.directory
.BasicAttributes
;
24 import javax
.naming
.ldap
.LdapName
;
25 import javax
.naming
.ldap
.Rdn
;
26 import javax
.transaction
.SystemException
;
27 import javax
.transaction
.Transaction
;
28 import javax
.transaction
.TransactionManager
;
30 import org
.apache
.commons
.logging
.Log
;
31 import org
.apache
.commons
.logging
.LogFactory
;
32 import org
.osgi
.framework
.Filter
;
33 import org
.osgi
.framework
.FrameworkUtil
;
34 import org
.osgi
.framework
.InvalidSyntaxException
;
35 import org
.osgi
.service
.useradmin
.Authorization
;
36 import org
.osgi
.service
.useradmin
.Role
;
37 import org
.osgi
.service
.useradmin
.User
;
38 import org
.osgi
.service
.useradmin
.UserAdmin
;
40 /** Base class for a {@link UserDirectory}. */
41 abstract class AbstractUserDirectory
implements UserAdmin
, UserDirectory
{
42 private final static Log log
= LogFactory
.getLog(AbstractUserDirectory
.class);
44 private final Hashtable
<String
, Object
> properties
;
45 private final String baseDn
;
46 private final String userObjectClass
;
47 private final String groupObjectClass
;
49 private final boolean readOnly
;
50 private final URI uri
;
52 private UserAdmin externalRoles
;
53 private List
<String
> indexedUserProperties
= Arrays
54 .asList(new String
[] { LdifName
.uid
.name(), LdifName
.mail
.name(), LdifName
.cn
.name() });
56 private String memberAttributeId
= "member";
57 private List
<String
> credentialAttributeIds
= Arrays
.asList(new String
[] { LdifName
.userPassword
.name() });
59 private TransactionManager transactionManager
;
60 private WcXaResource xaResource
= new WcXaResource(this);
62 AbstractUserDirectory(Dictionary
<String
, ?
> props
) {
63 properties
= new Hashtable
<String
, Object
>();
64 for (Enumeration
<String
> keys
= props
.keys(); keys
.hasMoreElements();) {
65 String key
= keys
.nextElement();
66 properties
.put(key
, props
.get(key
));
69 String uriStr
= UserAdminConf
.uri
.getValue(properties
);
74 uri
= new URI(uriStr
);
75 } catch (URISyntaxException e
) {
76 throw new UserDirectoryException("Badly formatted URI " + uriStr
, e
);
79 baseDn
= UserAdminConf
.baseDn
.getValue(properties
).toString();
80 String readOnlyStr
= UserAdminConf
.readOnly
.getValue(properties
);
81 if (readOnlyStr
== null) {
82 readOnly
= readOnlyDefault(uri
);
83 properties
.put(UserAdminConf
.readOnly
.name(), Boolean
.toString(readOnly
));
85 readOnly
= new Boolean(readOnlyStr
);
87 userObjectClass
= UserAdminConf
.userObjectClass
.getValue(properties
);
88 groupObjectClass
= UserAdminConf
.groupObjectClass
.getValue(properties
);
91 /** Returns the groups this user is a direct member of. */
92 protected abstract List
<LdapName
> getDirectGroups(LdapName dn
);
94 protected abstract Boolean
daoHasRole(LdapName dn
);
96 protected abstract DirectoryUser
daoGetRole(LdapName key
);
98 protected abstract List
<DirectoryUser
> doGetRoles(Filter f
);
104 public void destroy() {
108 boolean isEditing() {
109 return xaResource
.wc() != null;
112 protected UserDirectoryWorkingCopy
getWorkingCopy() {
113 UserDirectoryWorkingCopy wc
= xaResource
.wc();
120 Transaction transaction
;
122 transaction
= transactionManager
.getTransaction();
123 } catch (SystemException e
) {
124 throw new UserDirectoryException("Cannot get transaction", e
);
126 if (transaction
== null)
127 throw new UserDirectoryException("A transaction needs to be active in order to edit");
128 if (xaResource
.wc() == null) {
130 transaction
.enlistResource(xaResource
);
131 } catch (Exception e
) {
132 throw new UserDirectoryException("Cannot enlist " + xaResource
, e
);
138 List
<Role
> getAllRoles(DirectoryUser user
) {
139 List
<Role
> allRoles
= new ArrayList
<Role
>();
141 collectRoles(user
, allRoles
);
144 collectAnonymousRoles(allRoles
);
148 private void collectRoles(DirectoryUser user
, List
<Role
> allRoles
) {
149 for (LdapName groupDn
: getDirectGroups(user
.getDn())) {
150 // TODO check for loops
151 DirectoryUser group
= doGetRole(groupDn
);
153 collectRoles(group
, allRoles
);
157 private void collectAnonymousRoles(List
<Role
> allRoles
) {
158 // TODO gather anonymous roles
163 public Role
getRole(String name
) {
164 return doGetRole(toDn(name
));
167 protected DirectoryUser
doGetRole(LdapName dn
) {
168 UserDirectoryWorkingCopy wc
= getWorkingCopy();
169 DirectoryUser user
= daoGetRole(dn
);
171 if (user
== null && wc
.getNewUsers().containsKey(dn
))
172 user
= wc
.getNewUsers().get(dn
);
173 else if (wc
.getDeletedUsers().containsKey(dn
))
179 @SuppressWarnings("unchecked")
181 public Role
[] getRoles(String filter
) throws InvalidSyntaxException
{
182 UserDirectoryWorkingCopy wc
= getWorkingCopy();
183 Filter f
= filter
!= null ? FrameworkUtil
.createFilter(filter
) : null;
184 List
<DirectoryUser
> res
= doGetRoles(f
);
186 for (Iterator
<DirectoryUser
> it
= res
.iterator(); it
.hasNext();) {
187 DirectoryUser user
= it
.next();
188 LdapName dn
= user
.getDn();
189 if (wc
.getDeletedUsers().containsKey(dn
))
192 for (DirectoryUser user
: wc
.getNewUsers().values()) {
193 if (f
== null || f
.match(user
.getProperties()))
196 // no need to check modified users,
197 // since doGetRoles was already based on the modified attributes
199 return res
.toArray(new Role
[res
.size()]);
203 public User
getUser(String key
, String value
) {
204 // TODO check value null or empty
205 List
<DirectoryUser
> collectedUsers
= new ArrayList
<DirectoryUser
>(getIndexedUserProperties().size());
207 doGetUser(key
, value
, collectedUsers
);
210 DirectoryUser user
= null;
212 user
= (DirectoryUser
) getRole(value
);
214 collectedUsers
.add(user
);
215 } catch (Exception e
) {
219 for (String attr
: getIndexedUserProperties())
220 doGetUser(attr
, value
, collectedUsers
);
222 if (collectedUsers
.size() == 1)
223 return collectedUsers
.get(0);
224 else if (collectedUsers
.size() > 1)
225 log
.warn(collectedUsers
.size() + " users for " + (key
!= null ? key
+ "=" : "") + value
);
229 protected void doGetUser(String key
, String value
, List
<DirectoryUser
> collectedUsers
) {
231 Filter f
= FrameworkUtil
.createFilter("(" + key
+ "=" + value
+ ")");
232 List
<DirectoryUser
> users
= doGetRoles(f
);
233 collectedUsers
.addAll(users
);
234 } catch (InvalidSyntaxException e
) {
235 throw new UserDirectoryException("Cannot get user with " + key
+ "=" + value
, e
);
240 public Authorization
getAuthorization(User user
) {
241 return new LdifAuthorization((DirectoryUser
) user
, getAllRoles((DirectoryUser
) user
));
245 public Role
createRole(String name
, int type
) {
247 UserDirectoryWorkingCopy wc
= getWorkingCopy();
248 LdapName dn
= toDn(name
);
249 if ((daoHasRole(dn
) && !wc
.getDeletedUsers().containsKey(dn
)) || wc
.getNewUsers().containsKey(dn
))
250 throw new UserDirectoryException("Already a role " + name
);
251 BasicAttributes attrs
= new BasicAttributes(true);
252 // attrs.put(LdifName.dn.name(), dn.toString());
253 Rdn nameRdn
= dn
.getRdn(dn
.size() - 1);
254 // TODO deal with multiple attr RDN
255 attrs
.put(nameRdn
.getType(), nameRdn
.getValue());
256 if (wc
.getDeletedUsers().containsKey(dn
)) {
257 wc
.getDeletedUsers().remove(dn
);
258 wc
.getModifiedUsers().put(dn
, attrs
);
260 wc
.getModifiedUsers().put(dn
, attrs
);
261 DirectoryUser newRole
= newRole(dn
, type
, attrs
);
262 wc
.getNewUsers().put(dn
, newRole
);
264 return getRole(name
);
267 protected DirectoryUser
newRole(LdapName dn
, int type
, Attributes attrs
) {
269 BasicAttribute objClass
= new BasicAttribute(objectClass
.name());
270 if (type
== Role
.USER
) {
271 String userObjClass
= newUserObjectClass(dn
);
272 objClass
.add(userObjClass
);
273 if (inetOrgPerson
.name().equals(userObjClass
)) {
274 objClass
.add(organizationalPerson
.name());
275 objClass
.add(person
.name());
276 } else if (organizationalPerson
.name().equals(userObjClass
)) {
277 objClass
.add(person
.name());
279 objClass
.add(top
.name());
281 newRole
= new LdifUser(this, dn
, attrs
);
282 } else if (type
== Role
.GROUP
) {
283 String groupObjClass
= getGroupObjectClass();
284 objClass
.add(groupObjClass
);
285 // objClass.add(LdifName.extensibleObject.name());
286 objClass
.add(top
.name());
288 newRole
= new LdifGroup(this, dn
, attrs
);
290 throw new UserDirectoryException("Unsupported type " + type
);
295 public boolean removeRole(String name
) {
297 UserDirectoryWorkingCopy wc
= getWorkingCopy();
298 LdapName dn
= toDn(name
);
299 boolean actuallyDeleted
;
300 if (daoHasRole(dn
) || wc
.getNewUsers().containsKey(dn
)) {
301 DirectoryUser user
= (DirectoryUser
) getRole(name
);
302 wc
.getDeletedUsers().put(dn
, user
);
303 actuallyDeleted
= true;
304 } else {// just removing from groups (e.g. system roles)
305 actuallyDeleted
= false;
307 for (LdapName groupDn
: getDirectGroups(dn
)) {
308 DirectoryUser group
= doGetRole(groupDn
);
309 group
.getAttributes().get(getMemberAttributeId()).remove(dn
.toString());
311 return actuallyDeleted
;
315 protected void prepare(UserDirectoryWorkingCopy wc
) {
319 protected void commit(UserDirectoryWorkingCopy wc
) {
323 protected void rollback(UserDirectoryWorkingCopy wc
) {
328 protected LdapName
toDn(String name
) {
330 return new LdapName(name
);
331 } catch (InvalidNameException e
) {
332 throw new UserDirectoryException("Badly formatted name", e
);
337 String
getMemberAttributeId() {
338 return memberAttributeId
;
341 List
<String
> getCredentialAttributeIds() {
342 return credentialAttributeIds
;
345 protected URI
getUri() {
349 protected List
<String
> getIndexedUserProperties() {
350 return indexedUserProperties
;
353 protected void setIndexedUserProperties(List
<String
> indexedUserProperties
) {
354 this.indexedUserProperties
= indexedUserProperties
;
357 private static boolean readOnlyDefault(URI uri
) {
360 if (uri
.getScheme().equals("file")) {
361 File file
= new File(uri
);
363 return !file
.canWrite();
365 return !file
.getParentFile().canWrite();
370 public boolean isReadOnly() {
374 UserAdmin
getExternalRoles() {
375 return externalRoles
;
378 public String
getBaseDn() {
382 /** dn can be null, in that case a default should be returned. */
383 protected String
getUserObjectClass() {
384 return userObjectClass
;
387 protected String
newUserObjectClass(LdapName dn
) {
388 return getUserObjectClass();
391 protected String
getGroupObjectClass() {
392 return groupObjectClass
;
395 public Dictionary
<String
, Object
> getProperties() {
399 public void setExternalRoles(UserAdmin externalRoles
) {
400 this.externalRoles
= externalRoles
;
403 public void setTransactionManager(TransactionManager transactionManager
) {
404 this.transactionManager
= transactionManager
;
407 public WcXaResource
getXaResource() {