01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package org.jboss.resource.adapter.jms.inflow;
23:
24: import javax.jms.Message;
25: import javax.naming.Context;
26:
27: /**
28: * An interface for DLQ Handling
29: *
30: * @author <a href="adrian@jboss.com">Adrian Brock</a>
31: * @version $Revision: 57189 $
32: */
33: public interface DLQHandler {
34: /** JMS property name holding original destination. */
35: static final String JBOSS_ORIG_DESTINATION = "JBOSS_ORIG_DESTINATION";
36:
37: /** JMS property name holding original JMS message id. */
38: static final String JBOSS_ORIG_MESSAGEID = "JBOSS_ORIG_MESSAGEID";
39:
40: /** Standard property for delivery count */
41: static final String PROPERTY_DELIVERY_COUNT = "JMSXDeliveryCount";
42:
43: /**
44: * Set up the DLQ
45: *
46: * @param activation the activation
47: * @param ctx the naming context
48: * @throws Exception for any error
49: */
50: void setup(JmsActivation activation, Context ctx) throws Exception;
51:
52: /**
53: * Tear down the DLQ
54: */
55: void teardown();
56:
57: /**
58: * Check whether the DLQ should handle the message
59: *
60: * @param msg the message about to be delivered
61: * @return true if the message is handled and should not be delivered
62: */
63: boolean handleRedeliveredMessage(Message msg);
64:
65: /**
66: * Notification that the message was delivered
67: *
68: * @param msg the message that was delivered
69: */
70: void messageDelivered(Message msg);
71: }
|