Changeset 509

Timestamp:

06/15/10 18:40:09 (14 years ago)

Author:

oschonef

Message:

• delayed purging of deleted virtual collections
• deny deleting public virtual collections
• add some JPA locking
• re-work relations between entities

Location:

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

Files:

• VirtualCollectionRegistry.java (modified) (7 diffs)
• model/PersistentIdentifier.java (modified) (7 diffs)
• model/Resource.java (modified) (1 diff)
• model/VirtualCollection.java (modified) (9 diffs)

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

@@ -3 +3 @@
 import java.security.Principal;
 import java.util.Collections;
+import java.util.Date;
 import java.util.List;
 import java.util.Map;
@@ -10 +11 @@
 
 import javax.persistence.EntityManager;
-import javax.persistence.EntityTransaction;
+import javax.persistence.LockModeType;
 import javax.persistence.NoResultException;
+import javax.persistence.PersistenceException;
 import javax.persistence.TypedQuery;
 
@@ -73 +75 @@
                 @Override
                 public void run() {
-                    assignPersistentId();
-                }
-            }, 60000, 60000);
+                    maintenance(this.scheduledExecutionTime());
+                }
+            }, 1000, 1000);
             this.intialized.set(true);
             logger.info("virtual collection registry successfully intialized");
@@ -189 +191 @@
                         principal.getName() + "\"");
             }
+            em.lock(c, LockModeType.WRITE);
             c.updateFrom(vc);
             validator.validate(c);
@@ -227 +230 @@
             }
             if (!vc.getOwner().equalsPrincipal(principal)) {
+                logger.debug("virtual collection (id={}) not owned by " +
+                        "user '{}'", id, principal.getName());
                 throw new VirtualCollectionRegistryPermissionException(
-                        "permission denied for user \"" + principal.getName() +
-                                "\"");
-            }
-            em.remove(vc);
+                        "permission denied for user \"" +
+                        principal.getName() + "\"");
+            }
+            if (vc.getState() != VirtualCollection.State.PRIVATE) {
+                logger.debug("virtual collection (id={}) cannot be " +
+                        "deleted (invalid state)", id);
+                throw new VirtualCollectionRegistryPermissionException(
+                        "virtual collection cannot be deleted");
+            }
+            em.lock(vc, LockModeType.WRITE);
+            vc.setState(VirtualCollection.State.DELETED);
             em.getTransaction().commit();
             return vc.getId();
@@ -267 +279 @@
         } catch (VirtualCollectionRegistryException e) {
             throw e;
-        } catch (Exception e) {
-            logger.error("error while retrieving virtual collection", e);
-            throw new VirtualCollectionRegistryException(
-                    "error while retrieving virtual collection", e);
-        }
-    }
-
-    /*
-     * FIXME: following method is broken, due to pid/uuid changes 
-     */
-    public VirtualCollection retrieveVirtualCollection(String uuid)
-            throws VirtualCollectionRegistryException {
-        if (uuid == null) {
-            throw new NullPointerException("uuid == null");
-        }
-        uuid = uuid.trim();
-        if (uuid.isEmpty()) {
-            throw new IllegalArgumentException("uuid is empty");
-        }
-
-        logger.debug("retrieve virtual collection (uuid={})", uuid);
-
-        try {
-            EntityManager em = datastore.getEntityManager();
-            em.getTransaction().begin();
-            TypedQuery<VirtualCollection> q =
-                em.createNamedQuery("VirtualCollection.byUUID",
-                                    VirtualCollection.class);
-            q.setParameter("uuid", uuid);
-            VirtualCollection vc = q.getSingleResult();
-            em.getTransaction().commit();
-            return vc;
-        } catch (NoResultException e) {
-            logger.debug("virtual collection (uuid={}) not found", uuid);
-            throw new VirtualCollectionNotFoundException(uuid);
         } catch (Exception e) {
             logger.error("error while retrieving virtual collection", e);
@@ -419 +396 @@
     }
 
-    private void assignPersistentId() {
+    private void maintenance(long now) {
+        final Date nowDateAlloc = new Date(now - 30*1000);
+        final Date nowDatePurge = new Date(now - 30*1000);
+        
         EntityManager em = datastore.getEntityManager();
-        em.getTransaction().begin();
-        try {
+        try {
+            /*
+             * delayed allocation of persistent identifier
+             */
+            em.getTransaction().begin();
             TypedQuery<VirtualCollection> q =
-                em.createNamedQuery("VirtualCollection.findAllInit",
+                em.createNamedQuery("VirtualCollection.findAllByState",
                                     VirtualCollection.class);
+            q.setParameter("state", VirtualCollection.State.PUBLIC_PENDING);
+            q.setParameter("date", nowDateAlloc);
             for (VirtualCollection vc : q.getResultList()) {
-                if (vc.getState() != VirtualCollection.State.INIT) {
+                try {
+                    em.lock(vc, LockModeType.WRITE);
+                } catch (PersistenceException e) {
+                    logger.debug("error locking virtual collection (vc={})", vc.getId());
                     continue;
                 }
                 PersistentIdentifier pid = pid_provider.createIdentifier(vc);
                 vc.setPersistentIdentifier(pid);
-                vc.setState(VirtualCollection.State.PRIVATE);
+                vc.setState(VirtualCollection.State.PUBLIC);
                 em.persist(vc);
                 logger.debug("assigned pid (identifer='{}') to virtual" +
-                        "collection (id={})", pid.getIdentifier(), vc.getId());
-            }
-            em.getTransaction().commit();
-        } catch (Exception e) {
-            logger.error("error while assigning persistent identifier", e);
-            EntityTransaction tx = em.getTransaction();
-            if (tx.isActive()) {
-                em.getTransaction().rollback();
-            }
+                        "collection (id={})",
+                        vc.getPersistentIdentifier().getIdentifier(),
+                        vc.getId());
+            }
+            em.getTransaction().commit();
+            
+            /*
+             * delayed purging of deleted virtual collections 
+             */
+            em.getTransaction().begin();
+            q.setParameter("state", VirtualCollection.State.DELETED);
+            q.setParameter("date", nowDatePurge);
+            for (VirtualCollection vc : q.getResultList()) {
+                try {
+                    em.lock(vc, LockModeType.WRITE);
+                } catch (PersistenceException e) {
+                    logger.debug("error locking virtual collection (vc={})", vc.getId());
+                    continue;
+                }
+                vc.setState(VirtualCollection.State.DEAD);
+                em.remove(vc);
+                logger.debug("purged virtual collection (id={})", vc.getId());
+            }
+            em.getTransaction().commit();
+        } catch (Exception e) {
+            logger.error("error while doing maintenance", e);
+        } finally {
+            datastore.closeEntityManager();
         }
     }

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

@@ -1 +1 @@
 package eu.clarin.cmdi.virtualcollectionregistry.model;
-
-import java.util.Date;
 
 import javax.persistence.Column;
@@ -7 +5 @@
 import javax.persistence.EnumType;
 import javax.persistence.Enumerated;
-import javax.persistence.FetchType;
 import javax.persistence.GeneratedValue;
 import javax.persistence.GenerationType;
 import javax.persistence.Id;
 import javax.persistence.OneToOne;
+import javax.persistence.PrimaryKeyJoinColumn;
 import javax.persistence.Table;
-import javax.persistence.Temporal;
-import javax.persistence.TemporalType;
-import javax.persistence.Version;
+
+import org.apache.commons.lang.NullArgumentException;
 
 @Entity
@@ -26 +23 @@
     @Id
     @GeneratedValue(strategy = GenerationType.AUTO)
-    @Column(name = "id")
+    @Column(name = "id", nullable = false)
     private long id = -1;
-    @OneToOne(fetch = FetchType.EAGER,
-              optional = false)
-    private VirtualCollection collection;
+    @OneToOne(optional = false)
+    @PrimaryKeyJoinColumn
+    private VirtualCollection vc;
     @Column(name = "type")
     @Enumerated(EnumType.ORDINAL)
@@ -36 +33 @@
     @Column(name = "identifier",
             nullable = false,
-            updatable = false,
             unique = true)
     private String identifier;
-    @Column(name = "last_modified",
-            nullable = false)
-    @Temporal(TemporalType.TIMESTAMP)
-    @Version
-    private Date lastModifed;
 
     private PersistentIdentifier() {
     }
 
-    PersistentIdentifier(VirtualCollection collection, Type type,
-            String identifier) {
+    PersistentIdentifier(VirtualCollection vc, Type type, String identifier) {
         this();
-        if (collection == null) {
-            throw new NullPointerException("collection == null");
+        if (vc == null) {
+            throw new NullArgumentException("vc == null");
         }
         if (type == null) {
@@ -64 +54 @@
             throw new IllegalArgumentException("identifier is empty");
         }
-        this.collection = collection;
+        this.vc = vc;
         this.type = type;
         this.identifier = identifier;
@@ -74 +64 @@
 
     public VirtualCollection getVirtualCollection() {
-        return collection;
+        return vc;
     }
 
@@ -83 +73 @@
     public String getIdentifier() {
         return identifier;
-    }
-
-    public Date getLastModified() {
-        return lastModifed;
     }
 

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

@@ -26 +26 @@
     @GeneratedValue(strategy = GenerationType.AUTO)
     @Column(name = "id",
-            nullable = false,
-            updatable = false,
-            insertable = true)
+            nullable = false)
     private long id = -1;
     @Column(name = "type",

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

@@ -52 +52 @@
                             "WHERE c.state = eu.clarin.cmdi." +
                             "virtualcollectionregistry.model." +
-                            "VirtualCollection$State.PUBLIC"),
+                            "VirtualCollection$State.PUBLIC " +
+                            "ORDER BY c.id"),
         @NamedQuery(name = "VirtualCollection.countAllPublic",
                     query = "SELECT COUNT(c) FROM VirtualCollection c " +
@@ -60 +61 @@
         @NamedQuery(name = "VirtualCollection.findByOwner",
                     query = "SELECT c FROM VirtualCollection c " +
-                            "WHERE c.owner = :owner"),
+                            "WHERE c.owner = :owner ORDER BY c.id"),
         @NamedQuery(name = "VirtualCollection.countByOwner",
                     query = "SELECT COUNT(c) FROM VirtualCollection c " +
                             "WHERE c.owner = :owner"),
-        @NamedQuery(name = "VirtualCollection.findAllInit",
+        @NamedQuery(name = "VirtualCollection.findAllByState",
                     query = "SELECT c FROM VirtualCollection c " +
-                            "WHERE c.state = eu.clarin.cmdi." +
-                            "virtualcollectionregistry.model." +
-                            "VirtualCollection$State.INIT")
+                            "WHERE c.state = :state AND c.modifedDate < :date")
 })
 @XmlRootElement(name = "VirtualCollection")
@@ -81 +80 @@
     @XmlEnum(String.class)
     public static enum State {
+        @XmlEnumValue("private")
+        PRIVATE,
+        @XmlEnumValue("public-pending")
+        PUBLIC_PENDING,
+        @XmlEnumValue("public")
+        PUBLIC,
         @XmlEnumValue("deleted")
         DELETED,
-        @XmlEnumValue("initialized")
-        INIT,
-        @XmlEnumValue("public")
-        PUBLIC,
-        @XmlEnumValue("private")
-        PRIVATE
+        @XmlEnumValue("dead")
+        DEAD
     } // enum State
     @XmlType(namespace = "urn:x-vcr:virtualcollection:visibility")
@@ -120 +121 @@
             nullable = false)
     @Enumerated(EnumType.ORDINAL)
-    private State state = State.INIT;
-    @OneToOne(cascade = { CascadeType.PERSIST,
-                          CascadeType.REFRESH,
-                          CascadeType.MERGE },
+    private State state = State.PRIVATE;
+    @OneToOne(optional = true,
+              orphanRemoval = true,
+              cascade = CascadeType.ALL,
               fetch = FetchType.EAGER,
-              orphanRemoval = true,
-              optional = true,
-              mappedBy = "collection")
+              mappedBy = "vc")
     private PersistentIdentifier pid;
     @Column(name = "name",
@@ -148 +147 @@
     private Creator creator;
     @OneToMany(cascade = CascadeType.ALL,
-               fetch = FetchType.LAZY,
-               orphanRemoval = true)
+               fetch = FetchType.LAZY)
     @JoinColumn(name = "vc_id",
                 nullable = false)
@@ -174 +172 @@
             throw new NullPointerException("state == null");
         }
-        boolean valid;
-        switch (this.state) {
-        case INIT:
-            valid = (state == State.PRIVATE);
-            break;
-        case PRIVATE:
-            valid = (state == State.PUBLIC) || (state == State.DELETED);
-            break;
-        default:
-            valid = false;
-        } // switch
-        if (valid) {
-            this.state = state;
-        } else {
-            throw new IllegalStateException("invalid transition from " +
-                    this.state + " to " + state);
+        if (this.state != state) {
+            boolean valid = false;
+            switch (this.state) {
+            case PRIVATE:
+                valid = (state == State.PUBLIC) || (state == State.DELETED);
+                break;
+            case DELETED:
+                valid = (state == State.PRIVATE) || (state == State.DEAD);
+                break;
+            default:
+                /* NOTHING */
+            } // switch
+            if (valid) {
+                this.state = state;
+            } else {
+                throw new IllegalStateException("invalid transition from " +
+                        this.state + " to " + state);
+            }
         }
     }
@@ -213 +213 @@
             throw new NullPointerException("pid == null");
         }
+        if ((this.pid != null) || (state != State.PUBLIC_PENDING)) {
+            throw new IllegalStateException("illegal state");
+        }
         this.pid = pid;
+        this.state = State.PUBLIC;
     }
 
@@ -220 +224 @@
     }
 
-    @SuppressWarnings("unused")
     @XmlAttribute(name = "persistentId")
-    private String getXmlPersitentId() {
+    public String getPersistentIdentifierForXml() {
         if (pid != null) {
             return pid.getIdentifier();
@@ -330 +333 @@
             return;
         }
+        this.setState(state);
         this.setName(vc.getName());
+        if (vc.getPersistentIdentifier() != null) {
+            this.setPersistentIdentifier(vc.getPersistentIdentifier());
+        }
         this.setDescription(vc.getDescription());
         this.setCreationDate(vc.getCreationDate());