com.sksamuel.scruffy.processors

HeaderProcessors

trait HeaderProcessors extends ResponseImplicits with Processors

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HeaderProcessors
  2. ResponseImplicits
  3. Processors
  4. ResponseBuilder
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. implicit class FutureOps[T] extends AnyRef

    Definition Classes
    ResponseImplicitsResponseBuilder
  2. type Processor = (HttpRequest) ⇒ Future[HttpResponse]

    A Processor is a function that is applied with the HttpRequest and returns a Future of a HttpResponse.

    A Processor is a function that is applied with the HttpRequest and returns a Future of a HttpResponse. The HttpResponse (response) that is returned will be returned to the user if the status code is non zero.

    The function returns a response, rather than a modified HttpRequest, because we want to allow the DSL to return responses that do not require the exchange to be wrapped. Eg,

    someprocessor { req => "literal string" }

    If the Processor was HttpRequest => HttpRequest (or some other container class) then the final processor would need to be something like:

    someprocessor { req => req withResponse "literal string" }

    Which is just ugly, and more hassle.

    Definition Classes
    Processors

Abstract Value Members

  1. implicit abstract val executor: ExecutionContext

    Definition Classes
    ResponseImplicits

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. implicit def ToFutureOps[A](a: A): HeaderProcessors.FutureOps[A] { def self: A }

    Definition Classes
    ResponseBuilder
  7. def accepted: HttpResponse

    Definition Classes
    ResponseBuilder
  8. def addHeader(name: HeaderName, v: Any)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

  9. def addHeader(name: String, v: Any)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Adds a processor that adds a header with the given name and value to the response.

    Adds a processor that adds a header with the given name and value to the response. This is an alternative way of doing response.withHeader(h, v) on the response object.

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def badGateway: HttpResponse

    Definition Classes
    ResponseBuilder
  12. def badRequest(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder
  13. def badRequest: HttpResponse

    Definition Classes
    ResponseBuilder
  14. implicit def byteArrayToFutureResponse(b: Array[Byte]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def conflict: HttpResponse

    Definition Classes
    ResponseBuilder
  17. def created: HttpResponse

    Definition Classes
    ResponseBuilder
  18. def entityToResponse(x: Any): HttpResponse

    Definition Classes
    ResponseImplicits
  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  21. implicit def exception2Response(e: Throwable): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  22. def expectationFailed: HttpResponse

    Definition Classes
    ResponseBuilder
  23. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def forbidden(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder
  25. def forbidden: HttpResponse

    Definition Classes
    ResponseBuilder
  26. def found: HttpResponse

    Definition Classes
    ResponseBuilder
  27. implicit def futureTeeToFutureResponse[T](f: Future[T])(implicit fn: (T) ⇒ HttpResponse): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  28. def gatewayTimeout: HttpResponse

    Definition Classes
    ResponseBuilder
  29. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  30. def gone: HttpResponse

    Definition Classes
    ResponseBuilder
  31. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  32. def header(name: HeaderName, value: Any)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

  33. def header(name: String, value: Any)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Adds a processor to the pipeline that requires the request to have a header with the given name and value If the request does not contain the header then processing will skip to the next endpoint.

    Adds a processor to the pipeline that requires the request to have a header with the given name and value If the request does not contain the header then processing will skip to the next endpoint.

    name

    the header that must be present on the request

    returns

    this

  34. def header(name: HeaderName)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

  35. def header(name: String)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Adds a processor to the pipeline that requires the request to have a header with the given name.

    Adds a processor to the pipeline that requires the request to have a header with the given name. The value is not inspected as part of this pipeline. If the request does not contain the header then processing will skip to the next endpoint.

    name

    the header that must be present on the request

    returns

    this

  36. def ifMatch(name: String)(f: ⇒ (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

  37. def internalServerError(entity: Any): HttpResponse

    Definition Classes
    ResponseBuilder
  38. def internalServerError(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder
  39. def internalServerError: HttpResponse

    Definition Classes
    ResponseBuilder
  40. def internalServerError(e: Throwable): HttpResponse

    Definition Classes
    ResponseBuilder
  41. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  42. def lengthRequired: HttpResponse

    Definition Classes
    ResponseBuilder
  43. def methodNotAllowed: HttpResponse

    Definition Classes
    ResponseBuilder
  44. def movedPermanently: HttpResponse

    Definition Classes
    ResponseBuilder
  45. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  46. def nocontent: HttpResponse

    Definition Classes
    ResponseBuilder
  47. implicit def nodeToEndpointFn(node: Node): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  48. implicit def nodeToFuture(node: Node): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  49. implicit def nodeToResponse(node: Node): HttpResponse

    Definition Classes
    ResponseImplicits
  50. def nonAuthoritativeInformation: HttpResponse

    Definition Classes
    ResponseBuilder
  51. def notAcceptable: HttpResponse

    Definition Classes
    ResponseBuilder
  52. def notFound(body: String): HttpResponse

    Definition Classes
    ResponseBuilder
  53. def notFound: HttpResponse

    Definition Classes
    ResponseBuilder
  54. def notImplemented: HttpResponse

    Definition Classes
    ResponseBuilder
  55. def notImplemented(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder
  56. def notModified: HttpResponse

    Definition Classes
    ResponseBuilder
  57. final def notify(): Unit

    Definition Classes
    AnyRef
  58. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  59. def ok(ent: Any, contentType: MediaType): HttpResponse

    Creates a Response, which is a 200 OK, with the given entity set as the payload with the given content-type.

    Creates a Response, which is a 200 OK, with the given entity set as the payload with the given content-type.

    Definition Classes
    ResponseBuilder
  60. def ok(ent: Any, contentType: String): HttpResponse

    Creates a Response, which is a 200 OK, with the given entity set as the payload with the given content-type.

    Creates a Response, which is a 200 OK, with the given entity set as the payload with the given content-type.

    Definition Classes
    ResponseBuilder
  61. def ok(e: Any): HttpResponse

    Creaes a 200 ok response with the entity set to the given value, and the content type inferred.

    Creaes a 200 ok response with the entity set to the given value, and the content type inferred.

    Definition Classes
    ResponseBuilder
  62. def ok: HttpResponse

    Definition Classes
    ResponseBuilder
  63. implicit def optionToEndpointFn(o: Option[_]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  64. implicit def optionToEndpointFn(f: Future[Option[_]]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  65. implicit def optionToFuture(o: Option[_]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  66. implicit def optionToFuture(f: Future[Option[_]]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  67. def partialContent: HttpResponse

    Definition Classes
    ResponseBuilder
  68. def paymentRequired: HttpResponse

    Definition Classes
    ResponseBuilder
  69. def permanentRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder
  70. def preconditionFailed: HttpResponse

    Definition Classes
    ResponseBuilder
  71. implicit def productToFuture(prod: Product): Future[Product]

    Definition Classes
    ResponseImplicits
  72. def proxyAuthenticationRequired: HttpResponse

    Definition Classes
    ResponseBuilder
  73. implicit def redirectToFutureResponse(redirect: Redirect): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  74. implicit def redirectToResponse(redirect: Redirect): HttpResponse

    Definition Classes
    ResponseImplicits
  75. def requestEntityTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder
  76. def requestHeaderFieldsTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder
  77. def requestTimeout: HttpResponse

    Definition Classes
    ResponseBuilder
  78. def requestURITooLong: HttpResponse

    Definition Classes
    ResponseBuilder
  79. def requestedRangeNotSatisfiable: HttpResponse

    Definition Classes
    ResponseBuilder
  80. def resetContent: HttpResponse

    Definition Classes
    ResponseBuilder
  81. implicit def responseFutureToProcessor(resp: Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  82. implicit def responseToFuture(resp: HttpResponse): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  83. implicit def responseToProcessorFn(resp: HttpResponse): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  84. implicit def scalazFailureToFutureResponse(f: Future[Failure[_]]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  85. implicit def scalazFailureToFutureResponse(f: Failure[_]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  86. implicit def scalazFailureToResponse(f: Failure[_]): HttpResponse

    Definition Classes
    ResponseImplicits
  87. implicit def scalazValToEndpointFn(v: ValidationNel[_, _]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  88. implicit def scalazValToEndpointFn(f: Future[ValidationNel[_, _]]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  89. implicit def scalazValToFutureResponse(f: Future[ValidationNel[_, _]]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  90. implicit def scalazValToFutureResponse(v: ValidationNel[_, _]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  91. implicit def scalazValToResponse(f: ValidationNel[_, _]): HttpResponse

    Definition Classes
    ResponseImplicits
  92. def seeOther(location: String): HttpResponse

    Definition Classes
    ResponseBuilder
  93. def serviceUnavailable: HttpResponse

    Definition Classes
    ResponseBuilder
  94. def status(s: Int, reason: String): HttpResponse

    Definition Classes
    ResponseBuilder
  95. def status(s: Int): HttpResponse

    Builds a Response with the status code set to a HttpStatus which has the value of the given int.

    Builds a Response with the status code set to a HttpStatus which has the value of the given int.

    Eg, status(200) will return a Response of 200

    Definition Classes
    ResponseBuilder
  96. def status(s: HttpStatus): HttpResponse

    Builds a Response with the status code set the given HttpStatus

    Builds a Response with the status code set the given HttpStatus

    Eg, status(HttpStatus.OK) will return a Response of 200

    Definition Classes
    ResponseBuilder
  97. implicit def statusToFuture(s: HttpStatus): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  98. implicit def statusToProcessor(s: HttpStatus): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  99. implicit def statusToResponse(s: HttpStatus): HttpResponse

    Definition Classes
    ResponseImplicits
  100. implicit def stringToFuture(str: String): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  101. implicit def stringToFuture(f: Future[String]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  102. implicit def stringToProcessor(str: String): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  103. implicit def stringToProcessor(f: Future[String]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  104. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  105. def temporaryRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder
  106. def toString(): String

    Definition Classes
    AnyRef → Any
  107. def tooManyRequests: HttpResponse

    Definition Classes
    ResponseBuilder
  108. implicit def tryToEndpointFn(t: Try[_]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  109. implicit def tryToEndpointFn(f: Future[Try[_]]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  110. implicit def tryToFuture(t: Try[_]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  111. implicit def tryToFuture(f: Future[Try[_]]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  112. def unauthorized: HttpResponse

    Definition Classes
    ResponseBuilder
  113. implicit def unitToEndpointFn(unit: Unit): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  114. implicit def unitToEndpointFn(f: Future[Unit]): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  115. implicit def unitToFuture(unit: Unit): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  116. implicit def unitToFuture(f: Future[Unit]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  117. implicit def unitToResponse(unit: Unit): HttpResponse

    Definition Classes
    ResponseImplicits
  118. def unprocessableEntity(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder
  119. def unprocessableEntity: HttpResponse

    Definition Classes
    ResponseBuilder
  120. def unsupportedMediaType: HttpResponse

    Definition Classes
    ResponseBuilder
  121. def useProxy: HttpResponse

    Definition Classes
    ResponseBuilder
  122. def userAgent(regex: String)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

  123. def userAgent(regex: Regex)(f: (HttpRequest) ⇒ Future[HttpResponse]): (HttpRequest) ⇒ Future[HttpResponse]

    The regex to match on the user agent

  124. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  125. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  126. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ResponseImplicits

Inherited from Processors

Inherited from ResponseBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped