Configuring Quartz RMI Settings

When using Quartz via RMI, you need to start an instance of Quartz with it configured to "export" its services via RMI. You can then create clients that connect to the server by configuring a Quartz scheduler to "proxy" its work to the server. Table A.3 lists the available RMI settings.

Table A.3. The Properties for Using RMI with Quartz

Name	Required	Type	Default Value
org.quartz.scheduler.rmi.export	No	Boolean	false
org.quartz.scheduler.rmi.registryHost	No	String	localhost
org.quartz.scheduler.rmi.registryPort	No	Integer	1099
org.quartz.scheduler.rmi.createRegistry	No	String	never
org.quartz.scheduler.rmi.serverPort	No	Integer	Random
org.quartz.scheduler.rmi.proxy	No	Boolean	False

 

org.quartz.scheduler.rmi.export

Set this to TRue if you want the Quartz Scheduler to export itself via RMI as a server.

org.quartz.scheduler.rmi.registryHost

This is the host at which the RMI Registry can be found. The default is localhost.

org.quartz.scheduler.rmi.registryPort

This is the port on which the RMI Registry is listening. The default is 1099.

org.quartz.scheduler.rmi.createRegistry

Set this property according to how you want Quartz to create an RMI Registry. Use false or never if you don't want Quartz to create a registry (for example, if you already have an external registry running). Use true or as_needed if you want Quartz to first attempt to use an existing registry and then fall back to creating one. Use always if you want Quartz to attempt to create a registry and then fall back to using an existing one. If a registry is created, it will be bound to a port number in the given org.quartz.scheduler.rmi.registryPort property, and org.quartz.rmi.registryHost should be localhost.

org.quartz.scheduler.rmi.serverPort

This indicates the port on which the Quartz Scheduler service will bind and listen for connections. By default, the RMI service randomly selects a port as the scheduler is bound to the RMI registry.

org.quartz.scheduler.rmi.proxy

Set this property to true if you want to connect to a remotely served Scheduler. You must also then specify a host and port for the RMI Registry process, which is typically localhost port 1099. Do not specify true for both org.quartz.scheduler.rmi.export and org.quartz.scheduler.rmi.proxy in the same config file; if you do, the export option will be ignored. A value of false for both export and proxy properties is, of course valid, if you're not using Quartz via RMI.

For more information on using Quartz with RMI, see Chapter 10, "Using Quartz with J2EE."