KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > pushwithreturn > KeyGenerator


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): Vivien Quema
22  * Contributor(s):
23  */
24
25 package org.objectweb.dream.pushwithreturn;
26
27 import org.objectweb.dream.message.Message;
28
29 /**
30  * This interface defines a key generator. Such a generator allows generating
31  * keys for identifying messages.
32  * <p>
33  * Note that a key generator may change the message: it can, for instance,
34  * insert a chunk that contains the key.
35  *
36  * @see Key
37  */
38 public interface KeyGenerator
39 {
40   /** The commonly used name to refer to this interface. */
41   String JavaDoc ITF_NAME = "key-generator";
42
43   /**
44    * Generates a key for the given message. This method possibly adds a
45    * <code>KeyChunk</code> to the message.
46    *
47    * @param message the message for which a key must be generated.
48    * @return the generated key.
49    * @throws Exception if this is not possible to generate a key (for instance
50    * when the generator try to add a Chunk to a non extensible
51    * message).
52    */
53   Key generateKey(Message message) throws Exception JavaDoc;
54
55 }
Popular Tags