com.sksamuel.scruffy

EndpointProvider

abstract class EndpointProvider extends HttpEndpointProvider with WebsocketEndpointProvider with StaticEndpointProvider

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EndpointProvider
  2. StaticEndpointProvider
  3. WebsocketEndpointProvider
  4. HttpEndpointProvider
  5. DefaultProcessors
  6. SessionProcessors
  7. ParamProcessors
  8. HeaderProcessors
  9. EntityProcessors
  10. CookieProcessors
  11. ContentTypeProcessors
  12. HttpResponseImplicits
  13. ResponseBuilder
  14. AnyRef
  15. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EndpointProvider()

Type Members

  1. implicit class FutureOps[T] extends AnyRef

    Definition Classes
    HttpResponseImplicits
  2. trait HttpResponseOps[A] extends AnyRef

    Definition Classes
    ResponseBuilder

Abstract Value Members

  1. implicit abstract val executor: ExecutionContext

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): EndpointProvider.FutureOps[A] { def self: A }

    Definition Classes
    ResponseBuilder
  5. implicit def ToHttpResponseOps[A](a: A): HttpResponseOps[A] { def self: A }

    Definition Classes
    ResponseBuilder
  6. def accepted: HttpResponse

    Definition Classes
    ResponseBuilder
  7. def ajax(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors
  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 consumes(mediaTypes: MediaType*)(p: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    A Processor that will reject a request with 415 Unsupported Media Type if the content type of the request does not match one of the given content types.

    A Processor that will reject a request with 415 Unsupported Media Type if the content type of the request does not match one of the given content types.

    mediaTypes

    the media types accepted by this processor

    p

    the inner processor

    req

    the outer http request

    returns

    the inner processors http response

    Definition Classes
    ContentTypeProcessors
  15. def contentTypeOverride(mediaType: MediaType)(p: (HttpRequest) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    A processor that sets the content type of the request.

    A processor that sets the content type of the request.

    Definition Classes
    ContentTypeProcessors
  16. def cookie(name: String)(f: (Cookie) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

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

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

    name

    the cookie name that must be present on the request

    returns

    this

    Definition Classes
    CookieProcessors
  17. def created: HttpResponse

    Definition Classes
    ResponseBuilder
  18. def define(method: HttpMethod, url: String, p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider
  19. def delete(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider
  20. def emptyBody(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    EntityProcessors
  21. def entity(ent: Any, contentType: MediaType): HttpResponse

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

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

    Definition Classes
    ResponseBuilder
  22. def entity(ent: Any, contentType: String): HttpResponse

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

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

    Definition Classes
    ResponseBuilder
  23. def entity(ent: Any): HttpResponse

    Definition Classes
    ResponseBuilder
  24. def entityAs[E](f: (E) ⇒ Future[HttpResponse])(implicit arg0: Manifest[E], req: HttpRequest): Future[HttpResponse]

    Definition Classes
    EntityProcessors
  25. implicit def entityFutureToResponseFuture(f: Future[Any]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  26. def entitySizeLimit(size: Int)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    EntityProcessors
  27. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  29. def expectationFailed: HttpResponse

    Definition Classes
    ResponseBuilder
  30. def filter(filter: Filter): Unit

    Adds a filter that will run before each of the endpoints defined in this provider.

    Adds a filter that will run before each of the endpoints defined in this provider.

    Filters are only executed once per request, so if an endpoint forwards to another endpoint, the filter will not be re-executed.

    Note: Endpoint Provider specific filters (ie, filters added here) will be executed after server-wide specific filters (those specified in the Scruffy server instance).

    Definition Classes
    HttpEndpointProvider
  31. var filters: ListBuffer[FilterHolder]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpEndpointProvider
  32. def finalize(): Unit

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

    Definition Classes
    ResponseBuilder
  34. def forbidden: HttpResponse

    Definition Classes
    ResponseBuilder
  35. def found: HttpResponse

    Definition Classes
    ResponseBuilder
  36. def gatewayTimeout: HttpResponse

    Definition Classes
    ResponseBuilder
  37. def get(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider
  38. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  39. def gone: HttpResponse

    Definition Classes
    ResponseBuilder
  40. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  41. def head(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider
  42. def header(name: String, value: Any)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    HeaderProcessors
  43. def header(name: HeaderName, value: Any)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    HeaderProcessors
  44. def header(name: String)(f: ⇒ Future[HttpResponse])(implicit req: 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

    Definition Classes
    HeaderProcessors
  45. def header(name: HeaderName)(f: ⇒ Future[HttpResponse])(implicit req: 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

    Definition Classes
    HeaderProcessors
  46. def hostname(regex: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors
  47. def http(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors
  48. val httpEndpoints: ListBuffer[HttpEndpoint]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpEndpointProvider
  49. def https(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors
  50. def ifMatch(name: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors
  51. def internalServerError(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder
  52. def internalServerError: HttpResponse

    Definition Classes
    ResponseBuilder
  53. def ipAddress(regex: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    DefaultProcessors
  54. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  55. def json(any: Any): Future[HttpResponse]

    Creates a HttpResponse, which is a 200 OK, with the given entity set as a Json payload.

    Creates a HttpResponse, which is a 200 OK, with the given entity set as a Json payload.

    Definition Classes
    ContentTypeProcessors
  56. def lengthRequired: HttpResponse

    Definition Classes
    ResponseBuilder
  57. def methodNotAllowed: HttpResponse

    Definition Classes
    ResponseBuilder
  58. def movedPermanently: HttpResponse

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

    Definition Classes
    AnyRef
  60. def nocontent: HttpResponse

    Definition Classes
    ResponseBuilder
  61. implicit def nodeToResponseFuture(node: Node): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  62. def nonAuthoritativeInformation: HttpResponse

    Definition Classes
    ResponseBuilder
  63. def nonEmptyBody(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    EntityProcessors
  64. def notAcceptable: HttpResponse

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

    Definition Classes
    ResponseBuilder
  66. def notFound: HttpResponse

    Definition Classes
    ResponseBuilder
  67. def notImplemented: HttpResponse

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

    Definition Classes
    ResponseBuilder
  69. def notModified: HttpResponse

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

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

    Definition Classes
    AnyRef
  72. def ok(e: Any): HttpResponse

    Definition Classes
    ResponseBuilder
  73. def ok: HttpResponse

    Definition Classes
    ResponseBuilder
  74. def option2response(option: Option[_]): HttpResponse

    Definition Classes
    HttpResponseImplicits
  75. implicit def optionFutureToResponseFuture(f: Future[Option[_]]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  76. implicit def optionToResponseFuture(o: Option[_]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  77. def options(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider
  78. def param(name: String, value: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    ParamProcessors
  79. def param(name: String)(f: (String) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    ParamProcessors
  80. def partialContent: HttpResponse

    Definition Classes
    ResponseBuilder
  81. def paymentRequired: HttpResponse

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

    Definition Classes
    ResponseBuilder
  83. def post(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider
  84. def preconditionFailed: HttpResponse

    Definition Classes
    ResponseBuilder
  85. def proxyAuthenticationRequired: HttpResponse

    Definition Classes
    ResponseBuilder
  86. def put(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider
  87. def rateLimit(requestsPerSecond: Double, warmupPeriod: FiniteDuration)(f: ⇒ Future[HttpResponse]): Future[HttpResponse]

    Definition Classes
    DefaultProcessors
  88. def rateLimit(limiter: RateLimiter)(f: ⇒ Future[HttpResponse]): Future[HttpResponse]

    Definition Classes
    DefaultProcessors
  89. def requestEntityTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder
  90. def requestHeaderFieldsTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder
  91. def requestTimeout: HttpResponse

    Definition Classes
    ResponseBuilder
  92. def requestURITooLong: HttpResponse

    Definition Classes
    ResponseBuilder
  93. def requestedRangeNotSatisfiable: HttpResponse

    Definition Classes
    ResponseBuilder
  94. def resetContent: HttpResponse

    Definition Classes
    ResponseBuilder
  95. implicit def responseToResponseFuture(resp: HttpResponse): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  96. implicit def scalazValidation2responseFuture(v: ValidationNel[_, _]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  97. implicit def scalazValidationFuture2responseFuture(f: Future[ValidationNel[_, _]]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  98. def seeOther(location: String): HttpResponse

    Definition Classes
    ResponseBuilder
  99. def serviceUnavailable: HttpResponse

    Definition Classes
    ResponseBuilder
  100. def session(f: (Session) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Extracts the current session.

    Extracts the current session. If no such session exists then will exit the route with a 500 Internal Service Error.

    Definition Classes
    SessionProcessors
  101. def sessionManager(manager: SessionManager)(f: (Session) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Definition Classes
    SessionProcessors
  102. def sessionProperty[T](key: SessionKey[T])(f: (T) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

    Extracts a property from the session.

    Extracts a property from the session. If the session does not exist then the endpoint will return a 500 Internal Service Error. If the property does not exist in the session then the route will return a 500 Internal Service Error.

    Definition Classes
    SessionProcessors
  103. def static(url: String): StaticEndpointBuilder

    Definition Classes
    StaticEndpointProvider
  104. val staticEndpoints: ListBuffer[StaticEndpointBuilder]

    Definition Classes
    StaticEndpointProvider
  105. def status(s: Int): HttpResponse

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

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

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

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

    Builds a HttpResponse with the status code set the given HttpStatus

    Builds a HttpResponse with the status code set the given HttpStatus

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

    Definition Classes
    ResponseBuilder
  107. implicit def statusToResponse(s: HttpStatus): HttpResponse

    Definition Classes
    HttpResponseImplicits
  108. implicit def statusToResponseFuture(s: HttpStatus): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  109. implicit def stringFutureToResponseFuture(f: Future[String]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  110. implicit def stringToResponseFuture(str: String): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  111. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Definition Classes
    ResponseBuilder
  113. def toString(): String

    Definition Classes
    AnyRef → Any
  114. def tooManyRequests: HttpResponse

    Definition Classes
    ResponseBuilder
  115. def trace(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

    Definition Classes
    HttpEndpointProvider
  116. def try2response(t: Try[_]): HttpResponse

    Definition Classes
    HttpResponseImplicits
  117. implicit def try2responseFuture(t: Try[_]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  118. implicit def tryFuture2responseFuture(f: Future[Try[_]]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  119. def unauthorized: HttpResponse

    Definition Classes
    ResponseBuilder
  120. def unit2response(unit: Unit): HttpResponse

    Definition Classes
    HttpResponseImplicits
  121. implicit def unit2responseFuture(unit: Unit): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  122. implicit def unitFuture2responseFuture(f: Future[Unit]): Future[HttpResponse]

    Definition Classes
    HttpResponseImplicits
  123. def unprocessableEntity(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder
  124. def unprocessableEntity: HttpResponse

    Definition Classes
    ResponseBuilder
  125. def unsupportedMediaType: HttpResponse

    Definition Classes
    ResponseBuilder
  126. def useProxy: HttpResponse

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

    Definition Classes
    HeaderProcessors
  128. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. def websocket(path: String)(f: ⇒ WebsocketHandler): Unit

    Definition Classes
    WebsocketEndpointProvider
  132. val websocketEndpoints: ListBuffer[WebsocketEndpoint]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    WebsocketEndpointProvider
  133. def xml(any: Any): Future[HttpResponse]

    Creates a HttpResponse, which is a 200 OK, with the given entity set as an XML payload.

    Creates a HttpResponse, which is a 200 OK, with the given entity set as an XML payload.

    Definition Classes
    ContentTypeProcessors

Inherited from StaticEndpointProvider

Inherited from WebsocketEndpointProvider

Inherited from HttpEndpointProvider

Inherited from DefaultProcessors

Inherited from SessionProcessors

Inherited from ParamProcessors

Inherited from HeaderProcessors

Inherited from EntityProcessors

Inherited from CookieProcessors

Inherited from ContentTypeProcessors

Inherited from HttpResponseImplicits

Inherited from ResponseBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped