Monitoring Model Deployment

To provide a monitoring for user/realm management and model deployment, you can implement the interface org.eclipse.stardust.engine.core.spi.monitoring.IPartitionMonitor.

package org.eclipse.stardust.engine.core.spi.monitoring;

import org.eclipse.stardust.engine.api.model.IModel;
import org.eclipse.stardust.engine.api.runtime.DeploymentException;
import org.eclipse.stardust.engine.core.runtime.beans.IUser;
import org.eclipse.stardust.engine.core.runtime.beans.IUserRealm;

/**
 * SPI based monitoring for
 * user/realm management
 * model deployment
 * 
 * @author sauer
 * @version $Revision: $
 */
public interface IPartitionMonitor
{
   /**
    * Client can analyze and monitor argument and method call.
    * 
    * @param realm
    */
   void userRealmCreated(IUserRealm realm);
   
   /**
    * Client can analyze and monitor argument and method call.
    * 
    * @param realm
    */
   void userRealmDropped(IUserRealm realm);
   
   /**
    * Client can analyze and monitor argument and method call.
    * 
    * @param user
    */
   void userCreated(IUser user);
   
   /**
    * Client can analyze and monitor argument and method call.
    * 
    * @param user
    */
   void userEnabled(IUser user);
   
   /**
    * Client can analyze and monitor argument and method call.
    * 
    * @param user
    */
   void userDisabled(IUser user);

   /**
    * Client can check if arguments are valid and otherwise throw an DeploymentException.
    * 
    * @param model
    * @param isOverwrite
    * @throws DeploymentException
    */
   void modelDeployed(IModel model, boolean isOverwrite) throws DeploymentException;
 
   /**
    * Client can check if arguments are valid and otherwise throw an DeploymentException.
    * 
    * @param model
    * @throws DeploymentException
    */
   void modelDeleted(IModel model) throws DeploymentException;   
}

Method Invocation Pattern

The invocation of the methods is performed as follows:

• For each invocation of method

  adminSession.deployModel(java.lang.String model, int predecessorOID)

  the callback method

  modelDeployed(IModel model, boolean isOverwrite)

  will be invoked exactly once for that model and with parameter value isOverwrite = false.
• For each invocation of method

  deployModel(java.lang.String model, java.lang.String configuration, int predecessorOID, java.util.Date validFrom, java.util.Date validTo, java.lang.String comment, boolean disabled, boolean ignoreWarnings)

  the callback method

  modelDeployed(IModel model, boolean isOverwrite)

  will be invoked exactly once for that model and with parameter value isOverwrite = false.
• For each invocation of method

  deployModel(java.util.List<DeploymentElement> deploymentElements, DeploymentOptions options)

  the callback method

  modelDeployed(IModel model, boolean isOverwrite)

  will be invoked exactly once for each model in the deployment unit with parameter value isOverwrite=false. Hence the call back interface implementation will only be able to validate each model individually but not all models together.
• For each of the following methods, the callback method

  modelDeployed(IModel model, boolean isOverwrite)

  will be invoked exactly once for that model and with parameter value isOverwrite=true:

  • overwriteModel(DeploymentElement deploymentElement, int modelOID, DeploymentOptions options)

  • overwriteModel(java.lang.String model, int modelOID)

  • overwriteModel(java.lang.String model, java.lang.String configuration, int modelOID, java.util.Date validFrom, java.util.Date validTo, java.lang.String comment, boolean disabled, boolean ignoreWarnings)

• For each invocation of method

  deleteModel(long modelOID)

  the callback method

  void modelDeleted(IModel model) throws DeploymentException

  will be invoked exactly once for that model.

In any case, the callback method will be invoked prior to finalizing or committing the deployment operation in question and the action will be rolled back in case the callback implementation throws a DeploymentException.

Creating a custom Implementation

Create your own implementations for this interface. To publish an implementor to the engine, a file named by the interface's factory has to be created in the /META-INF/services folder of the jar as follows:

1. Unzip the carnot-engine.jar file, located in the root directory of the original carnot.ear file.
   Refer to chapter Creating a Stardust Runtime Environment with Apache Maven in the Installation Guide for details on how to retrieve the carnot.ear file from one of the preconfigured deployment configurations.
2. In folder /META-INF/services, create the following file:

   org.eclipse.stardust.engine.core.spi.monitoring.IPartitionMonitor

3. Add the fully qualified class name of your implementations to the file named as the interface, which the class implements.

Example Implementation

package custom.bpm.spi.monitoring;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

import org.eclipse.stardust.common.log.LogManager;
import org.eclipse.stardust.common.log.Logger;
import org.eclipse.stardust.engine.api.model.IModel;
import org.eclipse.stardust.engine.api.model.IProcessDefinition;
import org.eclipse.stardust.engine.api.model.Inconsistency;
import org.eclipse.stardust.engine.api.runtime.DeploymentException;
import org.eclipse.stardust.engine.api.runtime.DeploymentInfo;
import org.eclipse.stardust.engine.core.model.utils.ModelElementList;
import org.eclipse.stardust.engine.core.runtime.beans.IUser;
import org.eclipse.stardust.engine.core.runtime.beans.IUserRealm;
import org.eclipse.stardust.engine.core.spi.monitoring.IPartitionMonitor;

