Class ShardingMessageExtractor<E,​M>

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      static <M> ShardingMessageExtractor<ShardingEnvelope<M>,​M> apply​(int numberOfShards)
      Scala API:
      abstract java.lang.String entityId​(E message)
      Extract the entity id from an incoming message.
      static <M> ShardingMessageExtractor<M,​M> noEnvelope​(int numberOfShards, M stopMessage, scala.Function1<M,​java.lang.String> extractEntityId)
      Scala API: Create a message extractor for a protocol where the entity id is available in each message.
      abstract java.lang.String shardId​(java.lang.String entityId)
      The shard identifier for a given entity id.
      abstract M unwrapMessage​(E message)
      Extract the message to send to the entity from an incoming message.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ShardingMessageExtractor

        public ShardingMessageExtractor()
    • Method Detail

      • apply

        public static <M> ShardingMessageExtractor<ShardingEnvelope<M>,​M> apply​(int numberOfShards)
        Scala API:

        Create the default message extractor, using envelopes to identify what entity a message is for and the hashcode of the entityId to decide which shard an entity belongs to.

        This is recommended since it does not force details about sharding into the entity protocol

        Parameters:
        numberOfShards - (undocumented)
        Returns:
        (undocumented)
      • noEnvelope

        public static <M> ShardingMessageExtractor<M,​M> noEnvelope​(int numberOfShards,
                                                                         M stopMessage,
                                                                         scala.Function1<M,​java.lang.String> extractEntityId)
        Scala API: Create a message extractor for a protocol where the entity id is available in each message.
        Parameters:
        numberOfShards - (undocumented)
        stopMessage - (undocumented)
        extractEntityId - (undocumented)
        Returns:
        (undocumented)
      • entityId

        public abstract java.lang.String entityId​(E message)
        Extract the entity 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)
      • shardId

        public abstract java.lang.String shardId​(java.lang.String entityId)
        The shard identifier for a given entity id. Only messages that passed the entityId(E) function will be used as input to this function.
        Parameters:
        entityId - (undocumented)
        Returns:
        (undocumented)
      • unwrapMessage

        public abstract M unwrapMessage​(E message)
        Extract the message to send to the entity 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 entity actor.
        Parameters:
        message - (undocumented)
        Returns:
        (undocumented)