trait PlayServiceCall[Request, Response] extends ServiceCall[Request, Response]

A service call implementation that allows plugging directly into Play's request handling.

Source
PlayServiceCall.scala
Linear Supertypes
ServiceCall[Request, Response], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlayServiceCall
  2. ServiceCall
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def invoke(wrapCall: (ServiceCall[Request, Response]) ⇒ EssentialAction): EssentialAction

    Low level hook for implementing service calls directly in Play.

    Low level hook for implementing service calls directly in Play.

    This can only be used to hook into plain HTTP calls, it can't be used to hook into WebSocket calls.

    wrapCall

    A function that takes a service call, and converts it to an EssentialAction. This action can then be composed to modify any part of the request and or response, including request and response headers and the request and response body. This does not have to be invoked at all if it's not desired, but may be useful to get the benefit of all the Lagom features such as serialization and deserialization.

    returns

    An EssentialAction to handle the call with.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from PlayServiceCall[Request, Response] to any2stringadd[PlayServiceCall[Request, Response]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PlayServiceCall[Request, Response], B)
    Implicit
    This member is added by an implicit conversion from PlayServiceCall[Request, Response] to ArrowAssoc[PlayServiceCall[Request, Response]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def ensuring(cond: (PlayServiceCall[Request, Response]) ⇒ Boolean, msg: ⇒ Any): PlayServiceCall[Request, Response]
    Implicit
    This member is added by an implicit conversion from PlayServiceCall[Request, Response] to Ensuring[PlayServiceCall[Request, Response]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (PlayServiceCall[Request, Response]) ⇒ Boolean): PlayServiceCall[Request, Response]
    Implicit
    This member is added by an implicit conversion from PlayServiceCall[Request, Response] to Ensuring[PlayServiceCall[Request, Response]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): PlayServiceCall[Request, Response]
    Implicit
    This member is added by an implicit conversion from PlayServiceCall[Request, Response] to Ensuring[PlayServiceCall[Request, Response]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): PlayServiceCall[Request, Response]
    Implicit
    This member is added by an implicit conversion from PlayServiceCall[Request, Response] to Ensuring[PlayServiceCall[Request, Response]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from PlayServiceCall[Request, Response] to StringFormat[PlayServiceCall[Request, Response]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def handleRequestHeader(handler: (RequestHeader) ⇒ RequestHeader): ServiceCall[Request, Response]

    Make any modifications necessary to the request header.

    Make any modifications necessary to the request header.

    For client service calls, this gives clients an opportunity to add custom headers and/or modify the request in some way before it is made. The passed in handler is applied before the header transformers configured for the descriptor/endpoint are applied.

    For server implementations of service calls, this will be invoked by the server in order to supply the request header. A new service call can then be returned that uses the header. The header passed in to the handler by the service call can be anything, it will be ignored - RequestHeader#DEFAULT exists for this purpose. Generally, server implementations should not implement this method directly, rather, they should use ServerServiceCall, which provides an appropriate implementation.

    handler

    A function that takes in the request header representing the request, and transforms it.

    returns

    A service call that will use the given handler.

    Definition Classes
    ServiceCall
  18. def handleResponseHeader[T](handler: (ResponseHeader, Response) ⇒ T): ServiceCall[Request, T]

    Transform the response using the given function that takes the response header and the response.

    Transform the response using the given function that takes the response header and the response.

    For client service calls, this gives clients an opportunity to inspect the response headers and status code. The passed in handler is applied after the header transformers configured for the descriptor/endpoint are applied.

    For server implementations of service calls, this will be invoked by the server in order to give the service call an opportunity to supply the response header when it supplies the response, but only if the underlying transport supports sending a response header. Generally, server implementations should not implement this method directly, rather, they should use ServerServiceCall, which provides an appropriate implementation.

    handler

    The handler.

    returns

    A service call that uses the given handler.

    Definition Classes
    ServiceCall
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def invoke(request: Request): Future[Response]

    Invoke the service call.

    Invoke the service call.

    request

    The request entity.

    returns

    A future of the response entity.

    Definition Classes
    PlayServiceCall → ServiceCall
  21. def invoke()(implicit evidence: =:=[NotUsed, Request]): Future[Response]

    Invoke the service call with unit id argument and a unit request message.

    Invoke the service call with unit id argument and a unit request message.

    This should only be used when the request message is NotUsed.

    returns

    A future of the response entity.

    Definition Classes
    ServiceCall
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. def withResponseHeader: ServiceCall[Request, (ResponseHeader, Response)]

    Allow handling of the response header.

    Allow handling of the response header.

    This converts the service call to one that returns both the response header and the response message.

    This is simply a convenience method for invoking handleResponseHeader((_, _).

    returns

    The a service call that returns the response header and the response message.

    Definition Classes
    ServiceCall
  32. def →[B](y: B): (PlayServiceCall[Request, Response], B)
    Implicit
    This member is added by an implicit conversion from PlayServiceCall[Request, Response] to ArrowAssoc[PlayServiceCall[Request, Response]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from ServiceCall[Request, Response]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from PlayServiceCall[Request, Response] to any2stringadd[PlayServiceCall[Request, Response]]

Inherited by implicit conversion StringFormat from PlayServiceCall[Request, Response] to StringFormat[PlayServiceCall[Request, Response]]

Inherited by implicit conversion Ensuring from PlayServiceCall[Request, Response] to Ensuring[PlayServiceCall[Request, Response]]

Inherited by implicit conversion ArrowAssoc from PlayServiceCall[Request, Response] to ArrowAssoc[PlayServiceCall[Request, Response]]

Ungrouped