parameters

Type Members

1. case class ApiKey[T, K >: Request](param: Parameter with Mandatory[T, K], validateKey: (T) ⇒ Future[Boolean]) extends Security with Product with Serializable

   Checks the presence of the named Api Key parameter.

2. trait Bindable[T, B <: Binding] extends AnyRef

   Allows binding of a value to an entity (eg.

3. sealed trait Binding extends AnyRef

   Represents the binding of a parameter to it's value in a particular context

4. abstract class Body[T] extends Iterable[BodyParameter] with Retrieval[T, Message]

5. trait BodyParameter extends Parameter

6. case class BodySpec[T](description: Option[String], contentType: ContentType, deserialize: (String) ⇒ T, serialize: (T) ⇒ String) extends Product with Serializable

   Spec required to marshall a body of a custom type

7. trait Builder[T] extends AnyRef

8. case class Form(fields: Map[String, Set[String]]) extends Iterable[(String, Set[String])] with Product with Serializable

   The body entity of a encoded HTML form.

9. class FormBody extends Body[Form] with Bindable[Form, Binding] with MandatoryRebind[Form, Message, Binding]

   Forms are effectively modelled as a collection of fields.

10. abstract class FormField[T] extends BodyParameter with Validatable[T, Form] with Bindable[T, FormFieldBinding]

11. class FormFieldBinding extends Binding

12. abstract class HeaderParameter[T] extends Parameter with Validatable[T, Message] with Bindable[T, RequestBinding]

13. trait Mandatory[T, From] extends Retrieval[T, From] with Parameter with Validatable[T, From]

14. trait MandatoryRebind[T, From, B <: Binding] extends Rebindable[T, From, B]

15. abstract class MultiFormField[T] extends FormField[Seq[T]]

16. trait MultiParameters[P[_], R[_]] extends AnyRef

    Support for parameters which can have more than one value (e.

17. abstract class MultiQueryParameter[T] extends QueryParameter[Seq[T]]

18. trait Optional[T, From] extends Retrieval[Option[T], From] with Parameter with Validatable[T, From]

19. trait OptionalBindable[T, B <: Binding] extends Bindable[T, B]

    For optional Parameters, adds the ability to bind an Optional value as well as a concrete value

20. trait OptionalRebind[T, From, B <: Binding] extends Rebindable[T, From, B]

21. sealed class ParamType extends AnyRef

    How a parameter is represented in the HTTP message (JSON type)

22. trait Parameter extends AnyRef

    A parameter is a name-value pair which can be encoded into an HTTP message.

23. case class ParameterSpec[T](name: String, description: Option[String] = scala.None, paramType: ParamType, deserialize: (String) ⇒ T, serialize: (T) ⇒ String = ((s: T) => s.toString())) extends Product with Serializable

    Spec required to marshall and demarshall a parameter of a custom type

24. trait ParameterSpecSupplier[T] extends AnyRef

    By implementing ParameterSpecSupplier[T], we can declare parameters using a shorthand: eg.

25. trait Parameters[P[_], R[_]] extends AnyRef

    Prototype functions for creating parameters of various types.

26. trait PathBindable[T] extends Bindable[T, PathBinding]

27. class PathBinding extends Binding

28. abstract class PathParameter[T] extends Parameter with Iterable[PathParameter[_]]

29. class QueryBinding extends Binding

30. abstract class QueryParameter[T] extends Parameter with Validatable[T, Request] with Bindable[T, QueryBinding]

31. trait Rebindable[T, From, B <: Binding] extends AnyRef

    Used to transparently copy the value out of an incoming request (or form etc.

32. class RequestBinding extends Binding

33. case class RequestBuilder(method: Method, uriParts: Seq[String] = immutable.this.Nil, queries: Map[String, Seq[String]] = ..., fn: (Request) ⇒ Request = ...) extends Builder[Request] with Product with Serializable

34. trait Retrieval[T, From] extends AnyRef

    Represents the ability to retrieve a parameter value from an enclosing object (request/form etc.

35. sealed trait Security extends AnyRef

    Endpoint security.

36. abstract class SingleFormField[T] extends FormField[T]

37. abstract class SingleQueryParameter[T] extends QueryParameter[T]

38. class UniBody[T] extends Body[T] with Bindable[T, RequestBinding] with MandatoryRebind[T, Message, RequestBinding]

    Represents a single entity which makes up the entirety of an HTTP message body.

39. trait Validatable[T, From] extends AnyRef

    Provides validation about the presence of a value parameter/entity value in a particular context