SendDestinationMessageJob (Quartz Parent POM 2.0.1 API)

Quartz Java



org.quartz.jobs.ee.jms Class SendDestinationMessageJob

java.lang.Object
  extended by org.quartz.jobs.ee.jms.SendDestinationMessageJob
All Implemented Interfaces:
Job

public final class SendDestinationMessageJob
extends Object
implements Job

A Job that sends a javax.jms.Message to a javax.jms.Destination. Note, this class can only be used in a JMS 1.1 compliant environment.

The following properties are expected to be provided in the JobDataMap:

  • JMS_CONNECTION_FACTORY_JNDI - The JNDI name of the JMS Connection Factory.
  • JMS_DESTINATION_JNDI - The JNDI name of the JMS destination.
  • JMS_USE_TXN - Whether or not to use a transacted javax.jms.Session.
  • JMS_ACK_MODE - The acknowledgement mode for the javax.jms.Session.
  • JMS_MSG_FACTORY_CLASS_NAME - The implementation class name for the JmsMessageFactory.

The following properties are optional

  • JMS_USER - The JMS user for secure destinations.
  • JMS_PASSWORD - The JMS password for secure destinations.

The following properties can be used for JNDI support:

  • INITIAL_CONTEXT_FACTORY - The java.naming.factory.initial setting for JNDI.
  • PROVIDER_URL - The java.naming.provider.url for JNDI.

Author:
Fernando Ribeiro, Weston M. Price, Frank Van Uffelen
See Also:
JmsMessageFactory

Constructor Summary
SendDestinationMessageJob()
           
 
Method Summary
 void execute(JobExecutionContext jobCtx)
           Called by the Scheduler when a Trigger fires that is associated with the Job.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SendDestinationMessageJob

public SendDestinationMessageJob()
Method Detail

execute

public void execute(JobExecutionContext jobCtx)
             throws JobExecutionException
Description copied from interface: Job

Called by the Scheduler when a Trigger fires that is associated with the Job.

The implementation may wish to set a result object on the JobExecutionContext before this method exits. The result itself is meaningless to Quartz, but may be informative to JobListeners or TriggerListeners that are watching the job's execution.

Specified by:
execute in interface Job
Throws:
JobExecutionException - if there is an exception while executing the job.


Copyright 2001-2011, Terracotta, Inc.