akka.contrib.pattern
Interface ShardRegion.MessageExtractor

Enclosing class:
ShardRegion

public static interface ShardRegion.MessageExtractor

Java API: Interface of functions to extract entry id, shard id, and the message to send to the entry from an incoming message.


Method Summary
 java.lang.String entryId(java.lang.Object message)
          Extract the entry id from an incoming message.
 java.lang.Object entryMessage(java.lang.Object message)
          Extract the message to send to the entry from an incoming message.
 java.lang.String shardId(java.lang.Object message)
          Extract the entry id from an incoming message.
 

Method Detail

entryId

java.lang.String entryId(java.lang.Object message)
Extract the entry id from an incoming message. If null is returned the message will be unhandled, i.e. posted as Unhandled messages on the event stream

Parameters:
message - (undocumented)
Returns:
(undocumented)

entryMessage

java.lang.Object entryMessage(java.lang.Object message)
Extract the message to send to the entry from an incoming message. Note that the extracted message does not have to be the same as the incoming message to support wrapping in message envelope that is unwrapped before sending to the entry actor.

Parameters:
message - (undocumented)
Returns:
(undocumented)

shardId

java.lang.String shardId(java.lang.Object message)
Extract the entry id from an incoming message. Only messages that passed the entryId(java.lang.Object) function will be used as input to this function.

Parameters:
message - (undocumented)
Returns:
(undocumented)