KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > scalagent > kjoram > jms > ConsumerReceiveRequest


1 /*
2  * JORAM: Java(TM) Open Reliable Asynchronous Messaging
3  * Copyright (C) 2001 - ScalAgent Distributed Technologies
4  * Copyright (C) 1996 - Dyade
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19  * USA.
20  *
21  * Initial developer(s): Frederic Maistre (INRIA)
22  * Contributor(s): Nicolas Tachker (ScalAgent)
23  */
24 package com.scalagent.kjoram.jms;
25
26 import java.util.Hashtable JavaDoc;
27 import java.util.Enumeration JavaDoc;
28
29 /**
30  * A <code>ConsumerReceiveRequest</code> is sent by a
31  * <code>MessageConsumer</code> when requesting a message.
32  */
33 public class ConsumerReceiveRequest extends AbstractJmsRequest
34 {
35   /** The selector for filtering messages on a queue. */
36   private String JavaDoc selector;
37   /** The time to live value of the request (negative for infinite). */
38   private long timeToLive;
39   /** <code>true</code> if the request is destinated to a queue. */
40   private boolean queueMode;
41
42
43   /**
44    * Constructs a <code>ConsumerReceiveRequest</code>.
45    *
46    * @param targetName Name of the target queue or subscription.
47    * @param selector The selector for filtering messages, if any.
48    * @param timeToLive Time to live value in milliseconds, negative for
49    * infinite.
50    * @param queueMode <code>true</code> if this request is destinated to a
51    * queue.
52    */
53   public ConsumerReceiveRequest(String JavaDoc targetName, String JavaDoc selector,
54                                 long timeToLive, boolean queueMode)
55   {
56     super(targetName);
57     this.selector = selector;
58     this.timeToLive = timeToLive;
59     this.queueMode = queueMode;
60   }
61
62   /**
63    * Constructs a <code>ConsumerReceiveRequest</code>.
64    */
65   public ConsumerReceiveRequest()
66   {}
67
68   /** Sets the selector. */
69   public void setSelector(String JavaDoc selector)
70   {
71     this.selector = selector;
72   }
73
74   /** Sets the time to live value. */
75   public void setTimeToLive(long timeToLive)
76   {
77     this.timeToLive = timeToLive;
78   }
79
80   /** Sets the target destination type. */
81   public void setQueueMode(boolean queueMode)
82   {
83     this.queueMode = queueMode;
84   }
85
86   /** Returns the selector for filtering the messages. */
87   public String JavaDoc getSelector()
88   {
89     return selector;
90   }
91
92   /** Returns the time to live value in milliseconds. */
93   public long getTimeToLive()
94   {
95     return timeToLive;
96   }
97
98   /** Returns <code>true</code> if the request is destinated to a queue. */
99   public boolean getQueueMode()
100   {
101     return queueMode;
102   }
103
104   public Hashtable JavaDoc soapCode() {
105     Hashtable JavaDoc h = super.soapCode();
106     if (selector != null)
107       h.put("selector",selector);
108     h.put("timeToLive",new Long JavaDoc(timeToLive));
109     h.put("queueMode",new Boolean JavaDoc(queueMode));
110     return h;
111   }
112
113   public static Object JavaDoc soapDecode(Hashtable JavaDoc h) {
114     ConsumerReceiveRequest req = new ConsumerReceiveRequest();
115     req.setRequestId(((Integer JavaDoc) h.get("requestId")).intValue());
116     req.setTarget((String JavaDoc) h.get("target"));
117     req.setSelector((String JavaDoc) h.get("selector"));
118     req.setQueueMode(((Boolean JavaDoc) h.get("queueMode")).booleanValue());
119     req.setTimeToLive(((Long JavaDoc) h.get("timeToLive")).longValue());
120     return req;
121   }
122 }
123
Popular Tags