KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mr > api > jms > MantaQueue


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 Nimo.
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 package org.mr.api.jms;
47 import java.io.IOException JavaDoc;
48 import java.io.Serializable JavaDoc;
49
50 import javax.jms.JMSException JavaDoc;
51 import javax.jms.Queue JavaDoc;
52
53 import org.mr.core.util.byteable.Byteable;
54 import org.mr.core.util.byteable.ByteableInputStream;
55 import org.mr.core.util.byteable.ByteableOutputStream;
56 import org.mr.core.util.byteable.ByteableRegistry;
57
58 /**
59  * A <CODE>Queue</CODE> object encapsulates a provider-specific queue name.
60  * It is the way a client specifies the identity of a queue to JMS API methods.
61  * For those methods that use a <CODE>Destination</CODE> as a parameter, a
62  * <CODE>Queue</CODE> object used as an argument. For example, a queue can be
63  * used to create a <CODE>MessageConsumer</CODE> and a <CODE>MessageProducer
64  * </CODE> by calling:
65  * <UL>
66  * <LI><CODE>Session.CreateConsumer(Destination destination)</CODE>
67  * <LI><CODE>Session.CreateProducer(Destination destination)</CODE>
68  *
69  * </UL>
70  *
71  * <P>
72  * The actual length of time messages are held by a queue and the consequences
73  * of resource overflow are not defined by the JMS API.
74  *
75  *
76  * @author Nimo
77  */
78 public class MantaQueue
79     extends MantaDestination
80     implements Byteable, Serializable JavaDoc, Queue JavaDoc {
81
82     /**
83      * Consturcts a nameless queue. this shouldn't be used.
84      *
85      */
86     public MantaQueue() {
87         this.destinationName = " ";
88     }
89     
90     /**
91      * Creates a queue with the given name.
92      * @param name
93      */
94     public MantaQueue(String JavaDoc name) {
95         this.destinationName = name;
96     } //MantaQueue
97
98     
99     public String JavaDoc toString() {
100         return this.destinationName;
101     } //toString
102
103     /**
104      * Get the name for the object.
105      */
106     public String JavaDoc getQueueName() {
107         return this.destinationName;
108     }
109
110     public static final String JavaDoc BYTEABLENAME = "MantaQueue";
111     public String JavaDoc getByteableName() {
112
113         return BYTEABLENAME;
114     }
115
116     
117     public void toBytes(ByteableOutputStream out) throws IOException JavaDoc {
118
119         out.writeUTF(this.destinationName);
120
121     }
122
123     public Byteable createInstance(ByteableInputStream in) throws IOException JavaDoc {
124
125         MantaQueue cq = new MantaQueue();
126         cq.destinationName = in.readUTF();
127         return cq;
128     }
129
130     public void registerToByteableRegistry() {
131         ByteableRegistry.registerByteableFactory(getByteableName() , this);
132         
133     }
134     
135     public static void register() throws JMSException JavaDoc{
136         MantaQueue instance = new MantaQueue();
137         instance.registerToByteableRegistry();
138     }
139    
140
141 } //MantaQueue
142
Popular Tags