Changeset 3871

Timestamp:

Oct 22, 2007, 2:21:37 PM (16 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #595: Add option to stop a plug-in from beeing executed by the internal job queue
References #746: Moved plugins/jobs section to docbook

Location:

trunk

Files:

• config/dist/base.config (modified) (1 diff)
• doc/src/docbook/admindoc/installation_upgrade.xml (modified) (22 diffs)
• doc/src/docbook/admindoc/plugin_installation.xml (modified) (1 diff)
• doc/src/docbook/appendix/base.config.xml (modified) (1 diff)
• doc/src/docbook/developerdoc/api_overview.xml (modified) (1 diff)
• doc/src/docbook/figures/plugin_jobagents.png (modified) (previous)
• doc/src/docbook/figures/uml/datalayer.overview.png (modified) (previous)
• doc/src/docbook/figures/uml/datalayer.plugins.png (added)
• doc/src/uml/baseuml.mdzip (modified) (previous)
• src/core/common-queries.xml (modified) (2 diffs)
• src/core/net/sf/basedb/core/Install.java (modified) (1 diff)
• src/core/net/sf/basedb/core/InternalJobQueue.java (modified) (6 diffs)
• src/core/net/sf/basedb/core/PluginDefinition.java (modified) (1 diff)
• src/core/net/sf/basedb/core/Update.java (modified) (5 diffs)
• src/core/net/sf/basedb/core/data/PluginDefinitionData.java (modified) (1 diff)
• www/admin/jobagents/index.jsp (modified) (1 diff)
• www/admin/plugindefinitions/edit_plugin.jsp (modified) (6 diffs)
• www/admin/plugindefinitions/index.jsp (modified) (1 diff)
• www/admin/plugindefinitions/list_plugins.jsp (modified) (2 diffs)
• www/admin/plugindefinitions/view_plugin.jsp (modified) (1 diff)
• www/include/scripts/main.js (modified) (1 diff)

trunk/config/dist/base.config

@@ -77 +77 @@
 # If the internal job queue should be enabled or not
 jobqueue.internal.enabled            = true
+
+# If plugins with useInteralJobQueue = false should be executed or not
+jobqueue.internal.runallplugins      = false
+
+# The maximum thread priority for any thread executing a plug-in
 #jobqueue.internal.maxthreadpriority  = 4
 

trunk/doc/src/docbook/admindoc/installation_upgrade.xml

@@ -204 +204 @@
           <para>
             In the main BASE configuration file,
-            <filename>/path/to/base/www/WEB-INF/classes/base.config</filename>,
+            <filename>&lt;base-dir&gt;/www/WEB-INF/classes/base.config</filename>,
             fields that needs to be transferred are usually
             <emphasis>db.username</emphasis>,
@@ -212 +212 @@
           <para>
             Local settings in the raw data
-            tables, <filename>/path/to/base/www/WEB-INF/classes/raw-data-types.xml</filename>,
+            tables, <filename>&lt;base-dir&gt;/www/WEB-INF/classes/raw-data-types.xml</filename>,
             may need to be transferred.
           </para>
@@ -228 +228 @@
             need to run them. Change directory
             to <filename
-            class="directory">/path/to/base/bin/</filename> and issue
+            class="directory">&lt;base-dir&gt;/bin/</filename> and issue
 <programlisting>sh ./updatedb.sh <emphasis>base_root_password</emphasis>
 sh ./updateindexes.sh <emphasis>base_root_password</emphasis></programlisting>
@@ -289 +289 @@
       checking the BASE job queue for jobs awaiting execution. When
       the job agent finds a job that it is enabled to execute, it
-      loads the plugin and executes it. Job agents will in this way
+      loads the plug-in and executes it. Job agents will in this way
       free up resources on the BASE application server, and thus allow
       the BASE server to concentrate on serving web pages. Job agents
@@ -303 +303 @@
         <listitem>
           <para>
-            Specify exactly which plugins each job agent should be
+            Specify exactly which plug-ins each job agent should be
             able to execute.
           </para>
@@ -309 +309 @@
         <listitem>
           <para>
-            Give some plugins higher priority than other plugins.
+            Give some plug-ins higher priority than other plug-ins.
           </para>
         </listitem>
@@ -320 +320 @@
         <listitem>
           <para>
-            Override memory settings and more for each plugin.
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            Execute plugins in separate processes. Thus, a misbehaving
-            plugin cannot bring the main application server down.
+            Override memory settings and more for each plug-in.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            Execute plug-ins in separate processes. Thus, a misbehaving
+            plug-in cannot bring the main application server down.
           </para>
         </listitem>
@@ -338 +338 @@
       setup. For example one job agent can be assigned for importing
       data only, another job agent can be assigned for running
-      analysis plugins for specific project only, and a third may be a
+      analysis plug-ins for specific project only, and a third may be a
       catch-all job agent that performs all low-priority jobs.
     </para>
@@ -347 +347 @@
         <variablelist>
           <varlistentry>
-            <term>Disable the internal job queue</term>
+            <term>Make sure the internal job queue doesn't execute all plug-ins</term>
             <listitem>
               <para>
-                It is not recommended to use the internal job queue
-                when job agents are used. The
-                setting <command>jobqueue.internal.enabled</command>
-                should be changed to <command>false</command> for the
+                The setting <command>jobqueue.internal.runallplugins</command>
+                should be set to <command>false</command> for the
                 BASE server. This setting is found in
-                the <filename>/path/to/base/www/WEB-INF/classes/base.config</filename>
+                the <filename>&lt;base-dir&gt;/www/WEB-INF/classes/base.config</filename>
                 file. The changes will not take effect until the
                 application server is restarted.
               </para>
+              
+              <note>
+                Prior to BASE 2.5 the internal job queue had to be disabled
+                completely. This is no longer the case since it is possible to
+                enable/disable the internal job queue separately for
+                each plug-in.
+              </note>
+              
             </listitem>
           </varlistentry>
@@ -435 +441 @@
             <listitem>
               <para>
-                The <filename>/path/to/base/www/WEB-INF/classes/base.config</filename>
+                The <filename>&lt;base-dir&gt;/www/WEB-INF/classes/base.config</filename>
                 file must be configured as in regular BASE
                 installation, cf.
@@ -485 +491 @@
             <listitem>
               <para>
-                The <filename>/path/to/base/www/WEB-INF/classes/jobagent.properties</filename>
+                The <filename>&lt;base-dir&gt;/www/WEB-INF/classes/jobagent.properties</filename>
                 file contains settings for the job agent. The most
                 important ones to specify value for are
@@ -557 +563 @@
         Before the job agent starts executing jobs for you it must be
         configured. The configuration is done through the BASE web
-        interface.
+        interface. See <xref linkend="plugins.jobagents" />
         <variablelist>
           <varlistentry>
-            <term>Configure the plugins the job agent should handle</term>
+            <term>Configure the plug-ins the job agent should handle</term>
             <listitem>
               <para>
@@ -583 +589 @@
                     <para>
                       On the <guilabel>Plugins</guilabel> tab you can
-                      specify which plugins the job agent should
+                      specify which plug-ins the job agent should
                       handle. Note that if you have installed external
-                      plugins on the web server, those plugins must be
+                      plug-ins on the web server, those plug-ins must be
                       installed on the job agent as well. It is
                       possible to specify different paths to the JAR
@@ -706 +712 @@
                   <ulink url="http://www.postgresql.org/" />. you must
                   edit
-                  your <filename>/path/to/base/www/WEB-INF/classes/base.config</filename>
+                  your <filename>&lt;base-dir&gt;/www/WEB-INF/classes/base.config</filename>
                   file. Uncomment the settings for Postgres and
                   comment out the settings for MySQL.
@@ -803 +809 @@
                 </para>
                 <para>
-                  The <filename>/path/to/base/misc/sql/createdb.mysql.sql</filename>
+                  The <filename>&lt;base-dir&gt;/misc/sql/createdb.mysql.sql</filename>
                   file contains the above statements and can be used
                   by the <filename>mysql</filename> command-line tool
@@ -833 +839 @@
   # within the tool and quit with a '\q'.
 CREATE SCHEMA "dynamic" AUTHORIZATION "db_user";</programlisting>
-                  The <filename>/path/to/base/misc/sql/createdb.postgresql.sql</filename>
+                  The <filename>&lt;base-dir&gt;/misc/sql/createdb.postgresql.sql</filename>
                   file contains the above statements and can be used
                   by the <filename>psql</filename> command-line tool:
@@ -864 +870 @@
           <para>
             Basic BASE configuration is done in
-            <filename>/path/to/base/www/WEB-INF/classes/base.config</filename>:
+            <filename>&lt;base-dir&gt;/www/WEB-INF/classes/base.config</filename>:
             <itemizedlist>
               <listitem>
@@ -893 +899 @@
             to modify extended properties to fit your needs. Extended
             properties are defined in
-            <filename>/path/to/base/www/WEB-INF/classes/extended-properties.xml</filename>.
+            <filename>&lt;base-dir&gt;/www/WEB-INF/classes/extended-properties.xml</filename>.
             There is an
             administrator <ulink
@@ -912 +918 @@
           <para>
             Change directory to
-            <filename class="directory">/path/to/base/bin</filename>
+            <filename class="directory">&lt;base-dir&gt;/bin</filename>
             and run <filename>initdb.sh</filename> as 
 <programlisting>./initdb.sh base_root_password</programlisting>
@@ -934 +940 @@
           <para>
             Either move the <filename
-            class="directory">/path/to/base/www</filename> directory
+            class="directory">&lt;base-dir&gt;/www</filename> directory
             to the tomcat <filename class="directory">webapps</filename>
             directory or create a symbolic link from the tomcat
             <filename class="directory">webapps</filename> directory to
-            the <filename class="directory">/path/to/base/www</filename>
+            the <filename class="directory">&lt;base-dir&gt;/www</filename>
             directory 
 <programlisting>cd /path/to/tomcat/webapps
@@ -1118 +1124 @@
             behaviour), you must have file system access to BASE 1.2
             files, <emphasis>i.e.,</emphasis> the <filename
-            class="directory">/path/to/base1.2/data</filename>
+            class="directory">/ 1.2/data</filename>
             directory containing directories
             <filename class="directory">rawdata</filename>,
@@ -1129 +1135 @@
           <para>
             Change settings in the file
-            <filename>/path/to/base/dist/www/WEB-INF/classes/migrate.properties</filename>.
+            <filename>&lt;base-dir&gt;/dist/www/WEB-INF/classes/migrate.properties</filename>.
             The available options are commented:
             <itemizedlist>

trunk/doc/src/docbook/admindoc/plugin_installation.xml

@@ -693 +693 @@
         <listitem>
           <para>
+            You may select if the internal job queue should execute the 
+            plug-in or not. 
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><guilabel>Job agents</guilabel></term>
+        <listitem>
+          <para>
             A list with the job agents where the plug-in is installed and 
             allowed to be executed. Select a plug-in in this list to display 

trunk/doc/src/docbook/appendix/base.config.xml

@@ -360 +360 @@
         <para>
          If <userinput>0</userinput> or <userinput>FALSE</userinput> the internal 
-         job queue will be disabled. If you are using job agents to execute jobs,
-         the recommendation is to disable the internal job queue. Otherwise you must
-         leave it enabled.
+         job queue will be disabled.
+         </para>
+      </listitem>
+    </varlistentry>
+    
+    <varlistentry>
+      <term><property>jobqueue.internal.runallplugins</property></term>
+      <listitem>
+        <para>
+         If <userinput>1</userinput> or <userinput>TRUE</userinput> the internal 
+         job queue will ignore the <property>useInternalJobQueue</property>
+         flag specified on plug-ins. If <userinput>0</userinput> or <userinput>FALSE</userinput>
+         the internal job queue will only execute plug-ins which has
+         <property>useInternalJobQueue=true</property>
          </para>
       </listitem>

