MessageCreator


1   /*
2    * Copyright 2002-2005 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy 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,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.jms.core;
18  
19  import javax.jms.JMSException  ;
20  import javax.jms.Message  ;
21  import javax.jms.Session  ;
22  
23  /**
24   * Creates a JMS message given a {@link Session}.
25   * 
26   * <p>The <code>Session</code> typically is provided by an instance
27   * of the {@link JmsTemplate} class.
28   *
29   * <p>Implementations <i>do not</i> need to concern themselves with
30   * checked <code>JMSExceptions</code> (from the '<code>javax.jms</code>'
31   * package) that may be thrown from operations they attempt. The
32   * <code>JmsTemplate</code> will catch and handle these
33   * <code>JMSExceptions</code> appropriately.
34   *
35   * @author Mark Pollack
36   * @since 1.1
37   */
38  public interface MessageCreator {
39  
40      /**
41       * Create a {@link Message} to be sent.
42       * @param session the JMS {@link Session} to be used to create the
43       * <code>Message</code> (never <code>null</code>) 
44       * @return the <code>Message</code> to be sent
45       * @throws javax.jms.JMSException if thrown by JMS API methods
46       */
47      Message   createMessage(Session   session) throws JMSException  ;
48  
49  }
50
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags