org.objectweb.dream.pushwithreturn
Interface KeyGenerator

All Known Implementing Classes:
KeyGeneratorIntegerImpl

public interface KeyGenerator

This interface defines a key generator. Such a generator allows generating keys for identifying messages.

Note that a key generator may change the message: it can, for instance, insert a chunk that contains the key.

See Also:
Key

Field Summary
static String ITF_NAME
          The commonly used name to refer to this interface.
 
Method Summary
 Key generateKey(Message message)
          Generates a key for the given message.
 

Field Detail

ITF_NAME

static final String ITF_NAME
The commonly used name to refer to this interface.

See Also:
Constant Field Values
Method Detail

generateKey

Key generateKey(Message message)
                throws Exception
Generates a key for the given message. This method possibly adds a KeyChunk to the message.

Parameters:
message - the message for which a key must be generated.
Returns:
the generated key.
Throws:
Exception - if this is not possible to generate a key (for instance when the generator try to add a Chunk to a non extensible message).


Copyright © 2003, 2005 - INRIA Rhone-Alpes - All Rights Reserved.