git.aero2k.de Git - tmp/jakarta-migration.git/blob

   1 package org.collectionspace.services.listener;
   2
   3 import java.util.ArrayList;
   4 import java.util.IllegalFormatException;
   5 import java.util.List;
   6 import org.apache.commons.logging.Log;
   7 import org.apache.commons.logging.LogFactory;
   8 import org.collectionspace.services.client.workflow.WorkflowClient;
   9 import org.nuxeo.ecm.core.api.ClientException;
  10 import org.nuxeo.ecm.core.api.CoreSession;
  11 import org.nuxeo.ecm.core.api.DocumentModel;
  12 import org.nuxeo.ecm.core.api.DocumentModelList;
  13 import org.nuxeo.ecm.core.api.impl.LifeCycleFilter;
  14 import org.nuxeo.ecm.core.event.Event;
  15 import org.nuxeo.ecm.core.event.EventContext;
  16 import org.nuxeo.ecm.core.event.EventListener;
  17 import org.nuxeo.ecm.core.event.impl.DocumentEventContext;
  18
  19 public class UpdateRelationsOnDelete implements EventListener {
  20
  21     // FIXME: Get these constant values from external sources rather than redeclaring here
  22     final static String RELATIONS_COMMON_SUBJECT_CSID_FIELD = "relations_common:subjectCsid";
  23     final static String RELATIONS_COMMON_OBJECT_CSID_FIELD = "relations_common:objectCsid";
  24
  25     // FIXME: We might experiment here with using log4j instead of Apache Commons Logging;
  26     // am using the latter to follow Ray's pattern for now
  27     final Log logger = LogFactory.getLog(UpdateRelationsOnDelete.class);
  28
  29     @Override
  30     public void handleEvent(Event event) throws ClientException {
  31         logger.trace("In handleEvent in UpdateRelationsOnDelete ...");
  32
  33         EventContext eventContext = event.getContext();
  34
  35         if (isDocumentSoftDeletedEvent(eventContext)) {
  36
  37             logger.trace("A soft deletion event was received by UpdateRelationsOnDelete ...");
  38
  39             DocumentEventContext docContext = (DocumentEventContext) eventContext;
  40             DocumentModel docModel = docContext.getSourceDocument();
  41
  42             // Retrieve a list of relation records, where the soft deleted
  43             // document provided in the context of the current event is
  44             // either the subject or object of any relation
  45
  46             // Build a query string
  47             String csid = docModel.getName();
  48
  49             String queryString;
  50             try {
  51                 queryString =
  52                     String.format("SELECT * FROM Relation WHERE ecm:isProxy = 0 AND (%1$s='%3$s' OR %2$s='%3$s')",
  53                     RELATIONS_COMMON_SUBJECT_CSID_FIELD, RELATIONS_COMMON_OBJECT_CSID_FIELD, csid);
  54                 logger.trace("Query string=" + queryString);
  55             } catch (IllegalFormatException ife) {
  56                 logger.warn("Construction of formatted query string failed: ", ife);
  57                 logger.warn("Actions in this event listener will NOT be performed, as a result of a previous Exception.");
  58                 return;
  59             }
  60
  61             // Create a filter to exclude from the list results any records
  62             // that have already been soft deleted or are locked
  63             List<String> workflowStatesToFilter = new ArrayList<String>();
  64             workflowStatesToFilter.add(WorkflowClient.WORKFLOWSTATE_DELETED);
  65             workflowStatesToFilter.add(WorkflowClient.WORKFLOWSTATE_LOCKED);
  66             LifeCycleFilter workflowStateFilter = new LifeCycleFilter(null, workflowStatesToFilter);
  67
  68             // Perform the filtered query
  69             CoreSession session = docModel.getCoreSession();
  70             DocumentModelList matchingDocuments;
  71             try {
  72                 matchingDocuments = session.query(queryString.toString(), workflowStateFilter);
  73             } catch (ClientException ce) {
  74                 logger.warn("Error attempting to retrieve relation records where "
  75                         + "record of type '" + docModel.getType() + "' with CSID " + csid
  76                         + " is the subject or object of any relation: " + ce.getMessage());
  77                 throw ce;
  78             }
  79
  80             // Cycle through the list results, soft deleting each matching relation record
  81             logger.info("Attempting to soft delete " + matchingDocuments.size() + " relation records pertaining to a soft deleted record.");
  82             for (DocumentModel doc : matchingDocuments) {
  83                 doc.followTransition(WorkflowClient.WORKFLOWTRANSITION_DELETE);
  84             }
  85
  86         }
  87
  88     }
  89
  90     // FIXME: Generic methods like the following might be split off
  91     // into an event utilities class. - ADR 2012-12-05
  92
  93     /**
  94      * Identifies whether a supplied event concerns a document that has
  95      * been transitioned to the 'deleted' workflow state.
  96      *
  97      * @param eventContext an event context
  98      *
  99      * @return true if this event concerns a document that has
 100      * been transitioned to the 'deleted' workflow state.
 101      */
 102     private boolean isDocumentSoftDeletedEvent(EventContext eventContext) {
 103         boolean isSoftDeletedEvent = false;
 104         if (eventContext instanceof DocumentEventContext) {
 105             if (eventContext.getProperties().containsKey(WorkflowClient.WORKFLOWTRANSITION_TO)
 106                     && eventContext.getProperties().get(WorkflowClient.WORKFLOWTRANSITION_TO).equals(WorkflowClient.WORKFLOWSTATE_DELETED)) {
 107                 isSoftDeletedEvent = true;
 108             }
 109         }
 110         return isSoftDeletedEvent;
 111     }
 112
 113 }