Package akka.pattern

Class StatusReply$

  • public class StatusReply$
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static StatusReply$ MODULE$
      Static reference to the singleton instance of this Scala object.

    • Constructor Summary

      Constructors 
      Constructor Description
      StatusReply$()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      StatusReply<Done> ack()
      Java API: A general purpose message for using as an Ack
      StatusReply<Done> Ack()
      Scala API: A general purpose message for using as an Ack
      <T> StatusReply<T> error​(java.lang.String errorMessage)
      Java API: Create an status response with a error message describing why the request was failed or denied.
      <T> StatusReply<T> error​(java.lang.Throwable exception)
      Java API: Create an error response with a user defined Throwable.
      <T> StatusReply<T> fromTry​(scala.util.Try<T> status)
      Scala API: Turn a try into a status reply.
      <T> StatusReply<T> fromTryKeepException​(scala.util.Try<T> status)
      Scala API: Turn a Try into a status reply.
      <T> StatusReply<T> success​(T value)
      Java API: Create a successful reply containing value

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • MODULE$

        public static final StatusReply$ MODULE$
        Static reference to the singleton instance of this Scala object.

    • Constructor Detail

      • StatusReply$

        public StatusReply$()

    • Method Detail

      • Ack

        public StatusReply<Done> Ack()
        Scala API: A general purpose message for using as an Ack

      • ack

        public StatusReply<Done> ack()
        Java API: A general purpose message for using as an Ack

      • success

        public <T> StatusReply<T> success​(T value)
        Java API: Create a successful reply containing value

      • error

        public <T> StatusReply<T> error​(java.lang.String errorMessage)
        Java API: Create an status response with a error message describing why the request was failed or denied.

      • error

        public <T> StatusReply<T> error​(java.lang.Throwable exception)
        Java API: Create an error response with a user defined Throwable.

        Prefer the string based error response over this one when possible to avoid tightly coupled logic across actors and passing internal failure details on to callers that can not do much to handle them.

        For cases where types are needed to identify errors and behave differently enumerating them with a specific set of response messages may be a better alternative to encoding them as generic exceptions.

        Also note that Akka does not contain pre-build serializers for arbitrary exceptions.

      • fromTryKeepException

        public <T> StatusReply<T> fromTryKeepException​(scala.util.Try<T> status)
        Scala API: Turn a Try into a status reply.

        Prefer the string based error response over this one when possible to avoid tightly coupled logic across actors and passing internal failure details on to callers that can not do much to handle them. fromTry(scala.util.Try<T>) provides a convenience factory doing that for Try.

        For cases where types are needed to identify errors and behave differently enumerating them with a specific set of response messages may be a better alternative to encoding them as generic exceptions.

        Also note that Akka does not contain pre-built serializers for arbitrary exceptions.

      • fromTry

        public <T> StatusReply<T> fromTry​(scala.util.Try<T> status)
        Scala API: Turn a try into a status reply.

        Transforms exceptions into status reply errors containing just the exception message string.

        See fromTryKeepException(scala.util.Try<T>) for passing the exception along as is.