Differences

This shows you the differences between two versions of the page.

Link to this comparison view

docs:3500:0300:0310 [2023/04/06 01:06] – created seandocs:3500:0300:0310 [2025/06/12 02:36] (current) – Rename to AwareIM aware_support3
Line 3: Line 3:
 ===== Writing code for a custom process component ===== ===== Writing code for a custom process component =====
  
-When writing a process it is important to understand how processes fit into the architectural framework of //**Aware IM**//. When a process is started //**Aware IM**// creates the //execution context//, which contains the information about the environment in which the process is running. This information contains the data about the user who started the process, the process start-up time, the information about the current database transaction as well as many other things. The execution context is available to the process as the [[docs:3500:0300:0316|IExecutionContext]] interface. Because a process in //**Aware IM**// runs in a "sandbox" there are certain limitations on what the process can do (see guidelines later in this section).+When writing a process it is important to understand how processes fit into the architectural framework of //**AwareIM**//. When a process is started //**AwareIM**// creates the //execution context//, which contains the information about the environment in which the process is running. This information contains the data about the user who started the process, the process start-up time, the information about the current database transaction as well as many other things. The execution context is available to the process as the [[docs:3500:0300:0316|IExecutionContext]] interface. Because a process in //**AwareIM**// runs in a "sandbox" there are certain limitations on what the process can do (see guidelines later in this section).
  
-A process communicates with //**Aware IM**// through the call-back interface called [[docs:3500:0300:0315|IExecutionEngine]]. This interface has a variety of methods that a process can use to change attributes of objects, start other processes, call services of service providers etc.+A process communicates with //**AwareIM**// through the call-back interface called [[docs:3500:0300:0315|IExecutionEngine]]. This interface has a variety of methods that a process can use to change attributes of objects, start other processes, call services of service providers etc.
  
-Sometimes a particular process calls a service, which takes a long time to fulfil. In this case the call to the service may time out. If this happens the process is //suspended//. This means that //**Aware IM**// moves the process into the “standby” mode – it is no longer active and is waiting for the reply from the service provider. Whenever such reply arrives (the reply may arrive in a few seconds, hours, days or months or never arrive at all) //**Aware IM**// automatically //resumes// the process and the process continues execution from where it left off.+Sometimes a particular process calls a service, which takes a long time to fulfil. In this case the call to the service may time out. If this happens the process is //suspended//. This means that //**AwareIM**// moves the process into the “standby” mode – it is no longer active and is waiting for the reply from the service provider. Whenever such reply arrives (the reply may arrive in a few seconds, hours, days or months or never arrive at all) //**AwareIM**// automatically //resumes// the process and the process continues execution from where it left off.
  
 The custom process component must implement ''IProcess'' interface, which has two main methods – [[pr_methods:execute|execute]] and [[pr_methods:resume|resume]]. The execute method is called when the process is started and the resume method is called when the process is resumed after having been suspended. Both methods are described in detail later in the section. The custom process component must implement ''IProcess'' interface, which has two main methods – [[pr_methods:execute|execute]] and [[pr_methods:resume|resume]]. The execute method is called when the process is started and the resume method is called when the process is resumed after having been suspended. Both methods are described in detail later in the section.
Line 13: Line 13:
 The following guidelines should be used when writing a process: The following guidelines should be used when writing a process:
  
-  * A process is not supposed to perform any operations with the database directly (such as create, open or modify database tables, manage transactions etc) – this is taken care of by the //**Aware IM**// framework. +  * A process is not supposed to perform any operations with the database directly (such as create, open or modify database tables, manage transactions etc) – this is taken care of by the //**AwareIM**// framework. 
-  * A process generally should not take long to execute as it is running within a context of a database transaction. If a process does take a long time to execute it should every now and again send a special signal to the //**Aware IM**// framework. Having received such a signal //**Aware IM**// would suspend the process, commit the current transaction and continue the process execution (resume the process). This signal can be sent if the process throws ''SuspendProcessException'' and sets its ''resumeImmediately'' flag to true, for example: <code java>throw new SuspendProcessException (true)</code> Before doing so the process should obviously remember its current state so that it can correctly resume itself in the resume method.+  * A process generally should not take long to execute as it is running within a context of a database transaction. If a process does take a long time to execute it should every now and again send a special signal to the //**AwareIM**// framework. Having received such a signal //**AwareIM**// would suspend the process, commit the current transaction and continue the process execution (resume the process). This signal can be sent if the process throws ''SuspendProcessException'' and sets its ''resumeImmediately'' flag to true, for example: <code java>throw new SuspendProcessException (true)</code> Before doing so the process should obviously remember its current state so that it can correctly resume itself in the resume method.
   * If a process calls a method of the [[docs:3500:0300:0315|IExecutionEngine]] interface, which throws ''ServerTimeOutException'' the process is supposed to catch this exception and throw ''SuspendProcessException'' passing the original ''ServerTimeOutException'' to the ''SuspendProcessException'', for example:<code java>try   * If a process calls a method of the [[docs:3500:0300:0315|IExecutionEngine]] interface, which throws ''ServerTimeOutException'' the process is supposed to catch this exception and throw ''SuspendProcessException'' passing the original ''ServerTimeOutException'' to the ''SuspendProcessException'', for example:<code java>try
 { {
  • Last modified: 2023/04/06 01:06