trunk/doc/src/docbook/developerdoc/api_overview.xml

@@ -894 +894 @@
     <sect2 id="data_api.plugins">
       <title>Plug-ins, jobs and job agents</title>
+      
+      <para>
+         This section gives an overview of plug-ins, jobs and job agents.
+      </para>
+      
+      <itemizedlist>
+        <title>See also</title>
+        <listitem><xref linkend="plugins.installation" /></listitem>
+        <listitem><xref linkend="installation_upgrade.jobagents" /></listitem>
+      </itemizedlist>
+      
+      <sect3 id="data_api.plugins.uml">
+        <title>UML diagram</title>
+        
+        <figure id="data_api.figures.plugins">
+          <title>Plug-ins, jobs and job agents</title>
+          <screenshot>
+            <mediaobject>
+              <imageobject>
+                <imagedata 
+                  fileref="figures/uml/datalayer.plugins.png" format="PNG" />
+              </imageobject>
+            </mediaobject>
+          </screenshot>
+        </figure>
+      </sect3>
+
+      <sect3 id="data_api.plugins.plugins">
+        <title>Plug-ins</title>
+        
+        <para>
+          The <classname>PluginDefinitionData</classname> holds information of the 
+          installed plugin classes. Much of the information is copied from the
+          plug-in itself from the <classname>About</classname> object and by checking
+          which interfaces it implements.
+        </para>
+        
+        <para>
+          There are five main types of plug-ins:
+        </para>
+        
+        <itemizedlist>
+        <listitem>
+          <para>
+          IMPORT (mainType = 1): A plug-in that imports data to BASE.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          EXPORT (mainType = 2): A plug-in that exports data from BASE.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          INTENSITY (mainType = 3): A plug-in that calculates intensity values
+          from raw data.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          ANALYZE (mainType = 4): A plug-in that analyses data.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          OTHER (mainType = 5): Any other plug-in.
+          </para>
+        </listitem>
+        </itemizedlist>
+        
+        <para>
+          A plug-in may have different configurations. The flags <property>supportsConfigurations</property>
+          and <property>requiresConfiguration</property> are used to specify if a plug-in 
+          must have or can't have any configurations. Configuration parameter values are 
+          versioned. Each time anyone updates a configuration the version number 
+          is increased and the parameter values are stored as a new entity. 
+          This is required because we want to be able to know exactly which
+          parameters a job were using when it was executed. When a job is 
+          created we also store the parameter version number 
+          (<property>JobData.parameterVersion</property>). This means that even if 
+          someone changes the configuration later we will always know which 
+          parameters the job used. 
+        </para>
+        
+        <para>
+          The <classname>PluginTypeData</classname> class is ued to group
+          plug-ins that share some common functionality, by implementing
+          additional (optional) interfaces. For example, the 
+          <interfacename>AutoDetectingImporter</interfacename> should be implemented
+          by import plug-ins that supports automatic detection of file formats.
+          Another example is the <interfacename>AnalysisFilterPlugin</interfacename>
+          interface which should be implemented by all analysis plug-ins that
+          only filters data.
+        </para>
+
+      </sect3>
+      
+      <sect3 id="data_api.plugins.jobs">
+        <title>Jobs</title>
+        
+        <para>
+          A job represents a single invokation of a plug-in to do some work.
+          The <classname>JobData</classname> class holds information about this.
+          A job is usuallu executed by a plug-in, but doesn't have to be. The
+          <property>status</property> property holds the current state of a job.
+        </para>
+        
+        <itemizedlist>
+        <listitem>
+          <para>
+            UNCONFIGURED (status = 0): The job is not yet ready to be executed.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            WAITING (status = 1): The job is waiting to be executed.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            PREPARING (status = 5): The job is about to be executed but hasn't started yet.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            EXECUTING (status = 2): The job is currently executing.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            DONE (status = 3): The job finished successfully.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            ERROR (status = 4): The job finished with an error.
+          </para>
+        </listitem>
+        </itemizedlist>
+      </sect3>
+
+      <sect3 id="data_api.plugins.agents">
+        <title>Job agents</title>
+        
+        <para>
+          A job agent is a program running on the same or a different server that 
+          is regularly checking for jobs that are waiting to be executed. The
+          <classname>JobAgentData</classname> holds information about a job agent
+          and the <classname>JobAgentSettingsData</classname> links the agent
+          with the plug-ins the agent is able to execute. The job agent will only 
+          execute jobs that are owner by users or projects that the job agent has 
+          been shared to with at least use permission. The <property>priorityBoost</property>
+          property can be used to give specific plug-ins higher priority.
+          Thus, for a job agent it is possible to:
+        </para>
+        
+        <itemizedlist>
+        <listitem>
+          <para>
+          Specify exactly which plug-ins it will execute. For example, it is possible
+          to dedicate one agent to only run one plug-in.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          Give some plug-ins higher priority. For example a job agent that is mainly 
+          used for importing data should give higher priority to all import plug-ins.
+          Other types of jobs will have to wait until there are no more data to be 
+          imported.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          Specify exactly which users/groups/projects that may use the agent. For 
+          example, it is possible to dedicate one agent to only run jobs for a certain 
+          project.
+          </para>
+        </listitem>
+        </itemizedlist>
+        
+      </sect3>
+
+
     </sect2>
     

trunk/src/core/common-queries.xml

@@ -1401 +1401 @@
       A Hibernate query that loads plugin jobs in the job queue waiting to be
       executed sorted by priority and waiting type.
+    </description>
+  </query>
+  
+  <query id="FIND_INTERNAL_JOBS_IN_QUEUE" type="HQL">
+    <sql>
+      SELECT job
+      FROM JobData job
+      WHERE job.status = :status
+      AND job.type = :type
+      AND job.pluginDefinition.useInternalJobQueue = true
+      ORDER BY job.priority ASC, job.created ASC
+    </sql>
+    <description>
+      A Hibernate query that loads plugin jobs in the job queue waiting to be
+      executed sorted by priority and waiting type. It should only return
+      jobs where the plug-in setting useInternalJobQueue=true
     </description>
   </query>
@@ -2955 +2971 @@
   </query>
 
+  <query id="SET_USEJOBQUEUE_ON_PLUGINS" type="HQL">
+    <sql>
+      UPDATE PluginDefinitionData pld
+      SET pld.useInternalJobQueue = true
+      WHERE pld.useInternalJobQueue IS NULL
+    </sql>
+    <description>
+      A HQL query that set the useInternalJobQueue property to true
+      for all plug-ins.
+    </description>
+  </query>
 
 </predefined-queries>

trunk/src/core/net/sf/basedb/core/Install.java

@@ -107 +107 @@
     method.
   */
-  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(44).intValue();
+  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(45).intValue();
   
   public static synchronized void createTables(boolean update, final ProgressReporter progress)

trunk/src/core/net/sf/basedb/core/InternalJobQueue.java

@@ -27 +27 @@
 import net.sf.basedb.core.plugin.Response;
 import net.sf.basedb.core.data.JobData;
+import net.sf.basedb.core.data.PluginDefinitionData;
 import net.sf.basedb.core.data.ShareableData;
 import net.sf.basedb.core.data.UserData;
@@ -196 +197 @@
   
   /**
+    If the {@link PluginDefinitionData#getUseInternalJobQueue()} setting
+    should be ignored or not.
+  */
+  private boolean ignoreUseInternalJobQueueFlag = false;
+  
+  /**
     Create the job queue. The one and only instance is created
     by Application.start
@@ -204 +211 @@
     maxSlots = Collections.synchronizedMap(new HashMap<Job.ExecutionTime, Integer>());
     priorities = Collections.synchronizedMap(new HashMap<Job.ExecutionTime, Integer>());
-    
-    // Read configuration values
+
+    // If we should execute all jobs or only jobs for plug-ins which may use the internal queue
+    ignoreUseInternalJobQueueFlag = Config.getBoolean("jobqueue.internal.runallplugins");
+
+    // Number of execution slots and thread priorities
     for (Job.ExecutionTime et : Job.ExecutionTime.values())
     {
@@ -232 +242 @@
     Check the database for jobs that are waiting to be executed.
     We sort the jobs by priority and creation time and try to execute 
-    them in that order. Each job is encapuslated in a {@link JobRunner}
+    them in that order. Each job is encapsulated in a {@link JobRunner}
     object which is started in it's own thread.
   */
@@ -242 +252 @@
     {
       dc = sc.newDbControl();
+      String hqlName = ignoreUseInternalJobQueueFlag ? 
+        "FIND_JOBS_IN_QUEUE" : "FIND_INTERNAL_JOBS_IN_QUEUE";
+      
       org.hibernate.Query query = 
-        HibernateUtil.getPredefinedQuery(dc.getHibernateSession(), "FIND_JOBS_IN_QUEUE");
+        HibernateUtil.getPredefinedQuery(dc.getHibernateSession(), hqlName);
       /*
         SELECT job
@@ -249 +262 @@
         WHERE job.status = :status
         AND job.type = :type
+        [AND job.pluginDefinition.useInternalJobQueue = true]
         ORDER BY job.priority ASC, job.created ASC
       */

trunk/src/core/net/sf/basedb/core/PluginDefinition.java

@@ -775 +775 @@
   
   /**
+    If this plug-in can be executed by the internal job queue or
+    not. If not, the plug-in must be configured to be executed by a 
+    job agent. NOTE! The plug-in can always be excuted by job agents,
+    they ignore this value.
+    
+    @return TRUE if the internal job queue is used, FALSE if not
+    @since 2.5
+  */
+  public boolean getUseInternalJobQueue()
+  {
+    return getData().getUseInternalJobQueue();
+  }
+  /**
+    Set if the plug-in can use the internal job queue or not.
+    @param use TRUE to use the internal job queue, FALSE to only use
+      job agents
+    @since 2.5
+  */
+  public void setUseInternalJobQueue(boolean use)
+  {
+    checkPermission(Permission.WRITE);
+    getData().setUseInternalJobQueue(use);
+  }
+  
+  /**
     Check if it makes sense to use this plugin in the context
     of the specified item. For example, a plugin that imports

trunk/src/core/net/sf/basedb/core/Update.java

@@ -522 +522 @@
   </tr>
 
-
+  <tr>
+    <td>45</td>
+    <td>
+      <ul>
+      <li>Added {@link net.sf.basedb.core.data.PluginDefinitionData#getUseInternalJobQueue()}
+      </ul>
+      The update sets all values on existing items to true (if no job agent has been 
+      configured for the plug-in) or false (if a job agent is configured).
+    </td>
+  </tr>
   </table>
 
@@ -741 +750 @@
         if (progress != null) progress.display((int)(43*progress_factor), "--Updating schema version: " + schemaVersion + " -> 44...");
         schemaVersion = updateToSchemaVersion44(sc);
+      }
+      
+      if (schemaVersion < 45)
+      {
+        if (progress != null) progress.display((int)(44*progress_factor), "--Updating schema version: " + schemaVersion + " -> 45...");
+        schemaVersion = updateToSchemaVersion45(session);
       }
 
@@ -1649 +1664 @@
       // Commit the changes
       HibernateUtil.commit(tx);
-      log.info("updateToSchemaVersion40: OK");
+      log.info("updateToSchemaVersion43: OK");
     }
     catch (BaseException ex)
     {
       if (tx != null) HibernateUtil.rollback(tx); 
-      log.error("updateToSchemaVersion40: FAILED", ex);
+      log.error("updateToSchemaVersion43: FAILED", ex);
       throw ex;
     }
@@ -1866 +1881 @@
       session.save(pk);
     }
+  }
+  
+  /**
+    Update useInternalJobQueue for plug-ins.
+    @return The new schema version (=45)
+  */
+  private static int updateToSchemaVersion45(org.hibernate.Session session)
+  {
+    final int schemaVersion = 45;
+    org.hibernate.Transaction tx = null;
+    try
+    {
+      tx = HibernateUtil.newTransaction(session);
+  
+      // Change property values
+      org.hibernate.Query query = HibernateUtil.createQuery(session, 
+        "SELECT DISTINCT jas.pluginDefinition FROM JobAgentSettingsData jas");
+      List<PluginDefinitionData> plugins = 
+        HibernateUtil.loadList(PluginDefinitionData.class, query, null);
+      
+      for (PluginDefinitionData pd : plugins)
+      {
+        pd.setUseInternalJobQueue(false);
+      }
+  
+      // Update the schema version number
+      setSchemaVersion(session, schemaVersion);
+  
+      // Commit the changes
+      HibernateUtil.commit(tx);
+      log.info("updateToSchemaVersion45: OK");
+    }
+    catch (BaseException ex)
+    {
+      if (tx != null) HibernateUtil.rollback(tx); 
+      log.error("updateToSchemaVersion45: FAILED", ex);
+      throw ex;
+    }
+    return schemaVersion;   
   }
   
@@ -2227 +2281 @@
         }
       
+        if (schemaVersion < 45)
+        {
+          // Set useInternalJobQueue to true for all plug-ins
+          org.hibernate.Query query = HibernateUtil.getPredefinedQuery(session, 
+            "SET_USEJOBQUEUE_ON_PLUGINS");
+          /*
+            UPDATE PluginDefinitionData pld
+            SET pld.useInternalJobQueue = true
+            WHERE pld.useInternalJobQueue IS NULL
+          */
+          HibernateUtil.executeUpdate(query);
+        }       
+        
         //  Commit the changes
         HibernateUtil.commit(tx);

trunk/src/core/net/sf/basedb/core/data/PluginDefinitionData.java

@@ -449 +449 @@
   }
   
-  
-
+  private boolean useInternalJobQueue = true;
+  /**
+    If the plug-in can be executed with the internal job queue or
+    not. If FALSE is used, the plug-in can only be executed by a
+    job agent or other external tool.
+    @since 2.5
+    @hibernate.property column="`use_internal_queue`" type="boolean" not-null="true"
+  */
+  public boolean getUseInternalJobQueue()
+  {
+    return useInternalJobQueue;
+  }
+  public void setUseInternalJobQueue(boolean useInternalJobQueue)
+  {
+    this.useInternalJobQueue = useInternalJobQueue;
+  }
+  
 }

trunk/www/admin/jobagents/index.jsp

@@ -165 +165 @@
       if (pluginId != -1) 
       {
-        JobAgentSettings settings = agent.getSettings(PluginDefinition.getById(dc, pluginId), true);
+        PluginDefinition plugin = PluginDefinition.getById(dc, pluginId);
+        if (plugin.hasPermission(Permission.WRITE) && plugin.getUseInternalJobQueue())
+        {
+          plugin.setUseInternalJobQueue(false);
+        }
+        JobAgentSettings settings = agent.getSettings(plugin, true);
         if (!settings.isInDatabase()) 
         {

trunk/www/admin/plugindefinitions/edit_plugin.jsp

@@ -239 +239 @@
         new AgentSetting(agentId, '', '', '', '0');
       }
+      var numBefore = document.forms['plugin'].agents.length;
       Link.addItem(document.forms['plugin'].agents, item);
+      var numAfter = document.forms['plugin'].agents.length;
+      if (numBefore == 0 && numAfter > 0)
+      {
+        document.forms['plugin'].use_internal_jobqueue.checked = false;
+      }
       agentsOnClick();
     }