public class PartitionMonitor implements IPartitionMonitor
{
   private static String standeredMessage = "Pre Deployment Check";
   private static List<String> deployedModels; 
   protected static Logger trace = LogManager.getLogger(PartitionMonitor.class);
   
   @Override
   public void userRealmCreated(IUserRealm realm)
   {
   }

   @Override
   public void userRealmDropped(IUserRealm realm)
   {
   }

   @Override
   public void userCreated(IUser user)
   {
   }

   @Override
   public void userEnabled(IUser user)
   {
   }

   @Override
   public void userDisabled(IUser user)
   {
   }

   @Override
   public void modelDeployed(IModel model, boolean isOverwrite)
         throws DeploymentException
   {
	   trace.info("In modelDeployed : model ="+model.getId());
	   if(model.getId().equalsIgnoreCase("MyModel")||model.getId().equalsIgnoreCase("MyConsumer")||model.getId().equalsIgnoreCase("MyProvider")||model.getId().equalsIgnoreCase("FlushModel"))
	   {
		   trace.info("Going for Monitoring");
		   doMonitoring(model,isOverwrite);
	   }
	   	
   }
   
   private void doMonitoring(IModel model, boolean isOverwrite) throws DeploymentException{
	   
	   String localMessage = standeredMessage+" , "+isOverwrite;
	   
	   if(isOverwrite)
	   {
		   throw new DeploymentException("asked to Overwrite",new MyDeploymentInfo(model.getId())); 
	   }
	   
	   if(model.getId().equalsIgnoreCase("FlushModel"))
	   { 
		   // flush list of models 
		   deployedModels = null;
		   throw new DeploymentException("Model list cleared",new MyDeploymentInfo(model.getId())); 
	   }
	   
	   ModelElementList<IProcessDefinition> processDefinationList = model.getProcessDefinitions();
	   if(processDefinationList.size()!=1)
	   {
		   throw new DeploymentException("Unexpected number of PDs",new MyDeploymentInfo(model.getId()));
	   }
	   
	   IProcessDefinition pd= processDefinationList.get(0);
	
	   trace.info("Got PD : "+pd.getId());
	   
	   if(pd.getId().equalsIgnoreCase("Deploy")) 
	   {	
		      if(null == deployedModels)
			  {
		    	  trace.info("Creating array list for models list");
				  deployedModels = new ArrayList<String>();
			  }
		      else if(model.getId().equalsIgnoreCase("MyConsumer"))
		      {
		    	  trace.info("at consumer");
		    	  if(deployedModels.contains("MyProvider"))
		    	  {	  localMessage = localMessage+", second of set provider consumer,first was 'MyProvider'";
		    		  throw new DeploymentException(localMessage,new MyDeploymentInfo(model.getId()));
		    	  }
		    	  else
		    	  {
		    		  trace.info("provider was not there");
		    	  }
		      } else if(model.getId().equalsIgnoreCase("MyProvider"))
			  {		  trace.info("at provider");
					  
			  		if(deployedModels.contains("MyConsumer"))
			  		{
			  			localMessage = localMessage+", second of set provider consumer,first was 'MyConsumer'";
   			   		  throw new DeploymentException(localMessage,new MyDeploymentInfo(model.getId()+""));
			  		}
			  		else
			    	{
			    		  trace.info("consumer was not there");
			    	}
			  }
		      deployedModels.add(model.getId());
	   } else if(pd.getId().equalsIgnoreCase("DoNotDeploy"))
	   {
		   trace.info("Going to throw deployment Exception");
		   throw new DeploymentException(localMessage,new MyDeploymentInfo(model.getId()));
	   }
	   else 
	   {
		   
		   throw new DeploymentException("Error",new MyDeploymentInfo(model.getId()));
	   }
   }

   @Override
   public void modelDeleted(IModel model) throws DeploymentException
   {
	   trace.info("In modelDeleted : model ="+model.getId());
	   if(model.getId().equalsIgnoreCase("MyModel"))
	   {
		   trace.info("Going to throw exception");
		   throw new DeploymentException("asked to delete model",new MyDeploymentInfo(model.getId())); 
	   }
   }
      
   static class MyDeploymentInfo implements DeploymentInfo{
		
	private static final long serialVersionUID = 1L;
	
	String message;
	   
	 public  MyDeploymentInfo(String msg)
	 {
		 message = msg;
	 }
	   
	@Override
	public List<Inconsistency> getErrors() {
		return null;
	}

	@Override
	public String getId() {
		return null;
	}

	@Override
	public int getModelOID() {
		return 0;
	}

	@Override
	public List<Inconsistency> getWarnings() {
		return null;
	}

	@Override
	public boolean hasErrors() {
		return false;
	}

	@Override
	public boolean hasWarnings() {
		return false;
	}

	@Override
	public boolean isValid() {
		return false;
	}

	@Override
	public boolean success() {
		return false;
	}

	@Override
	public String getDeploymentComment() {
		trace.info("In get deployment comment");
		return message;
	}

	@Override
	public Date getDeploymentTime() {
		return null;
	}

	@Override
	public int getRevision() {
		return 0;
	}

	@Override
	public Date getValidFrom() {
		// TODO Auto-generated method stub
		return null;
	}
   }
}