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. def clone(): AnyRef

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

    Definition Classes
    ResponseBuilder
  16. def created: HttpResponse

    Definition Classes
    ResponseBuilder
  17. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  19. def expectationFailed: HttpResponse

    Definition Classes
    ResponseBuilder
  20. def finalize(): Unit

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

    Definition Classes
    ResponseBuilder
  22. def forbidden: HttpResponse

    Definition Classes
    ResponseBuilder
  23. def found: HttpResponse

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

    Definition Classes
    ResponseImplicits
  25. def gatewayTimeout: HttpResponse

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

    Definition Classes
    AnyRef → Any
  27. def gone: HttpResponse

    Definition Classes
    ResponseBuilder
  28. def hashCode(): Int

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

  30. 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

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

  32. 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

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

  34. def internalServerError(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder
  35. def internalServerError: HttpResponse

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

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

    Definition Classes
    Any
  38. def lengthRequired: HttpResponse

    Definition Classes
    ResponseBuilder
  39. def methodNotAllowed: HttpResponse

    Definition Classes
    ResponseBuilder
  40. def movedPermanently: HttpResponse

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

    Definition Classes
    AnyRef
  42. def nocontent: HttpResponse

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

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

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

    Definition Classes
    ResponseImplicits
  46. def nonAuthoritativeInformation: HttpResponse

    Definition Classes
    ResponseBuilder
  47. def notAcceptable: HttpResponse

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

    Definition Classes
    ResponseBuilder
  49. def notFound: HttpResponse

    Definition Classes
    ResponseBuilder
  50. def notImplemented: HttpResponse

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

    Definition Classes
    ResponseBuilder
  52. def notModified: HttpResponse

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

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

    Definition Classes
    AnyRef
  55. 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
  56. 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
  57. 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
  58. def ok: HttpResponse

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

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

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

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

    Definition Classes
    ResponseImplicits
  63. implicit def optionToResponse(option: Option[_]): HttpResponse

    Definition Classes
    ResponseImplicits
  64. def partialContent: HttpResponse

    Definition Classes
    ResponseBuilder
  65. def paymentRequired: HttpResponse

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

    Definition Classes
    ResponseBuilder
  67. def preconditionFailed: HttpResponse

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

    Definition Classes
    ResponseImplicits
  69. def proxyAuthenticationRequired: HttpResponse

    Definition Classes
    ResponseBuilder
  70. def requestEntityTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder
  71. def requestHeaderFieldsTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder
  72. def requestTimeout: HttpResponse

    Definition Classes
    ResponseBuilder
  73. def requestURITooLong: HttpResponse

    Definition Classes
    ResponseBuilder
  74. def requestedRangeNotSatisfiable: HttpResponse

    Definition Classes
    ResponseBuilder
  75. def resetContent: HttpResponse

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

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

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

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

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

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

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

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

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

    Definition Classes
    ResponseBuilder
  85. def serviceUnavailable: HttpResponse

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

    Definition Classes
    ResponseBuilder
  87. 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
  88. 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
  89. implicit def statusToEndpointFn(s: HttpStatus): (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    ResponseImplicits
  90. implicit def statusToFuture(s: HttpStatus): Future[HttpResponse]

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

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

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

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

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

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

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

    Definition Classes
    ResponseBuilder
  98. def toString(): String

    Definition Classes
    AnyRef → Any
  99. def tooManyRequests: HttpResponse

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

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

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

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

    Definition Classes
    ResponseImplicits
  104. implicit def tryToResponse(t: Try[_]): HttpResponse

    Definition Classes
    ResponseImplicits
  105. def unauthorized: HttpResponse

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

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

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

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

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

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

    Definition Classes
    ResponseBuilder
  112. def unprocessableEntity: HttpResponse

    Definition Classes
    ResponseBuilder
  113. def unsupportedMediaType: HttpResponse

    Definition Classes
    ResponseBuilder
  114. def useProxy: HttpResponse

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

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

    The regex to match on the user agent

  117. final def wait(): Unit

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. 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