Added consumerRequested flag to DAO layer and services.

Author: Joerg Huber

SIF3InfraREST/sif3Common/src/main/java/sif3/common/persist/dao/JobDAO.java

@@ -41,6 +41,7 @@
 import sif3.common.persist.common.BasicTransaction;
 import sif3.common.persist.model.SIF3Job;
 import sif3.common.persist.model.SIF3JobEvent;
+import sif3.common.persist.model.SIF3JobEvent.JobEventType;
 
 /**
  * @author Joerg Huber
@@ -605,6 +606,7 @@ public List<SIF3JobEvent> getJobEventsByUUID(BasicTransaction tx, String uuid, A
      * 
      * A few values will be defaulted if they are not set.<br/>
      * - toFingerPrintOnly defaults to TRUE: Only the consumer with that fingerprint will receive the event.
+     * - consumerRequested defaults to TRUE: Event was caused by consumer requested operation on job.
      * - fullUpdate defaults to TRUE: it is assumed that the entire Job Object is provided in case of an update event.<br/><br/>
      * 
      * The following values will be ignored and defaulted. The returned object will have them populated as followed:<br/>
@@ -712,14 +714,15 @@ else if ("U".equalsIgnoreCase(jobEvent.getEventType()))
      * @param job The job based on which an event shall be created. If null then no event is created and null is returned.
      * @param eventType The event type (CREATE, UPDATE, DELETE).
      * @param fingerprintOnly Indicating if the event is for the 'fingerprint' consumer only.
+     * @param consumerRequested Indicating if the event is caused by consumer requested operation on job.
      * 
      * @return The newly created job event. This has now the internalID and the event date and published populated. 
      *         The published will be set to FALSE and the event date will be set to current datetime.
      * 
      * @throws IllegalArgumentException If the tx is null or any of the rules listed above are not met.
      * @throws PersistenceException Could not access underlying data store.
      */
-    public SIF3JobEvent createJobEvent(BasicTransaction tx, SIF3Job job, EventAction eventType, boolean fingerprintOnly) throws IllegalArgumentException, PersistenceException
+    public SIF3JobEvent createJobEvent(BasicTransaction tx, SIF3Job job, EventAction eventType, boolean fingerprintOnly, boolean consumerRequested) throws IllegalArgumentException, PersistenceException
     {
         if (tx == null)
         {
@@ -728,7 +731,7 @@ public SIF3JobEvent createJobEvent(BasicTransaction tx, SIF3Job job, EventAction
 
         if (job != null)
         {
-             return createJobEvent(tx, new SIF3JobEvent(job, eventType, fingerprintOnly));           
+             return createJobEvent(tx, new SIF3JobEvent(job, eventType, fingerprintOnly, consumerRequested));           
         }
         else
         {
@@ -875,22 +878,91 @@ public List<SIF3JobEvent> retrieveJobEventsSince(BasicTransaction tx, Date chang
             criteria.addOrder(Order.asc("eventDate"));
 
             @SuppressWarnings("unchecked")
-            List<SIF3JobEvent> jobEventss = criteria.list();
+            List<SIF3JobEvent> jobEvents = criteria.list();
 
             // Just in case test for null....
-            if (jobEventss == null)
+            if (jobEvents == null)
             {
-                jobEventss = new ArrayList<SIF3JobEvent>();
+                jobEvents = new ArrayList<SIF3JobEvent>();
             }
 
-            return jobEventss;
+            return jobEvents;
         }
         catch (HibernateException e)
         {
             throw new PersistenceException("Unable to retrieve Job Events since "+DateUtils.dateToString(changesSince, DateUtils.DISP_DATE_TIME_SEC)+" for fingerprint = '"+ fingerprint + ", zoneID = " + zoneID + ", contextID = "+ contextID + ", adapterType = '" + adapterType + "' and pagingInfo = "+pagingInfo+".", e);
         } 
-        
     }
 
-    
+    /*
+     *
+     */
+    public List<SIF3JobEvent> retrieveJobEvents(BasicTransaction tx, 
+                                                Date eventsBefore, 
+                                                String serviceName, 
+                                                AdapterType adapterType, 
+                                                JobEventType eventType, 
+                                                boolean includeConsumeRequested) throws IllegalArgumentException, PersistenceException
+    {
+        if (tx == null)
+        {
+            throw new IllegalArgumentException("Current transaction is null.");
+        }
+        if (adapterType == null)
+        {
+          throw new IllegalArgumentException("adapterType is null.");          
+        }
+        if (StringUtils.isEmpty(serviceName))
+        {
+          throw new IllegalArgumentException("serviceName is null or empty.");          
+        }
+        if (eventsBefore == null)
+        {
+          throw new IllegalArgumentException("eventsBefore is null.");          
+        }
+        if (eventType == null)
+        {
+          throw new IllegalArgumentException("eventType is null.");          
+        }
+
+        try
+        {
+            Criteria criteria = tx.getSession().createCriteria(SIF3JobEvent.class);
+            
+            criteria = criteria.add(Restrictions.le("eventDate", eventsBefore));
+            criteria = criteria.add(Restrictions.eq("adapterType", adapterType.name()));
+            criteria = criteria.add(Restrictions.eq("serviceName", serviceName));
+            criteria = criteria.add(Restrictions.eq("eventType", eventType.name()));
+            
+            if (!includeConsumeRequested) // only get provider initiated events
+            {
+                criteria = criteria.add(Restrictions.eq("consumerRequested", false));
+            }
+            
+            criteria = criteria.add(Restrictions.eq("published", false));
+           
+            
+            //Add orderBy to ensure consistent results
+            criteria.addOrder(Order.asc("zoneID")).addOrder(Order.asc("contextID")).addOrder(Order.asc("fingerprint")).addOrder(Order.asc("internalID"));
+           
+            @SuppressWarnings("unchecked")
+            List<SIF3JobEvent> jobEvents = criteria.list();
+            
+            // Just in case test for null....
+            if (jobEvents == null)
+            {
+                jobEvents = new ArrayList<SIF3JobEvent>();
+            }
+            
+            return jobEvents;
+        }
+        catch (HibernateException e)
+        {
+            throw new PersistenceException("Unable to retrieve Job Events for events before "+
+                                           DateUtils.dateToString(eventsBefore, DateUtils.DISP_DATE_TIME_SEC)+
+                                           " for adapterType = '" + adapterType + 
+                                           "', serviceName = '" + serviceName + 
+                                           "', eventType = '" + eventType + "'.", e);
+        } 
+    }
 }

SIF3InfraREST/sif3Common/src/main/java/sif3/common/persist/model/SIF3Infra.hbm.xml

@@ -184,6 +184,7 @@
         <property name="eventType" column="EVENT_TYPE" type="string" length="1"/>
         <property name="fullUpdate" column="FULL_UPDATE" type="boolean"/>
         <property name="toFingerPrintOnly" column="TO_FINGERPRINT_ONLY" type="boolean"/>
+        <property name="consumerRequested" column="CONSUMER_REQUESTED" type="boolean"/>
         <property name="published" column="EVENT_PUBLISHED" type="boolean"/>
         <property name="publishedDate" column="PUBLISHED_DATETIME" type="timestamp"/>
         <property name="jobXML" column="JOB_XML" type="text"/>

SIF3InfraREST/sif3Common/src/main/java/sif3/common/persist/model/SIF3JobEvent.java

@@ -36,6 +36,7 @@ public static enum JobEventType {U, C, D};
     private String eventType = null; // U=Update, C=Create, D=Delete
     private boolean fullUpdate = Boolean.TRUE; // TRUE = Update event is full update; FALSE = Update is partial
     private boolean toFingerPrintOnly = Boolean.TRUE; // TRUE = Include fingerprint in event; FALSE = May not include fingerprint
+    private boolean consumerRequested = Boolean.TRUE; // TRUE = consumer requested an operation on the job
     private boolean published = Boolean.FALSE; // TRUE = Event is already published; FALSE = Event isn't published, yet.
     private Date publishedDate = null; // Date when event has been sent/published to event end-point.
 
@@ -44,7 +45,16 @@ public SIF3JobEvent()
         super();
     }
 
-    public SIF3JobEvent(SIF3Job job, EventAction eventType, boolean fingerprintOnly)
+    /**
+     * Creates a Job Event object for the given event type. It will set the fingerprint only and consumerRequested
+     * flags as given.
+     * 
+     * @param job Create an event with the data of the job.
+     * @param eventType The event type for this job event.
+     * @param fingerprintOnly TRUE then job event will be sent to fingerprint only (not yet used)
+     * @param consumerRequested Event was due to a consumer requested action on the job object.
+     */
+    public SIF3JobEvent(SIF3Job job, EventAction eventType, boolean fingerprintOnly, boolean consumerRequested)
     {
         if (job != null)
         {
@@ -57,6 +67,7 @@ public SIF3JobEvent(SIF3Job job, EventAction eventType, boolean fingerprintOnly)
             setJobXML(job.getJobXML());
             setFingerprint(job.getFingerprint());
             setToFingerPrintOnly(fingerprintOnly);
+            setConsumerRequested(consumerRequested);
             setEventDate(new Date());
             setEventType(eventType.name().substring(0, 1));
             setFullUpdate(true);
@@ -109,6 +120,16 @@ public void setToFingerPrintOnly(boolean toFingerPrintOnly)
         this.toFingerPrintOnly = toFingerPrintOnly;
     }
 
+    public boolean isConsumerRequested()
+    {
+        return consumerRequested;
+    }
+
+    public void setConsumerRequested(boolean consumerRequested)
+    {
+        this.consumerRequested = consumerRequested;
+    }
+
     public boolean isPublished()
     {
         return published;
@@ -133,8 +154,8 @@ public void setPublishedDate(Date publishedDate)
     public String toString()
     {
         return "SIF3JobEvent [eventDate=" + eventDate + ", eventType=" + eventType + ", fullUpdate="
-                + fullUpdate + ", toFingerPrintOnly=" + toFingerPrintOnly + ", published="
-                + published + ", publishedDate=" + publishedDate + ", toString()="
-                + super.toString() + "]";
+                + fullUpdate + ", toFingerPrintOnly=" + toFingerPrintOnly + ", consumerRequested="
+                + consumerRequested + ", published=" + published + ", publishedDate="
+                + publishedDate + ", toString()=" + super.toString() + "]";
     }
 }

SIF3InfraREST/sif3Common/src/main/java/sif3/common/persist/service/JobService.java

@@ -17,6 +17,7 @@
  */
 package sif3.common.persist.service;
 
+import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 
@@ -31,6 +32,7 @@
 import sif3.common.persist.model.JobTemplate;
 import sif3.common.persist.model.SIF3Job;
 import sif3.common.persist.model.SIF3JobEvent;
+import sif3.common.persist.model.SIF3JobEvent.JobEventType;
 
 /**
  * @author Joerg Huber
@@ -442,22 +444,23 @@ public SIF3JobEvent createJobEvent(SIF3JobEvent jobEvent) throws IllegalArgument
      * @param job The job based on which an event shall be created. If null then no event is created and null is returned.
      * @param eventType The event type (CREATE, UPDATE, DELETE).
      * @param fingerprintOnly Indicating if the event is for the 'fingerprint' consumer only.
+     * @param consumerRequested Indicating if the event is caused by consumer requested operation on job.
      * 
      * @return The newly created job event. This has now the internalID and the event date and published populated. 
      *         The published will be set to FALSE and the event date will be set to current datetime.
      * 
      * @throws IllegalArgumentException If the tx is null or any of the rules listed above are not met.
      * @throws PersistenceException Could not access underlying data store.
      */
-    public SIF3JobEvent createJobEvent(SIF3Job job, EventAction eventType, boolean fingerprintOnly) throws IllegalArgumentException, PersistenceException
+    public SIF3JobEvent createJobEvent(SIF3Job job, EventAction eventType, boolean fingerprintOnly, boolean consumerRequested) throws IllegalArgumentException, PersistenceException
     {
         SIF3JobEvent row = null;
         BasicTransaction tx = null;
 
         try
         {
             tx = startTransaction();
-            row = jobDAO.createJobEvent(tx, job, eventType, fingerprintOnly);
+            row = jobDAO.createJobEvent(tx, job, eventType, fingerprintOnly, consumerRequested);
             tx.commit();
         }
         catch (Exception ex)
@@ -561,4 +564,78 @@ public List<SIF3JobEvent> retrieveJobEventsSince(Date changesSince, String servi
 
         return jobEvents;
     }
+    
+    /**
+     * This method returns all events in the SIF3_JOB_EVENT table that match the given parameters. If the 'includeConsumeRequested'
+     * is set to TRUE then all events initiated by the provider and consumer are returned. If 'includeConsumeRequested' is set
+     * to false only events caused by changes from the provider are returned. This behaviour is useful as in most cases the
+     * consumer, who requested an operation on a job, already has the response of the request and therefore has no need to receive
+     * an event about that action. The consumer only wants to know about events it has not initiated, meaning provider caused events.
+     * 
+     * @param eventsBefore Return events before this date.
+     * @param serviceName Events for the service to be returned.
+     * @param adapterType The adapter type which is ENVIRONMENT_PROVIDER for a direct environment or PROVIDER for a brokered
+     *                    environment.
+     * @param eventType The event type (Create, Update, Change) to be retrieved.
+     * @param includeConsumeRequested Include consumer caused events.
+     * 
+     * @return A list of events that match the criteria given by the parameters. The returned list is ordered by ZoneId, ContextId,
+     *         fingerprint & eventID (in this order). 
+     * 
+     * @throws IllegalArgumentException Any of the input parameters is null.
+     * @throws PersistenceException Failed to retrieve events due to a DB issue.
+     */
+    public List<SIF3JobEvent> retrieveJobEvents(Date eventsBefore, 
+                                                String serviceName, 
+                                                AdapterType adapterType, 
+                                                JobEventType eventType, 
+                                                boolean includeConsumeRequested) throws IllegalArgumentException, PersistenceException
+    {
+        List<SIF3JobEvent> jobEvents = null;
+        BasicTransaction tx = null;
+        try
+        {
+            tx = startTransaction();
+            jobEvents = jobDAO.retrieveJobEvents(tx, eventsBefore, serviceName, adapterType, eventType, includeConsumeRequested);
+            tx.commit();
+        }
+        catch (Exception ex)
+        {
+            rollback(tx);
+            exceptionMapper(ex, ex.getMessage(), false, false);
+        }
+        
+        return jobEvents;        
+    }
+    
+    /**
+     * This is a convenience method that is used to get a full list of events in the order of Create, Update and Delete before the
+     * current date and time. The final returned list has all Create events before the Update Events and then the Delete events.
+     * Within each event type the order is by ZoneId, ContextId, fingerprint & eventID. This list is intended to be used by the
+     * event publisher as it has the events already lined up as they should be published. 
+     * 
+     * @param serviceName Events for the service to be returned.
+     * @param adapterType The adapter type which is ENVIRONMENT_PROVIDER for a direct environment or PROVIDER for a brokered
+     *                    environment.
+     * @param includeConsumeRequested Include consumer caused events.
+     * 
+     * @return A list of events that match the criteria given by the parameters. Ordering of the returned list is outlined in the
+     *         description.
+     * 
+     * @throws IllegalArgumentException Any of the input parameters is null.
+     * @throws PersistenceException Failed to retrieve events due to a DB issue.
+     */
+    public List<SIF3JobEvent> retrieveJobEvents(String serviceName, AdapterType adapterType, boolean includeConsumeRequested) throws IllegalArgumentException, PersistenceException
+    {
+        List<SIF3JobEvent> finalJobEvents = new ArrayList<SIF3JobEvent>();
+        Date now = new Date();
+        
+        // Get all Create Events
+        finalJobEvents.addAll(retrieveJobEvents(now, serviceName, adapterType, JobEventType.C, includeConsumeRequested));
+        finalJobEvents.addAll(retrieveJobEvents(now, serviceName, adapterType, JobEventType.U, includeConsumeRequested));
+        finalJobEvents.addAll(retrieveJobEvents(now, serviceName, adapterType, JobEventType.D, includeConsumeRequested));
+
+        return finalJobEvents;
+    }
+
 }