Push


1   /**
2    * Dream
3    * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4    *
5    * This library is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU Lesser General Public
7    * License as published by the Free Software Foundation; either
8    * version 2 of the License, or (at your option) any later version.
9    *
10   * This library is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   * Lesser General Public License for more details.
14   *
15   * You should have received a copy of the GNU Lesser General Public
16   * License along with this library; if not, write to the Free Software
17   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   *
19   * Contact : dream@objectweb.org
20   *
21   * Initial developer(s): Matthieu Leclercq
22   * Contributor(s): Vivien Quema
23   */
24  
25  package org.objectweb.dream;
26  
27  import java.util.Map  ;
28  
29  import org.objectweb.dream.message.Message;
30  
31  /**
32   * Common <I>Push </I> interface for Dream components This interface defines a
33   * method <code>push</code> that allows a component to give a message to
34   * another component.
35   */
36  public interface Push
37  {
38  
39    /**
40     * The commonly used name to refer to this interface when it is used as an
41     * output.
42     */
43    String   OUT_PUSH_ITF_NAME = "out-push";
44  
45    /**
46     * The commonly used name to refer to this interface when it is used as an
47     * input.
48     */
49    String   IN_PUSH_ITF_NAME  = "in-push";
50  
51    /**
52     * Gives a message to a component.
53     * 
54     * @param message the message to give to the component.
55     * @param context a general purpose context map. can be <code>null</code>.
56     * @throws PushException if an exception occurs.
57     */
58    void push(Message message, Map   context) throws PushException;
59  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags