org.quartz.jobs.ee.jms.JmsMessageFactory Maven / Gradle / Ivy

Go to download
/* 
 * Copyright 2001-2009 Terracotta, Inc. 
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 
 * use this file except in compliance with the License. You may obtain a copy 
 * of the License at 
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0 
 *   
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 
 * License for the specific language governing permissions and limitations 
 * under the License.
 * 
 */

package org.quartz.jobs.ee.jms;

import javax.jms.Message;
import javax.jms.Session;

import org.quartz.JobDataMap;

/**
 * The JmsMessageFactory interface allows for the creation of a
 * javax.jms.Message. This interface is used in constructing a
 * javax.jms.Message that is to be sent upon execution of a JMS
 * enabled job.
 * 
 * @see SendDestinationMessageJob
 * @see SendQueueMessageJob
 * @see SendTopicMessageJob
 * 
 * @author Weston M. Price
 */
public interface JmsMessageFactory {

    /**
     * Creates a javax.jms.Message.
     * 
     * @param jobDataMap
     *            the JobDataMap
     * @param session
     *            the javax.jms.Session
     * 
     * @return the javax.jms.Message
     */
    Message createMessage(JobDataMap jobDataMap, Session session);
}