Changeset 5502

Timestamp:

07/31/14 08:54:11 (10 years ago)

Author:

Twan Goosen

Message:

Refactoring and documentation of reading the admins list
Refs #589

Location:

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry

Files:

• README.txt (modified) (1 diff)
• src/main/java/eu/clarin/cmdi/virtualcollectionregistry/VirtualCollectionRegistry.java (modified) (2 diffs)
• src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/Application.java (modified) (6 diffs)

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/README.txt

@@ -104 +104 @@
 Change the value of the 'value' attribute if desired. If this parameter is not set,
 the default value "CLARIN Virtual Collection Registry" will be used as a collection name.
+
+* ADMINISTRATOR USERS *
+
+Add the following context parameter:
+
+<Parameter
+           name="eu.clarin.cmdi.virtualcollectionregistry.admindb"
+           value="/path/to/vcr-admin.conf" />
+
+Add the username of each user that should get administrator rights to the referenced
+file, one username per line.

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/VirtualCollectionRegistry.java

@@ -3 +3 @@
 import eu.clarin.cmdi.oai.provider.impl.OAIProvider;
 import eu.clarin.cmdi.virtualcollectionregistry.model.User;
+import eu.clarin.cmdi.virtualcollectionregistry.model.User_;
 import eu.clarin.cmdi.virtualcollectionregistry.model.VirtualCollection;
 import eu.clarin.cmdi.virtualcollectionregistry.model.VirtualCollectionList;
@@ -532 +533 @@
     }
 
+    public List<User> getUsers() {
+        final EntityManager em = datastore.getEntityManager();
+        try {
+            final CriteriaBuilder cb = em.getCriteriaBuilder();
+            final CriteriaQuery<User> cq = cb.createQuery(User.class);
+            final Root<User> root = cq.from(User.class);
+
+            // select all users, sort by display name then name
+            cq.select(root);
+            cq.orderBy(
+                    cb.asc(root.get(User_.displayName)),
+                    cb.asc(root.get(User_.name)));
+
+            em.getTransaction().begin();
+            final TypedQuery<User> query = em.createQuery(cq);
+            return query.getResultList();
+        } finally {
+            EntityTransaction tx = em.getTransaction();
+            if ((tx != null) && tx.isActive() && !tx.getRollbackOnly()) {
+                tx.commit();
+            }
+        }
+    }
+
     public List<VirtualCollection> getVirtualCollections(
             int first, int count, QueryOptions options)

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/Application.java

@@ -25 +25 @@
 import org.apache.wicket.session.pagemap.LeastRecentlyAccessedEvictionStrategy;
 import org.apache.wicket.spring.injection.annot.SpringComponentInjector;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
@@ -31 +33 @@
 public class Application extends AuthenticatedWebApplication {
 
+    private final static Logger logger = LoggerFactory.getLogger(Application.class);
+    
     @Autowired
     private VirtualCollectionRegistry registry;
@@ -36 +40 @@
     private DataStore dataStore;
 
-    private static final String CONFIG_PARAM_ADMINDB = "admindb";
-    private final Set<String> adminUsers = new HashSet<String>();
+    private static final String CONFIG_PARAM_ADMINDB = "eu.clarin.cmdi.virtualcollectionregistry.admindb";
+    private final Set<String> adminUsers = new HashSet<>();
 
     @Override
@@ -49 +53 @@
                 loadAdminDatabase(s);
             } catch (IOException e) {
-                // FIXME: handle error
+                throw new RuntimeException("Could not load admin user database", e);
             }
         }
         if (adminUsers.isEmpty()) {
-            // FIXME: better logging
-            System.err.println("WARNING: no admin users have been defined");
+            logger.warn("No admin users have been defined");
+        } else {
+            logger.debug("Admin users: {}", adminUsers);
         }
         getMarkupSettings().setDefaultMarkupEncoding("utf-8");
@@ -61 +66 @@
         getSessionSettings().setPageMapEvictionStrategy(
                 new LeastRecentlyAccessedEvictionStrategy(3));
-        if (getConfigurationType() != DEPLOYMENT) {
+        if (!DEPLOYMENT.equals(getConfigurationType())) {
             getMarkupSettings().setStripWicketTags(true);
             getMarkupSettings().setStripComments(true);
@@ -118 +123 @@
     private void loadAdminDatabase(String filename) throws IOException {
         adminUsers.clear();
-        BufferedReader reader = new BufferedReader(new InputStreamReader(
-                new FileInputStream(filename)));
-        String line;
-        while ((line = reader.readLine()) != null) {
-            line = line.trim();
-            if (line.isEmpty() || line.startsWith("#")) {
-                continue;
-            }
-            adminUsers.add(line);
-        } // while
-        reader.close();
+        try (BufferedReader reader = new BufferedReader(new InputStreamReader(
+                new FileInputStream(filename)))) {
+            String line;
+            while ((line = reader.readLine()) != null) {
+                line = line.trim();
+                if (line.isEmpty() || line.startsWith("#")) {
+                    continue;
+                }
+                adminUsers.add(line);
+            } // while
+        }
     }