source: trunk/config/dist/jobagent.properties @ 5447

# $Id: migrate.properties.in 2614 2006-08-31 11:13:36Z nicklas $
#
# Copyright (C) 2006 Nicklas Nordborg
#
# This file is part of BASE - BioArray Software Environment.
# Available at http://base.thep.lu.se/
#
# BASE is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# BASE is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with BASE. If not, see <http://www.gnu.org/licenses/>.

# =======================
# BASE settings
# =======================

## The login and password for a BASE user that the agent should run as
## The use must have privileges corresponding to the predefined 'Job agent' role.
agent.user=jobagent
agent.password=

## The ID of this job agent. This is the value used for the external ID property
## in the database and used for automatic registration of the job agent
## THE ID MUST BE UNIQUE AMONG ALL RUNNING JOB AGENTS
agent.id=local
agent.name=Local job agent
agent.description=This is the default job agent running on the same server as the web server

# =======================
# Job agent server settings
# =======================

## The port the job agen should listen to for incoming control requests
## such as the start, stop, pause and info command
agent.port=47822

## Comma-separated list of computer ip-adresses or names that are allowed
## to remotely control this job agent. If the web server is on another
## computer this list should at least include that server. The local
## host is always allowed remote control and doesn't have to be in the list
agent.remotecontrol=

## If the computers listed above also should be allowed to stop, start and/or
## pause the job agent or not
agent.allowremote.stop=false
agent.allowremote.start=true
agent.allowremote.pause=true

# ==============================
# Custom remote control handlers
# ==============================

## Handlers for custom remote control can be registered with one or more
## settings like the one below. Replace 'foo' with the actual name of the 
## protocol. The class must implement the CustumRequestHandler
## interface. Requests are sent to the handler on the agent's remote control
## port: foo://more-custom-data .....
# agent.request-handler.foo = <class-name>


# ============================
# Job agent execution settings
# ============================

## The name of the executor class that is responsible for starting the job
## The default is ProcessJobExecutor which starts job in a separate process
## The class must implement the net.sf.basedb.clients.JobExecutor interface

# -------------------------------------------------------------------
# Executor that executes the jobs in a separate process (recommended)
# Options: 
#  java = Path to the java executable
#  options = Extra command line options to pass to the java executable
# -------------------------------------------------------------------
agent.executor.class=net.sf.basedb.clients.jobagent.executors.ProcessJobExecutor
agent.executor.process.java=java
agent.executor.process.options=-server

# -------------------------------------------------------------------
# Executor that executes jobs in the same process as the job agent (not recommended)
# -------------------------------------------------------------------
# agent.executor.class=net.sf.basedb.clients.jobagent.executors.ThreadJobExecutor

# -------------------------------------------------------------------
# Executor useful for debugging purposes. It just marks the job as 
# executed without really executing it.
# Options:
#  wait = Number of seconds it takes to execute a job
# -------------------------------------------------------------------
# agent.executor.class=net.sf.basedb.clients.jobagent.executors.DummyJobExecutor
# agent.executor.dummy.wait=120


## Number of seconds between checks to the job queue
agent.checkinterval=30


# ============================
# Slot manager settings
# ============================

## The name of the slot manager class that is responsible for assigning a slot
## to the job. The default is the InternalSlotManager which assign slots based
## on the estimated execution time.
agent.slotmanager.class=net.sf.basedb.clients.jobagent.slotmanager.InternalSlotManager

# -------------------------------------------------------------------
# The master slot manager is like the internal slot manager but also
# accepts slot assignment on behalf of other job agents. The other
# job agents should use the ExternalSlotManager and connect to the
# remote control port of this job agent.
# -------------------------------------------------------------------
# agent.slotmanager.class=net.sf.basedb.clients.jobagent.slotmanager.MasterSlotManager

# -------------------------------------------------------------------
# The remote slot manager uses another jobagent to assign slots.
# The other job agent should use the MasterSlotManager
# Options
#  server=The name/ip of the other job agent
#  port=The remote control port of the job agent
# -------------------------------------------------------------------
# agent.slotmanager.class=net.sf.basedb.clients.jobagent.slotmanager.RemoteSlotManager
# agent.slotmanager.remote.server=
# agent.slotmanager.remote.port=

## Note! A quick job may use a slot from any of the pools reserved for
## slower jobs if there are unused slots. Priority values should be between
## 1 and 10, with 10 as the maximum priority. 
## See http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html

## Number of slots to reserved for jobs that takes < 1 minute to execute
agent.shortest.slots=1
agent.shortest.priority=4

## Number of slots to reserved for jobs that takes < 10 minutes to execute
agent.short.slots=1
agent.short.priority=4

#" Number of slots to reserved for jobs that takes < 1 hour to execute
agent.medium.slots=2
agent.medium.priority=3

# Number of slots to reserved for jobs that takes > 1 hour to execute
agent.long.slots=2
agent.long.priority=3