[jbpm-commits] JBoss JBPM SVN: r6931 - in jbpm3/branches/3.2.10.SP: core/src/main/java/org/jbpm/job/executor and 4 other directories.

Author: jcoleman(a)redhat.com Date: 2011-05-16 11:34:38 -0400 (Mon, 16 May 2011) New Revision: 6931 Modified: jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/db/JobSession.java jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/job/executor/JobExecutor.java jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/job/executor/JobExecutorThread.java jbpm3/branches/3.2.10.SP/core/src/main/resources/org/jbpm/db/hibernate.queries.hbm.xml jbpm3/branches/3.2.10.SP/core/src/main/resources/org/jbpm/default.jbpm.cfg.xml jbpm3/branches/3.2.10.SP/userguide/src/main/docbook/en-US/async.xml jbpm3/branches/3.2.10.SP/userguide/src/main/docbook/en-US/extras/configuration_1.xmlt Log: Pull across revisions 6926, 6927, 6928, 6929 from the jbpm-3.2-soa branch: Updates to the job executor fixes (revision 6918): o increase the retry count when we unlock a job if an error has occurred. Otherwise, we would decrease the value when we shouldn't o remove the additional unlocking code, as the lock-monitor thread will handle this for us Set the default RetryInterval to 4000ms, to go with the altered retry behaviour. Update documentation to match job executor changes. Add a section describing job executor configuration variables. JBPM-3192 Clarify need for unique job executor name. Modified: jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/db/JobSession.java =================================================================== --- jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/db/JobSession.java 2011-05-16 15:27:57 UTC (rev 6930) +++ jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/db/JobSession.java 2011-05-16 15:34:38 UTC (rev 6931) @@ -275,14 +275,4 @@ } return session.createCriteria(Job.class).add(Restrictions.in("id", jobs)).list(); } - - public void releaseLockedJobs(final String lockOwner) { - try { - session.getNamedQuery("JobSession.releaseLockedJobs") - .setString("lockOwner", lockOwner) - .executeUpdate(); - } catch (HibernateException e) { - throw new JbpmPersistenceException("could not release locked jobs by owner '" + lockOwner + "'", e); - } - } } Modified: jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/job/executor/JobExecutor.java =================================================================== --- jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/job/executor/JobExecutor.java 2011-05-16 15:27:57 UTC (rev 6930) +++ jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/job/executor/JobExecutor.java 2011-05-16 15:34:38 UTC (rev 6931) @@ -17,8 +17,6 @@ import org.apache.commons.logging.LogFactory; import org.jbpm.JbpmConfiguration; -import org.jbpm.JbpmContext; -import org.jbpm.db.JobSession; import org.jbpm.job.Job; import edu.emory.mathcs.backport.java.util.concurrent.locks.Condition; @@ -498,37 +496,10 @@ private void activateDispatcher() { waitingExecutorLock.lock() ; - try { - if (!dispatcherActive) { - unlockOurJobs() ; - dispatcherActive = true ; - } - } finally { - waitingExecutorLock.unlock() ; - } + dispatcherActive = true ; + waitingExecutorLock.unlock() ; } - private void unlockOurJobs() { - final JbpmContext jbpmContext = getJbpmConfiguration().createJbpmContext(); - try { - final String lockOwner = getName(); - final JobSession jobSession = jbpmContext.getJobSession(); - jobSession.releaseLockedJobs(lockOwner); - } catch (RuntimeException e) { - jbpmContext.setRollbackOnly(); - if (log.isDebugEnabled()) log.debug("failed to release locked jobs", e); - } catch (Error e) { - jbpmContext.setRollbackOnly(); - throw e; - } finally { - try { - jbpmContext.close(); - } catch (RuntimeException e) { - if (log.isDebugEnabled()) log.debug("failed to release locked jobs", e); - } - } - } - private void deactivateDispatcher() { waitingExecutorLock.lock() ; try { Modified: jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/job/executor/JobExecutorThread.java =================================================================== --- jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/job/executor/JobExecutorThread.java 2011-05-16 15:27:57 UTC (rev 6930) +++ jbpm3/branches/3.2.10.SP/core/src/main/java/org/jbpm/job/executor/JobExecutorThread.java 2011-05-16 15:34:38 UTC (rev 6931) @@ -219,6 +219,10 @@ // unlock job job.setLockOwner(null); job.setLockTime(null); + if (job.getException() != null) + { + job.setRetries(job.getRetries()+1) ; + } } catch (RuntimeException e) { jbpmContext.setRollbackOnly(); Modified: jbpm3/branches/3.2.10.SP/core/src/main/resources/org/jbpm/db/hibernate.queries.hbm.xml =================================================================== --- jbpm3/branches/3.2.10.SP/core/src/main/resources/org/jbpm/db/hibernate.queries.hbm.xml 2011-05-16 15:27:57 UTC (rev 6930) +++ jbpm3/branches/3.2.10.SP/core/src/main/resources/org/jbpm/db/hibernate.queries.hbm.xml 2011-05-16 15:34:38 UTC (rev 6931) @@ -401,16 +401,6 @@ ]]> </query> - <query name="JobSession.releaseLockedJobs"> - <![CDATA[ - update org.jbpm.job.Job job - set job.lockOwner = null, job.lockTime = null - where (job.lockOwner = :lockOwner) - and job.retries > 0 - and job.isSuspended = false - ]]> - </query> - <!-- related to Tasks --> <!-- ########################### --> Modified: jbpm3/branches/3.2.10.SP/core/src/main/resources/org/jbpm/default.jbpm.cfg.xml =================================================================== --- jbpm3/branches/3.2.10.SP/core/src/main/resources/org/jbpm/default.jbpm.cfg.xml 2011-05-16 15:27:57 UTC (rev 6930) +++ jbpm3/branches/3.2.10.SP/core/src/main/resources/org/jbpm/default.jbpm.cfg.xml 2011-05-16 15:34:38 UTC (rev 6931) @@ -109,8 +109,8 @@ <int value="60000" /> </property> <property name="retryInterval"> - <!-- 1 second --> - <int value="1000" /> + <!-- 4 seconds --> + <int value="4000" /> </property> <property name="maxIdleInterval"> <!-- 1 hour --> Modified: jbpm3/branches/3.2.10.SP/userguide/src/main/docbook/en-US/async.xml =================================================================== --- jbpm3/branches/3.2.10.SP/userguide/src/main/docbook/en-US/async.xml 2011-05-16 15:27:57 UTC (rev 6930) +++ jbpm3/branches/3.2.10.SP/userguide/src/main/docbook/en-US/async.xml 2011-05-16 15:34:38 UTC (rev 6931) @@ -186,26 +186,23 @@ executor must execute the jobs. This is done in two phases. <itemizedlist> <listitem> - <para>A job executor thread must acquire a job</para> + <para>The dispatcher thread must acquire a job</para> </listitem> <listitem> - <para>The thread that acquired the job must execute it</para> + <para>An executor thread must execute the job</para> </listitem> </itemizedlist> </para> - <para>Acquiring a job and executing the job are done in 2 separate transactions. A thread - acquires a job by putting its name into the owner field of the job. Each thread has a unique - name based on IP address and sequence number. Hibernate's optimistic locking is enabled on - <literal>Job</literal>-objects. So if 2 threads try to acquire a job concurrently, one of - them will get a StaleObjectException and rollback. Only the first one will succeed. The - thread that succeeds in acquiring a job is now responsible for executing it in a separate - transaction. + <para>Acquiring a job and executing the job are done in 2 separate transactions. The + dispatcher thread acquires jobs from the database on behalf of all the executor threads + on this node. When the executor thread takes the job, it adds its name into the owner + field of the job. Each thread has a unique name based on IP address and sequence number. </para> <para>A thread could die between acquisition and execution of a job. To clean-up after those situations, there is one lock-monitor thread per job executor that checks the lock times. - The lock monitor thread will unlock any jobs that have been locked for more than 30 minutes, + The lock monitor thread will unlock any jobs that have been locked for more than 10 minutes, so that they can be executed by another job executor thread. </para> @@ -230,6 +227,127 @@ <literal>READ_COMMITTED</literal> is not enough because it allows for Non-Repeatable reads to occur. So <literal>REPEATABLE_READ</literal> is required if you configure more than one job executor thread. </para> + + <para> + Configuration properties related to the job executor are: + </para> + + <variablelist> + + <varlistentry> + <term><property>jbpmConfiguration</property></term> + <listitem> + <para> + The bean from which configuration is retrieved. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><property>name</property></term> + <listitem> + <para> + The name of this executor. + </para> + <important> + <para> + This name should be unique for each node, when more + than one jBPM instance is started on a single machine. + </para> + </important> + </listitem> + </varlistentry> + + <varlistentry> + <term><property>nbrOfThreads</property></term> + <listitem> + <para> + The number of executor threads that are started. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><property>idleInterval</property></term> + <listitem> + <para> + The interval that the dispatcher thread will wait before + checking the job queue, if there are no jobs pending. + </para> + <note> + <para> + The dispatcher thread is automatically notifed when jobs + are added to the queue. + </para> + </note> + </listitem> + </varlistentry> + + <varlistentry> + <term><property>retryInterval</property></term> + <listitem> + <para> + The interval that a job will wait between retries, if it + fails during execution. + </para> + <note> + <para> + The maximum number of retries is configured by + <property>jbpm.job.retries</property>. + </para> + </note> + </listitem> + </varlistentry> + + <varlistentry> + <term><property>maxIdleInterval</property></term> + <listitem> + <para> + The maximum period for <property>idleInterval</property>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><property>historyMaxSize</property></term> + <listitem> + <para> + This property is deprecated, and has no affect. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><property>maxLockTime</property></term> + <listitem> + <para> + The macimum time that a job can be locked, before the + lock-monitor thread will unlock it. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><property>lockMonitorInterval</property></term> + <listitem> + <para> + The period for which the lock-monitor thread will sleep + between checking for locked jobs. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><property>lockBufferTime</property></term> + <listitem> + <para> + This property is deprecated, and has no affect. + </para> + </listitem> + </varlistentry> + + </variablelist> + </section> <section id="jbpmsbuiltinasynchronousmessaging"> Modified: jbpm3/branches/3.2.10.SP/userguide/src/main/docbook/en-US/extras/configuration_1.xmlt =================================================================== --- jbpm3/branches/3.2.10.SP/userguide/src/main/docbook/en-US/extras/configuration_1.xmlt 2011-05-16 15:27:57 UTC (rev 6930) +++ jbpm3/branches/3.2.10.SP/userguide/src/main/docbook/en-US/extras/configuration_1.xmlt 2011-05-16 15:34:38 UTC (rev 6931) @@ -59,7 +59,8 @@ </field> <field name='name'><string value='JbpmJobExecutor' /></field> <field name='nbrOfThreads'><int value='1' /></field> - <field name='idleInterval'><int value='5000' /></field> + <field name='idleInterval'><int value='60000' /></field> + <field name='retryInterval'><int value='4000' /></field> <!-- 1 hour --> <field name='maxIdleInterval'><int value='3600000' /></field> <field name='historyMaxSize'><int value='20' /></field> @@ -70,4 +71,4 @@ <!-- 5 seconds --> <field name='lockBufferTime'><int value='5000' /></field> </bean> -</jbpm-configuration> \ No newline at end of file +</jbpm-configuration>