KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > quartz > jobs > ee > jms > JmsMessageFactory


1 /*
2  * Copyright 2004-2005 OpenSymphony
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
5  * use this file except in compliance with the License. You may obtain a copy
6  * of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13  * License for the specific language governing permissions and limitations
14  * under the License.
15  *
16  */

17
18 /*
19  * Previously Copyright (c) 2001-2004 James House
20  */

21 package org.quartz.jobs.ee.jms;
22
23 import javax.jms.Message JavaDoc;
24 import javax.jms.Session JavaDoc;
25
26 import org.quartz.JobDataMap;
27
28 /**
29  * The JmsMessageFactory interface allows for the creation of a<code>javax.jms.Message</code>.
30  * This interface is used in constructing a <code>javax.jms.Message</code> that is
31  * to be sent upon execution of a JMS enabled job.
32  *
33  * @see SendDesitnationMessageJob
34  * @see SendQueueMessageJob
35  * @see SendTopicMessageJob
36  *
37  * @author Weston M. Price
38  *
39  */

40 public interface JmsMessageFactory {
41     
42     /**
43      * Creates a <code>javax.jms.Message</code>.
44      *
45      * @param jobDataMap the <code>JobDataMap</code>
46      * @param session the <code>javax.jms.Session</code>
47      *
48      * @return the <code>javax.jms.Message</code>
49      */

50     Message JavaDoc createMessage(JobDataMap jobDataMap, Session JavaDoc session);
51 }
52
Popular Tags