SessionAndProducer


1   /*
2    * Copyright 2002 by
3    * <a HREF="http://www.coridan.com">Coridan</a>
4    * <a HREF="mailto: support@coridan.com ">support@coridan.com</a>
5    *
6    * The contents of this file are subject to the Mozilla Public License Version
7    * 1.1 (the "License"); you may not use this file except in compliance with the
8    * License.  You may obtain a copy of the License at
9    * http://www.mozilla.org/MPL/
10   *
11   * Software distributed under the License is distributed on an "AS IS" basis,
12   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13   * for the specific language governing rights and limitations under the
14   * License.
15   *
16   * The Original Code is "MantaRay" (TM).
17   *
18   * The Initial Developer of the Original Code is Coridan.
19   * Portions created by the Initial Developer are Copyright (C) 2006
20   * Coridan Inc.  All Rights Reserved.
21   *
22   * Contributor(s): all the names of the contributors are added in the source
23   * code where applicable.
24   *
25   * Alternatively, the contents of this file may be used under the terms of the
26   * LGPL license (the "GNU LESSER GENERAL PUBLIC LICENSE"), in which case the
27   * provisions of LGPL are applicable instead of those above.  If you wish to
28   * allow use of your version of this file only under the terms of the LGPL
29   * License and not to allow others to use your version of this file under
30   * the MPL, indicate your decision by deleting the provisions above and
31   * replace them with the notice and other provisions required by the LGPL.
32   * If you do not delete the provisions above, a recipient may use your version
33   * of this file under either the MPL or the GNU LESSER GENERAL PUBLIC LICENSE.
34   
35   *
36   * This library is free software; you can redistribute it and/or modify it
37   * under the terms of the MPL as stated above or under the terms of the GNU
38   * Lesser General Public License as published by the Free Software Foundation;
39   * either version 2.1 of the License, or any later version.
40   *
41   * This library is distributed in the hope that it will be useful, but WITHOUT
42   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
43   * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
44   * License for more details.
45   */
46  
47  package org.mr.ra.inbound;
48  
49  import javax.jms.JMSException  ;
50  import javax.jms.MessageProducer  ;
51  import javax.jms.Session  ;
52  
53  /**
54   * Represents an object which has-a {@link Session} instance and
55   * an optional, lazily created {@link MessageProducer} instance
56   * which can them be used by a pooling based JMS provider for publishing
57   * messages using the session used by the current thread.
58   *
59   * @version $Revision: 1.1.1.1 $
60   */
61  public interface SessionAndProducer {
62  
63      /**
64       * Returns the current session being used to process a JMS message in the current thread.
65       */
66      public Session   getSession() throws JMSException  ;
67  
68      /**
69       * Lazily creates a message producer that can be used to send messages using the
70       * same JMS Session which is being used to dispatch messages which minimises the XA
71       * overheard of consuming and producing or allows JMS transactions to be used for consuming
72       * and producing messages.
73       *
74       * @return the current message producer or a new one is lazily created, using a null
75       *         destination so the destination must be specified on a send() method.
76       * @throws javax.jms.JMSException
77       */
78      public MessageProducer   getMessageProducer() throws JMSException  ;
79  }
80
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags