Removed zone and context parameter from processEvent() method.

Author: Joerg Huber

SIF3InfraREST/SIF3REST/src/main/java/sif3/infra/rest/consumer/AbstractEventConsumer.java

@@ -23,9 +23,7 @@
 import sif3.common.header.HeaderValues.ServiceType;
 import sif3.common.interfaces.EventConsumer;
 import sif3.common.model.EventMetadata;
-import sif3.common.model.SIFContext;
 import sif3.common.model.SIFEvent;
-import sif3.common.model.SIFZone;
 import sif3.common.model.ServiceInfo;
 import sif3.common.model.ServiceRights;
 import sif3.common.model.ServiceRights.AccessRight;
@@ -44,45 +42,39 @@
  */
 public abstract class AbstractEventConsumer<L> extends AbstractConsumer implements EventConsumer<L>, Runnable
 {
-//	private LocalConsumerQueue localConsumerQueue = null;
-//	private ExecutorService service = null;
-  
   	/**
   	 * This method is called when a consumer service has received an event. This class does implement the actual onEvent( method
   	 * from the event interface. It may do some additional work for house keeping purpose so the original onEvent() id processed
   	 * as part of this class but then this method is called so that the actual consumer can do its work as required.
   	 * 
-  	 * @param sifEvent The event data that has been received and shall be processed by the consumer.
-  	 * @param zone The zone from which the event has been received.
-  	 * @param context The context for which the event is applicable for.
+  	 * @param sifEvent The event data that has been received and shall be processed by the consumer. This parameter also holds
+  	 *                 the zone and context in the limitToZoneCtxList property. It will always only hold one entry in that
+  	 *                 list. So the zone can be retrieved with the following call: sifEvent.getLimitToZoneCtxList().get(0).getZone().
   	 * @param metadata Additional metadata that is known for the event. Typical values include custom HTTP headers, sourceName etc.
   	 * @param msgReadID The ID of the SIF queue reader. It is informative only and is only of use where there are multiple concurrent 
   	 *                  subscribers on a message queue.
   	 * @param consumerID The consumer ID that has been used to receive the event from the event queue. It is informative
   	 *                   only and is only of use where there are multiple event subscribers enabled.
   	 */
-  	public abstract void processEvent(SIFEvent<L> sifEvent, SIFZone zone, SIFContext context, EventMetadata metadata, String msgReadID, String consumerID);
+    public abstract void processEvent(SIFEvent<L> sifEvent, EventMetadata metadata, String msgReadID, String consumerID);
 
 	public AbstractEventConsumer()
 	{
 		super();
-		// Only create local queue if event processing is enabled.
-//	    if (getConsumerEnvironment().getEventsEnabled() && getConsumerEnvironment().getEventsSupported())
-//	    {
-//	    	createLocalConsumerQueue();
-//	    }
 	}
 
 	/*
 	 * (non-Javadoc)
 	 * 
-	 * @see sif3.common.interfaces.EventConsumer#onEvent(sif3.common.model.SIFEvent, sif3.common.model.SIFZone, sif3.common.model.SIFContext, java.lang.String)
+	 * @see sif3.common.interfaces.EventConsumer#onEvent(sif3.common.model.SIFEvent, sif3.common.model.EventMetadata, java.lang.String, java.lang.String)
 	 */
 	@Override
-	public void onEvent(SIFEvent<L> sifEvent, SIFZone zone, SIFContext context, EventMetadata metadata, String msgReadID, String consumerID)
+//	public void onEvent(SIFEvent<L> sifEvent, SIFZone zone, SIFContext context, EventMetadata metadata, String msgReadID, String consumerID)
+    public void onEvent(SIFEvent<L> sifEvent, EventMetadata metadata, String msgReadID, String consumerID)
 	{
 		// Right now all that is required is to call the abstract processEvent() method.
-		processEvent(sifEvent, zone, context, metadata, msgReadID, consumerID);
+//		processEvent(sifEvent, zone, context, metadata, msgReadID, consumerID);
+        processEvent(sifEvent, metadata, msgReadID, consumerID);
 	}
 
 	/*
@@ -93,12 +85,6 @@ public void onEvent(SIFEvent<L> sifEvent, SIFZone zone, SIFContext context, Even
 	@Override
 	public void finalise()
 	{
-//		logger.debug("Shut down Event Consumer Thread Pool for "+getConsumerName());
-//		if (service != null)
-//		{
-//			service.shutdown();
-//		}
-		
 		// Call user defined finalise of the subscriber.
 		super.finalise();
 	}
@@ -116,20 +102,6 @@ public final void run()
 //      logger.debug("============================\n Start "+getConsumerName()+" worker thread.\n======================================");
     }
 
-//    /*------------------------------*/
-//    /* Some Getter & Setter methods */
-//    /*------------------------------*/
-//    
-//    public final LocalConsumerQueue getLocalConsumerQueue()
-//    {
-//      return localConsumerQueue;
-//    }
-//
-//    public final void setLocalConsumerQueue(LocalConsumerQueue localConsumerQueue)
-//    {
-//      this.localConsumerQueue = localConsumerQueue;
-//    }
-    
     /*----------------------------*/
     /*-- Other required methods --*/
     /*----------------------------*/
@@ -161,52 +133,7 @@ protected final List<ServiceInfo> getEventServices()
 		return filterEventServices(sif3Session.getServiceInfoForService(getMultiObjectClassInfo().getObjectName(), ServiceType.OBJECT, AccessRight.SUBSCRIBE, ServiceRights.AccessType.APPROVED));
 	}
 
-//	public final int getNumOfConsumerThreads()
-//	{
-//		return getServiceProperties().getPropertyAsInt("consumer.local.workerThread", getClass().getSimpleName(), 1);
-//	}
-
-	/**
-	 * Only creates the local consumer queue if it doesn't already exist. The queue (new or existing) is then returned.
-	 * 
-	 * @return See desc.
-	 */
-//	public final LocalConsumerQueue createLocalConsumerQueue()
-//	{
-//		if (getLocalConsumerQueue() == null)
-//		{
-//			// Create local queue with the capacity indicated with the consumer config
-//			logger.debug("Create Local Queue for "+getConsumerName());
-//
-//			// Use the local queue as a trigger of threads rather than actual queueing of messages. Use 1 as the minimum
-//			setLocalConsumerQueue(new LocalConsumerQueue(1, getClass().getSimpleName() + "LocalQueue", getClass().getSimpleName()));
-//			startListenerThreads();
-//		}
-//		return getLocalConsumerQueue();
-//	}
-	
 	/*---------------------*/
 	/*-- Private Methods --*/
 	/*---------------------*/
-	
-	/*
-	 * Will initialise the threads and add them to the local consumer queue.
-	 */
-//	private void startListenerThreads()
-//	{
-//		// Start up all consumers for this subscriber.
-//		int numThreads = getNumOfConsumerThreads();
-//		logger.debug("Start "+numThreads+" "+getConsumerName()+" threads.");
-//		logger.debug("Total number of threads before starting Local Queue for "+getConsumerName()+" "+Thread.activeCount());
-//		service = Executors.newFixedThreadPool(numThreads);
-//		for (int i = 0; i < numThreads; i++)
-//		{
-//			String consumerID = getConsumerName()+" "+(i+1);
-//			logger.debug("Start Consumer "+consumerID);
-//			LocalMessageConsumer consumer = new LocalMessageConsumer(getLocalConsumerQueue(), consumerID, this);
-//			service.execute(consumer);
-//		}
-//		logger.debug(numThreads+" "+getConsumerName()+" initilaised and started.");
-//		logger.debug("Total number of threads after starting Local Queue for "+getConsumerName()+" "+Thread.activeCount());
-//	}
-}
+	}