KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mr > api > simple > SimpleAPI


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 Uri Schneider.
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.simple;
47
48 import org.mr.MantaAgentConstants;
49
50 /**
51  * SimpleAPI.java
52  *
53  * This is the entry point object for using the 'simple' API. It
54  * allows sending and receiving messages using queues and topics,
55  * nothing more, nothing less.
56  *
57  * Created: Thu Jun 24 18:47:37 2004
58  *
59  * @author Uri Schneider
60  * @version 1.0
61  */
62 public class SimpleAPI {
63     
64     /**
65      * Default constructor. The Manta installation dir is taken to be
66      * the current working directory.
67      */
68     public SimpleAPI() {
69         this(".");
70     }
71
72     /**
73      * Creates a new <code>SimpleAPI</code> instance, specifying the
74      * installation location of Manta (Manta!).
75      *
76      * @param mantaConf where MantaRay's configuratio file resides.
77      */
78     public SimpleAPI(String JavaDoc mantaConf) {
79         System.setProperty(MantaAgentConstants.MANTA_CONFIG, mantaConf);
80     }
81
82     /**
83      * Create a new <code>Producer</code> object, which can be used to send
84      * messages to the queue named <code>queueName</code>.
85      *
86      * @param queueName The name of the queue the returned object will use.
87      * @return a <code>Producer</code>
88      * @throws SimpleException If a queue by the name of <code>queueName</code>
89      * does not exist.
90      * @see Producer
91      */
92     public Producer openProducer(String JavaDoc queueName) throws SimpleException {
93         return new Producer(queueName);
94     }
95
96     /**
97      * Create a new <code>Consumer</code> object, which can be used to receive
98      * messages from the queue named <code>queueName</code>.
99      *
100      * @param queueName The name of the queue the returned object will use.
101      * @return a <code>Consumer</code>
102      * @throws SimpleException If a queue by the name of <code>queueName</code>
103      * does not exist.
104      * @see Consumer
105      */
106     public Consumer openConsumer(String JavaDoc queueName) throws SimpleException {
107         return new Consumer(queueName);
108     }
109
110     /**
111      * Create a new <code>Publisher</code> object, which can be used to send
112      * messages to the topic named <code>topicName</code>.
113      *
114      * @param topicName The name of the topic the returned object will use.
115      * @return a <code>Producer</code>
116      * @throws SimpleException If a topic by the name of <code>queueName</code>
117      * does not exist.
118      * @see Publisher
119      */
120     public Publisher openPublisher(String JavaDoc topicName) throws SimpleException {
121         return new Publisher(topicName);
122     }
123
124     /**
125      * Create a new <code>Subscriber</code> object, which can be used to receive
126      * messages from the topic named <code>topicName</code>.
127      *
128      * @param topicName The name of the topic the returned object will use.
129      * @return a <code>Subscriber</code>
130      * @throws SimpleException If a topic by the name of <code>queueName</code>
131      * does not exist.
132      * @see Subscriber
133      */
134     public Subscriber openSubscriber(String JavaDoc topicName) throws SimpleException {
135         return new Subscriber(topicName);
136     }
137 } // SimpleAPI
138
Popular Tags