View Javadoc
1 /*** 2 * Redistribution and use of this software and associated documentation 3 * ("Software"), with or without modification, are permitted provided 4 * that the following conditions are met: 5 * 6 * 1. Redistributions of source code must retain copyright 7 * statements and notices. Redistributions must also contain a 8 * copy of this document. 9 * 10 * 2. Redistributions in binary form must reproduce the 11 * above copyright notice, this list of conditions and the 12 * following disclaimer in the documentation and/or other 13 * materials provided with the distribution. 14 * 15 * 3. The name "Exolab" must not be used to endorse or promote 16 * products derived from this Software without prior written 17 * permission of Exoffice Technologies. For written permission, 18 * please contact info@exolab.org. 19 * 20 * 4. Products derived from this Software may not be called "Exolab" 21 * nor may "Exolab" appear in their names without prior written 22 * permission of Exoffice Technologies. Exolab is a registered 23 * trademark of Exoffice Technologies. 24 * 25 * 5. Due credit should be given to the Exolab Project 26 * (http://www.exolab.org/). 27 * 28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS 29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT 30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 39 * OF THE POSSIBILITY OF SUCH DAMAGE. 40 * 41 * Copyright 2001,2003 (C) Exoffice Technologies Inc. All Rights Reserved. 42 * 43 * $Id: MessageManagerEventListener.java,v 1.5 2003/08/17 01:32:24 tanderson Exp $ 44 * 45 * Date Author Changes 46 * 3/1/2001 jima Created 47 */ 48 package org.exolab.jms.messagemgr; 49 50 import java.sql.Connection; 51 52 import org.exolab.jms.client.JmsDestination; 53 import org.exolab.jms.message.MessageImpl; 54 import org.exolab.jms.persistence.PersistenceException; 55 56 57 /*** 58 * A MessageManagerEventListener responds to events generated by the 59 * {@link MessageMgr}. 60 * <p> 61 * It gets notified when a message is added or removed for a particular 62 * destination. 63 * <p> 64 * Additionally, the message listener is scoped so that it only receives 65 * messages for a particular destination 66 * 67 * 68 * @version $Revision: 1.5 $ $Date: 2003/08/17 01:32:24 $ 69 * @author <a href="mailto:jima@exoffice.com">Jim Alateras</a> 70 */ 71 public interface MessageManagerEventListener { 72 73 /*** 74 * This method is called when the {@link MessageMgr} adds a message 75 * for this destination to the cache 76 * 77 * @param destination the message's destination 78 * @param message the message added to cache 79 * @return <code>true</code> if this message was accepted 80 */ 81 boolean messageAdded(JmsDestination destination, MessageImpl message); 82 83 /*** 84 * This method is called when the {@link MessageMgr} removes a 85 * message from the cache. 86 * 87 * @param destination the message's destination 88 * @param message message removed from cache 89 */ 90 void messageRemoved(JmsDestination destination, MessageImpl message); 91 92 /*** 93 * This event is called when the {@link MessageMgr} adds a persistent 94 * message to the cache. 95 * 96 * @param connection the database connection 97 * @param destination the message's destination 98 * @param message message added to cache 99 * @return <code>true</code< if the message was accepted 100 * @throws PersistenceException if there is a persistence related problem 101 */ 102 boolean persistentMessageAdded(Connection connection, 103 JmsDestination destination, 104 MessageImpl message) 105 throws PersistenceException; 106 107 /*** 108 * This event is called when the {@link MessageMgr} removes a persistent 109 * message from the cache. 110 * 111 * @param connection the database connection 112 * @param message message to remove from cache 113 * @param destination the message's destination 114 * @throws PersistenceException - if there is a persistence related problem 115 */ 116 void persistentMessageRemoved(Connection connection, 117 JmsDestination destination, 118 MessageImpl message) 119 throws PersistenceException; 120 }

This page was automatically generated by Maven