com.sksamuel.scruffy.processors

HeaderProcessors

Related Doc: package processors

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
    ResponseImplicits
  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: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

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

    Definition Classes
    ResponseBuilder
  5. def accepted: HttpResponse

    Definition Classes
    ResponseBuilder
  6. def addHeader(name: HeaderName, v: Any)(f: Processor): Processor

  7. def addHeader(name: String, v: Any)(f: Processor): Processor

    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.

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def badGateway: HttpResponse

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

    Definition Classes
    ResponseBuilder
  11. def badRequest: HttpResponse

    Definition Classes
    ResponseBuilder
  12. def clone(): AnyRef

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

    Definition Classes
    ResponseBuilder
  14. def created: HttpResponse

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

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

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

    Definition Classes
    AnyRef → Any
  18. def expectationFailed: HttpResponse

    Definition Classes
    ResponseBuilder
  19. def finalize(): Unit

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

    Definition Classes
    ResponseBuilder
  21. def forbidden: HttpResponse

    Definition Classes
    ResponseBuilder
  22. def found: HttpResponse

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

    Definition Classes
    ResponseImplicits
  24. def gatewayTimeout: HttpResponse

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

    Definition Classes
    AnyRef → Any
  26. def gone: HttpResponse

    Definition Classes
    ResponseBuilder
  27. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  28. def header(name: HeaderName, value: Any)(f: Processor): Processor

  29. def header(name: String, value: Any)(f: Processor): Processor

    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

  30. def header(name: HeaderName)(f: Processor): Processor

  31. def header(name: String)(f: Processor): Processor

    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

  32. def ifMatch(name: String)(f: ⇒ Processor): Processor

  33. def internalServerError(entity: Any): HttpResponse

    Definition Classes
    ResponseBuilder
  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): Processor

    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[_]): Processor

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

    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. def partialContent: HttpResponse

    Definition Classes
    ResponseBuilder
  64. def paymentRequired: HttpResponse

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

    Definition Classes
    ResponseBuilder
  66. def preconditionFailed: HttpResponse

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

    Definition Classes
    ResponseImplicits
  68. def proxyAuthenticationRequired: HttpResponse

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

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

    Definition Classes
    ResponseImplicits
  71. def requestEntityTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder
  72. def requestHeaderFieldsTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder
  73. def requestTimeout: HttpResponse

    Definition Classes
    ResponseBuilder
  74. def requestURITooLong: HttpResponse

    Definition Classes
    ResponseBuilder
  75. def requestedRangeNotSatisfiable: HttpResponse

    Definition Classes
    ResponseBuilder
  76. def resetContent: HttpResponse

    Definition Classes
    ResponseBuilder
  77. implicit def responseFutureToProcessor(resp: Future[HttpResponse]): Processor

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

    Definition Classes
    ResponseImplicits
  79. implicit def responseToProcessorFn(resp: HttpResponse): Processor

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

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

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

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

    Definition Classes
    ResponseImplicits
  84. implicit def scalazValToEndpointFn(f: Future[ValidationNel[_, _]]): Processor

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

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

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

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

    Definition Classes
    ResponseBuilder
  89. def serviceUnavailable: HttpResponse

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

    Definition Classes
    ResponseBuilder
  91. 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
  92. 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
  93. implicit def statusToEndpointFn(s: HttpStatus): Processor

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

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

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

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

    Definition Classes
    ResponseImplicits
  98. implicit def stringToProcessor(str: String): Processor

    Definition Classes
    ResponseImplicits
  99. implicit def stringToProcessor(f: Future[String]): Processor

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

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

    Definition Classes
    ResponseBuilder
  102. def toString(): String

    Definition Classes
    AnyRef → Any
  103. def tooManyRequests: HttpResponse

    Definition Classes
    ResponseBuilder
  104. implicit def tryToEndpointFn(t: Try[_]): Processor

    Definition Classes
    ResponseImplicits
  105. implicit def tryToEndpointFn(f: Future[Try[_]]): Processor

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

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

    Definition Classes
    ResponseImplicits
  108. def unauthorized: HttpResponse

    Definition Classes
    ResponseBuilder
  109. implicit def unitToEndpointFn(unit: Unit): Processor

    Definition Classes
    ResponseImplicits
  110. implicit def unitToEndpointFn(f: Future[Unit]): Processor

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

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

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

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

    Definition Classes
    ResponseBuilder
  115. def unprocessableEntity: HttpResponse

    Definition Classes
    ResponseBuilder
  116. def unsupportedMediaType: HttpResponse

    Definition Classes
    ResponseBuilder
  117. def useProxy: HttpResponse

    Definition Classes
    ResponseBuilder
  118. def userAgent(regex: String)(f: Processor): Processor

  119. def userAgent(regex: Regex)(f: Processor): Processor

    The regex to match on the user agent

  120. final def wait(): Unit

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

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