jmsmessagefactory.java

Quartz is a full-featured, open source job scheduling system that can be integrated with, or used al

/* 
 * Copyright 2004-2005 OpenSymphony 
 * 
 * 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.
 * 
 */

/*
 * Previously Copyright (c) 2001-2004 James House
 */
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<code>javax.jms.Message</code>.
 * This interface is used in constructing a <code>javax.jms.Message</code> 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 <code>javax.jms.Message</code>.
     * 
     * @param jobDataMap the <code>JobDataMap</code>
     * @param session the <code>javax.jms.Session</code>
     * 
     * @return the <code>javax.jms.Message</code>
     */
    Message createMessage(JobDataMap jobDataMap, Session session);
}