HttpEndpointProvider

Type Members

implicit class FutureOps[T] extends AnyRef

Definition Classes
HttpResponseImplicits
trait HttpResponseOps[A] extends AnyRef

Definition Classes
ResponseBuilder

Value Members

final def !=(arg0: Any): Boolean

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

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

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

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

Definition Classes
ResponseBuilder
def accepted: HttpResponse

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

Definition Classes
DefaultProcessors
final def asInstanceOf[T0]: T0

Definition Classes
Any
def badGateway: HttpResponse

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

Definition Classes
ResponseBuilder
def badRequest: HttpResponse

Definition Classes
ResponseBuilder
def clone(): AnyRef

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

Definition Classes
ResponseBuilder
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
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
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
def created: HttpResponse

Definition Classes
ResponseBuilder
def define(method: HttpMethod, url: String, p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint
def delete(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint
implicit val ec: ExecutionContextExecutor

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

Definition Classes
EntityProcessors
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
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
def entity(ent: Any): HttpResponse

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

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

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

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

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

Definition Classes
AnyRef → Any
implicit val executor: ExecutionContext

Definition Classes
HttpResponseImplicits
def expectationFailed: HttpResponse

Definition Classes
ResponseBuilder
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).
var filters: ListBuffer[FilterHolder]

Attributes
protected[com.sksamuel.scruffy]
def finalize(): Unit

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

Definition Classes
ResponseBuilder
def forbidden: HttpResponse

Definition Classes
ResponseBuilder
def found: HttpResponse

Definition Classes
ResponseBuilder
def gatewayTimeout: HttpResponse

Definition Classes
ResponseBuilder
def get(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def gone: HttpResponse

Definition Classes
ResponseBuilder
def hashCode(): Int

Definition Classes
AnyRef → Any
def head(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint
def header(name: String, value: Any)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

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

Definition Classes
HeaderProcessors
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
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
def hostname(regex: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

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

Definition Classes
DefaultProcessors
val httpEndpoints: ListBuffer[HttpEndpoint]

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

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

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

Definition Classes
ResponseBuilder
def internalServerError: HttpResponse

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

Definition Classes
DefaultProcessors
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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
def lengthRequired: HttpResponse

Definition Classes
ResponseBuilder
def methodNotAllowed: HttpResponse

Definition Classes
ResponseBuilder
def movedPermanently: HttpResponse

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

Definition Classes
AnyRef
def nocontent: HttpResponse

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

Definition Classes
HttpResponseImplicits
def nonAuthoritativeInformation: HttpResponse

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

Definition Classes
EntityProcessors
def notAcceptable: HttpResponse

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

Definition Classes
ResponseBuilder
def notFound: HttpResponse

Definition Classes
ResponseBuilder
def notImplemented: HttpResponse

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

Definition Classes
ResponseBuilder
def notModified: HttpResponse

Definition Classes
ResponseBuilder
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
ResponseBuilder
def ok: HttpResponse

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

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

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

Definition Classes
HttpResponseImplicits
def options(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint
def param(name: String, value: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

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

Definition Classes
ParamProcessors
def partialContent: HttpResponse

Definition Classes
ResponseBuilder
def paymentRequired: HttpResponse

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

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

Definition Classes
ResponseBuilder
def proxyAuthenticationRequired: HttpResponse

Definition Classes
ResponseBuilder
def put(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint
def rateLimit(requestsPerSecond: Double, warmupPeriod: FiniteDuration)(f: ⇒ Future[HttpResponse]): Future[HttpResponse]

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

Definition Classes
DefaultProcessors
def requestEntityTooLarge: HttpResponse

Definition Classes
ResponseBuilder
def requestHeaderFieldsTooLarge: HttpResponse

Definition Classes
ResponseBuilder
def requestTimeout: HttpResponse

Definition Classes
ResponseBuilder
def requestURITooLong: HttpResponse

Definition Classes
ResponseBuilder
def requestedRangeNotSatisfiable: HttpResponse

Definition Classes
ResponseBuilder
def resetContent: HttpResponse

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

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

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

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

Definition Classes
ResponseBuilder
def serviceUnavailable: HttpResponse

Definition Classes
ResponseBuilder
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
def sessionManager(manager: SessionManager)(f: (Session) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

Definition Classes
SessionProcessors
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
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
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
implicit def statusToResponse(s: HttpStatus): HttpResponse

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

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

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

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

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

Definition Classes
ResponseBuilder
def toString(): String

Definition Classes
AnyRef → Any
def tooManyRequests: HttpResponse

Definition Classes
ResponseBuilder
def trace(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint
def try2response(t: Try[_]): HttpResponse

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

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

Definition Classes
HttpResponseImplicits
def unauthorized: HttpResponse

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

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

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

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

Definition Classes
ResponseBuilder
def unprocessableEntity: HttpResponse

Definition Classes
ResponseBuilder
def unsupportedMediaType: HttpResponse

Definition Classes
ResponseBuilder
def useProxy: HttpResponse

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

Definition Classes
HeaderProcessors
final def wait(): Unit

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

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

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

trait HttpEndpointProvider extends ResponseBuilder with HttpResponseImplicits with DefaultProcessors

Type Members

implicit class FutureOps[T] extends AnyRef

trait HttpResponseOps[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit def ToFutureOps[A](a: A): HttpEndpointProvider.FutureOps[A] { def self: A }

implicit def ToHttpResponseOps[A](a: A): HttpResponseOps[A] { def self: A }

def accepted: HttpResponse

def ajax(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

final def asInstanceOf[T0]: T0

def badGateway: HttpResponse

def badRequest(reason: String): HttpResponse

def badRequest: HttpResponse

def clone(): AnyRef

def conflict: HttpResponse

def consumes(mediaTypes: MediaType*)(p: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

def contentTypeOverride(mediaType: MediaType)(p: (HttpRequest) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

def cookie(name: String)(f: (Cookie) ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

def created: HttpResponse

def define(method: HttpMethod, url: String, p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

def delete(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

implicit val ec: ExecutionContextExecutor

def emptyBody(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

def entity(ent: Any, contentType: MediaType): HttpResponse

def entity(ent: Any, contentType: String): HttpResponse

def entity(ent: Any): HttpResponse

def entityAs[E](f: (E) ⇒ Future[HttpResponse])(implicit arg0: Manifest[E], req: HttpRequest): Future[HttpResponse]

implicit def entityFutureToResponseFuture(f: Future[Any]): Future[HttpResponse]

def entitySizeLimit(size: Int)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

implicit val executor: ExecutionContext

def expectationFailed: HttpResponse

def filter(filter: Filter): Unit

var filters: ListBuffer[FilterHolder]

def finalize(): Unit

def forbidden(reason: String): HttpResponse

def forbidden: HttpResponse

def found: HttpResponse

def gatewayTimeout: HttpResponse

def get(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

final def getClass(): Class[_]

def gone: HttpResponse

def hashCode(): Int

def head(url: String)(p: (HttpRequest) ⇒ Future[HttpResponse]): HttpEndpoint

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

def header(name: HeaderName, value: Any)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

def header(name: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

def header(name: HeaderName)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

def hostname(regex: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

def http(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

val httpEndpoints: ListBuffer[HttpEndpoint]

def https(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

def ifMatch(name: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

def internalServerError(reason: String): HttpResponse

def internalServerError: HttpResponse

def ipAddress(regex: String)(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

final def isInstanceOf[T0]: Boolean

def json(any: Any): Future[HttpResponse]

def lengthRequired: HttpResponse

def methodNotAllowed: HttpResponse

def movedPermanently: HttpResponse

final def ne(arg0: AnyRef): Boolean

def nocontent: HttpResponse

implicit def nodeToResponseFuture(node: Node): Future[HttpResponse]

def nonAuthoritativeInformation: HttpResponse

def nonEmptyBody(f: ⇒ Future[HttpResponse])(implicit req: HttpRequest): Future[HttpResponse]

def notAcceptable: HttpResponse

def notFound(body: String): HttpResponse

def notFound: HttpResponse

def notImplemented: HttpResponse

def notImplemented(reason: String): HttpResponse

def notModified: HttpResponse

final def notify(): Unit

final def notifyAll(): Unit

def ok(e: Any): HttpResponse