@@ -276 +282 @@
     {
       var agents = document.forms['plugin'].agents;
+      Link.addNewSection(agents, new Section('A', 'Job agents'));
       <%
       if (agentQuery != null)
@@ -715 +722 @@
 
     <h3 class="docked"><%=title%> <base:help tabcontrol="settings" /></h3>
-    <t:tabcontrol id="settings" contentstyle="<%="height: "+(int)(scale*260)+"px;"%>" 
+    <t:tabcontrol id="settings" contentstyle="<%="height: "+(int)(scale*300)+"px;"%>" 
       position="bottom" remember="<%=plugin != null%>" active="<%=selectedAgentId == -1 ? null : "agents" %>">
     <t:tab id="info" title="Plugin" validate="validatePlugin()" helpid="plugindefinition.edit">
@@ -910 +917 @@
     
     <t:tab id="agents" title="Job agents" helpid="plugindefinition.jobagents">
-      <table >
+      <table class="form">
       <tr valign="top">
+      <td class="prompt">Run this plugin on</td>
       <td>
-        <b>Run this plugin on</b><br>
-        <select name="agents" size="15" multiple style="width: 15em;" 
+        <input type="checkbox" name="use_internal_jobqueue" value="1"
+          <%=plugin == null || plugin.getUseInternalJobQueue() ? "checked" : "" %>>
+          internal job queue
+      </td>
+      </tr>
+      <tr>
+      <td>
+        <select name="agents" size="12" multiple style="width: 15em;" 
           onclick="agentsOnClick()">
         </select>
@@ -921 +935 @@
       </td>
       <td>
-        <br>
         <table width="150">
         <tr><td><base:button 
@@ -937 +950 @@
         <br>
         <div id="agentsettings" style="display: none;">
+        <b>Settings for the selected job agent</b>
         <table border="0" cellspacing="0" class="form">
         <tr>

trunk/www/admin/plugindefinitions/index.jsp

@@ -283 +283 @@
     plugin.setMaxMemory(Values.parseBytes(request.getParameter("maxMemory"), null));
     plugin.setTrusted(Values.getBoolean(request.getParameter("trusted")));
+    plugin.setUseInternalJobQueue(Values.getBoolean(request.getParameter("use_internal_jobqueue")));
     String aie = Values.getStringOrNull(request.getParameter("allow_immediate_execution"));
     plugin.setAllowImmediateExecution(aie == null ? 

trunk/www/admin/plugindefinitions/list_plugins.jsp

@@ -410 +410 @@
         datatype="boolean"
         title="Trusted"
+        sortable="true" 
+        filterable="true"
+        exportable="true"
+      />
+      <tbl:columndef 
+        id="useInternalJobQueue"
+        property="useInternalJobQueue"
+        datatype="boolean"
+        title="Use internal job queue"
         sortable="true" 
         filterable="true"
@@ -666 +675 @@
                 <tbl:cell column="maxMemory"><%=Values.formatBytes(item.getMaxMemory())%></tbl:cell>
                 <tbl:cell column="trusted"><%=item.isTrusted() ? "yes" : "no"%></tbl:cell>
+                <tbl:cell column="useInternalJobQueue"><%=item.getUseInternalJobQueue() ? "yes" : "no"%></tbl:cell>
                 <tbl:cell column="allowImmediateExecution"><%=item.getAllowImmediateExecution() ? "yes" : "no"%></tbl:cell>
                 <tbl:cell column="owner"

trunk/www/admin/plugindefinitions/view_plugin.jsp

@@ -319 +319 @@
       </tr>     
       <tr>
+        <td class="prompt">Use internal job queue</td>
+        <td><%=plugin.getUseInternalJobQueue() ? "yes" : "no"%></td>
+      </tr>     
+      <tr>
         <td class="prompt" valign="baseline">Items</td>
         <td><%=Values.getString(contexts, ", ", true)%></td>

trunk/www/include/scripts/main.js

@@ -422 +422 @@
     this.controllers['NEWS'] = { url:'admin/news/index.jsp', width:540, height:400 };
     this.controllers['PLUGINCONFIGURATION'] = { url:'admin/pluginconfigurations/index.jsp', width:500, height:340 };
-    this.controllers['PLUGINDEFINITION'] = { url:'admin/plugindefinitions/index.jsp', width:700, height:400 };
+    this.controllers['PLUGINDEFINITION'] = { url:'admin/plugindefinitions/index.jsp', width:720, height:440 };
     this.controllers['PLUGINTYPE'] = { url:'admin/plugintypes/index.jsp', width:700, height:400 };
     this.controllers['JOBAGENT'] = { url:'admin/jobagents/index.jsp', width:700, height:400 };