response

This package enables a reasonable approach of building HTTP responses using the ResponseBuilder abstraction. The ResponseBuilder provides an immutable way of building concrete Response instances by specifying their status, headers and cookies. There are plenty of predefined builders named by HTTP statuses, i.e., Ok, Created, NotFound. Thus, the typical use case of the ResponseBuilder abstraction involves usage of concrete builder instead of abstract ResponseBuilder itself.

val ok: Response = Ok("Hello, World!")

In addition to text/plain responses, the ResponseBuilder is able to build any response, whose content-type is specified by an implicit type-class EncodeResponse instance. In fact, any type A may be passed to a RequestReader if there is a corresponding EncodeRequest[A] instance available in the scope.

implicit val encodeBigInt = EncodeResponse[BigInt]("text/plain") { _.toString }
val ok: Response = Ok(BigInt(100))

Linear Supertypes

AnyRef, Any

Type Members

trait EncodeAnyResponse extends AnyRef

An abstraction that is responsible for encoding the response of a generic type.
trait EncodeResponse[-A] extends AnyRef

An abstraction that is responsible for encoding the response of type A.
case class ResponseBuilder(status: Status, headers: Map[String, String] = Map.empty[String, String], cookies: Seq[Cookie] = Seq.empty[Cookie], contentType: Option[String] = None, charset: Option[String] = None) extends Product with Serializable

An abstraction that is responsible for building HTTP responses.
An abstraction that is responsible for building HTTP responses.
status
the HTTP response status
headers
the HTTP headers map
cookies
the HTTP cookies list
class TurnIntoHttp[A] extends Service[A, Response]

Value Members

object Accepted extends ResponseBuilder
object BadGateway extends ResponseBuilder
object BadRequest extends ResponseBuilder
object Conflict extends ResponseBuilder
object Continue extends ResponseBuilder
object Created extends ResponseBuilder
object EncodeResponse
object ExpectationFailed extends ResponseBuilder
object FailedDependency extends ResponseBuilder
object Forbidden extends ResponseBuilder
object Found extends ResponseBuilder
object GatewayTimeout extends ResponseBuilder
object Gone extends ResponseBuilder
object HttpVersionNotSupported extends ResponseBuilder
object InsufficientStorage extends ResponseBuilder
object InternalServerError extends ResponseBuilder
object LengthRequired extends ResponseBuilder
object Locked extends ResponseBuilder
object MethodNotAllowed extends ResponseBuilder
object MovedPermanently extends ResponseBuilder
object MultiStatus extends ResponseBuilder
object MultipleChoices extends ResponseBuilder
object NoContent extends ResponseBuilder
object NonAuthoritativeInformation extends ResponseBuilder
object NotAcceptable extends ResponseBuilder
object NotExtended extends ResponseBuilder
object NotFound extends ResponseBuilder
object NotImplemented extends ResponseBuilder
object NotModified extends ResponseBuilder
object Ok extends ResponseBuilder
object PartialContent extends ResponseBuilder
object PaymentRequired extends ResponseBuilder
object PreconditionFailed extends ResponseBuilder
object PreconditionRequired extends ResponseBuilder
object Processing extends ResponseBuilder
object ProxyAuthenticationRequired extends ResponseBuilder
object Redirect

A factory for Redirecting to other URLs.
object RequestEntityTooLarge extends ResponseBuilder
object RequestTimeOut extends ResponseBuilder
object RequestUriTooLong extends ResponseBuilder
object RequestedRangeNotSatisfiable extends ResponseBuilder
object ResetContent extends ResponseBuilder
object SeeOther extends ResponseBuilder
object ServiceUnavailable extends ResponseBuilder
object TemporaryRedirect extends ResponseBuilder
object TooManyRequests extends ResponseBuilder
object TurnIntoHttp

A service that converts an encoded object into HTTP response with status OK using an implicit EncodeResponse.
object Unauthorized extends ResponseBuilder
object UnorderedCollection extends ResponseBuilder
object UnprocessableEntity extends ResponseBuilder
object UnsupportedMediaType extends ResponseBuilder
object UpgradeRequired extends ResponseBuilder
object UseProxy extends ResponseBuilder
object VariantAlsoNegotiates extends ResponseBuilder

package response

Type Members

trait EncodeAnyResponse extends AnyRef

trait EncodeResponse[-A] extends AnyRef

case class ResponseBuilder(status: Status, headers: Map[String, String] = Map.empty[String, String], cookies: Seq[Cookie] = Seq.empty[Cookie], contentType: Option[String] = None, charset: Option[String] = None) extends Product with Serializable

class TurnIntoHttp[A] extends Service[A, Response]

Value Members

object Accepted extends ResponseBuilder

object BadGateway extends ResponseBuilder

object BadRequest extends ResponseBuilder

object Conflict extends ResponseBuilder

object Continue extends ResponseBuilder

object Created extends ResponseBuilder

object EncodeResponse

object ExpectationFailed extends ResponseBuilder

object FailedDependency extends ResponseBuilder

object Forbidden extends ResponseBuilder

object Found extends ResponseBuilder

object GatewayTimeout extends ResponseBuilder

object Gone extends ResponseBuilder

object HttpVersionNotSupported extends ResponseBuilder

object InsufficientStorage extends ResponseBuilder

object InternalServerError extends ResponseBuilder

object LengthRequired extends ResponseBuilder

object Locked extends ResponseBuilder

object MethodNotAllowed extends ResponseBuilder

object MovedPermanently extends ResponseBuilder

object MultiStatus extends ResponseBuilder

object MultipleChoices extends ResponseBuilder

object NoContent extends ResponseBuilder

object NonAuthoritativeInformation extends ResponseBuilder

object NotAcceptable extends ResponseBuilder

object NotExtended extends ResponseBuilder

object NotFound extends ResponseBuilder

object NotImplemented extends ResponseBuilder

object NotModified extends ResponseBuilder

object Ok extends ResponseBuilder

object PartialContent extends ResponseBuilder

object PaymentRequired extends ResponseBuilder

object PreconditionFailed extends ResponseBuilder

object PreconditionRequired extends ResponseBuilder

object Processing extends ResponseBuilder

object ProxyAuthenticationRequired extends ResponseBuilder

object Redirect

object RequestEntityTooLarge extends ResponseBuilder

object RequestTimeOut extends ResponseBuilder

object RequestUriTooLong extends ResponseBuilder

object RequestedRangeNotSatisfiable extends ResponseBuilder

object ResetContent extends ResponseBuilder

object SeeOther extends ResponseBuilder

object ServiceUnavailable extends ResponseBuilder

object TemporaryRedirect extends ResponseBuilder

object TooManyRequests extends ResponseBuilder

object TurnIntoHttp

object Unauthorized extends ResponseBuilder

object UnorderedCollection extends ResponseBuilder

object UnprocessableEntity extends ResponseBuilder

object UnsupportedMediaType extends ResponseBuilder

object UpgradeRequired extends ResponseBuilder

object UseProxy extends ResponseBuilder

object VariantAlsoNegotiates extends ResponseBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped