ThinMessagingInterface


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 Amir Shevat.
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  
47  package org.mr.api.rmi.thin;
48  
49  import java.rmi.RemoteException  ;
50  
51  /**
52   * 
53   * * this RMI interface gives the abillity of messaging to clients that can not keep there own 
54   * session like scripts.
55   * it will keep the consumers and producers for the remote rmi session , the key to the session is 
56   * the userKey passed in every request
57   * 
58   * @author Amir Shevat
59   *
60   */
61  public interface ThinMessagingInterface extends java.rmi.Remote   {
62      
63      /**
64       * send a message to a given queue name, creates a producer for the queue if needed
65       * @param userKey the key of the session
66       * @param queueName the name of the queue to be enqueued
67       * @param msg the message to be enqueued
68       * @return true if sent ok
69       * @throws RemoteException
70       */
71      public  boolean enqueueMessage(String   userKey, String   queueName, String   msg) throws RemoteException  ;
72      /**
73       * returns the payload of a dequeued message or null if non
74       * @param userKey the key of the session
75       * @param queueName the queue to be dequeued
76       * @return the String payload of the message in the queue
77       * @throws RemoteException
78       */
79      public  String   denqueueMessage(String   userKey, String   queueName) throws RemoteException  ;
80      /**
81       * Returns the list of available queues
82       * @return list of available queues String names
83       * @throws RemoteException
84       */
85      public String  [] getQueues() throws RemoteException  ;
86      
87      /**
88       * publish a message on a given topic name
89       * @param userKey the key of the session 
90       * @param topicName the topic to publish to
91       * @param msg a text message to be sent
92       * @throws RemoteException
93       */
94      public void publishMessage(String   userKey, String   topicName, String   msg) throws RemoteException  ;
95      
96      /**
97       * adds a TopicGatherListener to the topic messages can be pulled from the listener with getMessageFromTopic
98       * @param userKey the key of the session
99       * @param topicName the topic to add the listener to
100      * @param messagesToCash the number of messages the TopicGatherListener with cash for you
101      * @throws RemoteException
102      */
103     public void subscribe(String   userKey, String   topicName , int messagesToCash) throws RemoteException  ;
104     
105     /**
106      * removes the listener from the topic
107      * @param userKey the key of the session
108      * @param topicName the topic to unsubscribe from
109      * @throws RemoteException
110      */
111     public void unsubscribe(String   userKey, String   topicName ) throws RemoteException  ;
112     /**
113      * should be called only after subscribe with the same userKey and  topicName
114      * @param userKey the key of the session
115      * @param topicName the topic we have subscribed and added a listener to
116      * @return the list of messages from the TopicGatherListener
117      * @throws RemoteException
118      */
119     public String  [] getMessageFromTopic(String   userKey, String   topicName ) throws RemoteException  ;
120     
121     /**
122      * Returns the list of available topics
123      * @return list of available topics String names
124      * @throws RemoteException
125      */
126     public String  [] getTopics() throws RemoteException  ;
127 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags