org.argeo.cms.e4/src/org/argeo/cms/e4/users/UserAdminWrapper.java

   1 package org.argeo.cms.e4.users;
   2
   3 import java.util.ArrayList;
   4 import java.util.Collections;
   5 import java.util.Dictionary;
   6 import java.util.HashMap;
   7 import java.util.List;
   8 import java.util.Map;
   9 import java.util.Set;
  10 import java.util.TreeSet;
  11
  12 import javax.transaction.Status;
  13 import javax.transaction.UserTransaction;
  14
  15 import org.argeo.cms.CmsException;
  16 import org.argeo.node.NodeConstants;
  17 import org.argeo.osgi.useradmin.UserAdminConf;
  18 import org.osgi.service.useradmin.UserAdmin;
  19 import org.osgi.service.useradmin.UserAdminEvent;
  20 import org.osgi.service.useradmin.UserAdminListener;
  21
  22 /** Centralise interaction with the UserAdmin in this bundle */
  23 public class UserAdminWrapper {
  24
  25         private UserAdmin userAdmin;
  26         // private ServiceReference<UserAdmin> userAdminServiceReference;
  27         private Set<String> uris;
  28         private UserTransaction userTransaction;
  29
  30         // First effort to simplify UX while managing users and groups
  31         public final static boolean COMMIT_ON_SAVE = true;
  32
  33         // Registered listeners
  34         List<UserAdminListener> listeners = new ArrayList<UserAdminListener>();
  35
  36         /**
  37          * Starts a transaction if necessary. Should always been called together with
  38          * {@link UserAdminWrapper#commitOrNotifyTransactionStateChange()} once the
  39          * security model changes have been performed.
  40          */
  41         public UserTransaction beginTransactionIfNeeded() {
  42                 try {
  43                         // UserTransaction userTransaction = getUserTransaction();
  44                         if (userTransaction.getStatus() == Status.STATUS_NO_TRANSACTION) {
  45                                 userTransaction.begin();
  46                                 // UiAdminUtils.notifyTransactionStateChange(userTransaction);
  47                         }
  48                         return userTransaction;
  49                 } catch (Exception e) {
  50                         throw new CmsException("Unable to begin transaction", e);
  51                 }
  52         }
  53
  54         /**
  55          * Depending on the current application configuration, it will either commit the
  56          * current transaction or throw a notification that the transaction state has
  57          * changed (In the later case, it must be called from the UI thread).
  58          */
  59         public void commitOrNotifyTransactionStateChange() {
  60                 try {
  61                         // UserTransaction userTransaction = getUserTransaction();
  62                         if (userTransaction.getStatus() == Status.STATUS_NO_TRANSACTION)
  63                                 return;
  64
  65                         if (UserAdminWrapper.COMMIT_ON_SAVE)
  66                                 userTransaction.commit();
  67                         else
  68                                 UiAdminUtils.notifyTransactionStateChange(userTransaction);
  69                 } catch (Exception e) {
  70                         throw new CmsException("Unable to clean transaction", e);
  71                 }
  72         }
  73
  74         // TODO implement safer mechanism
  75         public void addListener(UserAdminListener userAdminListener) {
  76                 if (!listeners.contains(userAdminListener))
  77                         listeners.add(userAdminListener);
  78         }
  79
  80         public void removeListener(UserAdminListener userAdminListener) {
  81                 if (listeners.contains(userAdminListener))
  82                         listeners.remove(userAdminListener);
  83         }
  84
  85         public void notifyListeners(UserAdminEvent event) {
  86                 for (UserAdminListener listener : listeners)
  87                         listener.roleChanged(event);
  88         }
  89
  90         public Map<String, String> getKnownBaseDns(boolean onlyWritable) {
  91                 Map<String, String> dns = new HashMap<String, String>();
  92                 for (String uri : uris) {
  93                         if (!uri.startsWith("/"))
  94                                 continue;
  95                         Dictionary<String, ?> props = UserAdminConf.uriAsProperties(uri);
  96                         String readOnly = UserAdminConf.readOnly.getValue(props);
  97                         String baseDn = UserAdminConf.baseDn.getValue(props);
  98
  99                         if (onlyWritable && "true".equals(readOnly))
 100                                 continue;
 101                         if (baseDn.equalsIgnoreCase(NodeConstants.ROLES_BASEDN))
 102                                 continue;
 103                         dns.put(baseDn, uri);
 104                 }
 105                 return dns;
 106         }
 107
 108         public UserAdmin getUserAdmin() {
 109                 return userAdmin;
 110         }
 111
 112         public UserTransaction getUserTransaction() {
 113                 return userTransaction;
 114         }
 115
 116         /* DEPENDENCY INJECTION */
 117         public void setUserAdmin(UserAdmin userAdmin, Map<String, String> properties) {
 118                 this.userAdmin = userAdmin;
 119                 this.uris = Collections.unmodifiableSortedSet(new TreeSet<>(properties.keySet()));
 120         }
 121
 122         public void setUserTransaction(UserTransaction userTransaction) {
 123                 this.userTransaction = userTransaction;
 124         }
 125
 126         // public void setUserAdminServiceReference(
 127         // ServiceReference<UserAdmin> userAdminServiceReference) {
 128         // this.userAdminServiceReference = userAdminServiceReference;
 129         // }
 130 }