Packages

•  package root

  Definition Classes

  root

•  package scamper

  At the core Scamper is HttpMessage, which is a trait that defines the fundamental characteristics of an HTTP message.

  HTTP Messages

  At the core Scamper is HttpMessage, which is a trait that defines the fundamental characteristics of an HTTP message. HttpRequest and HttpResponse extend the specification to define characteristics specific to their respective message types.

  An HttpRequest is created using one of the factory methods defined in its companion object. Or you can start with a RequestMethod and use builder methods to further define the request.

  import scamper.Header
  import scamper.Implicits.stringToUri
  import scamper.RequestMethod.Registry.GET
  
  val request = GET("/motd").withHeaders(
    Header("Host", "localhost:8080"),
    Header("Accept", "text/plain")
  )
  
  printf("Request Method: %s%n", request.method)
  printf("Target URI: %s%n", request.target)
  
  request.headers.foreach(println)
  
  val host: Option[String] = request.getHeaderValue("Host")

  An HttpResponse is created using one of the factory methods defined in its companion object. Or you can start with a ResponseStatus and use builder methods to further define the response.

  import scamper.{ BodyParsers, Header }
  import scamper.Implicits.stringToEntity
  import scamper.ResponseStatus.Registry.Ok
  
  val response = Ok("There is an answer.").withHeaders(
    Header("Content-Type", "text/plain"),
    Header("Connection", "close")
  )
  
  printf("Status Code: %s%n", response.status.code)
  printf("Reason Phrase: %s%n", response.status.reason)
  
  response.headers.foreach(println)
  
  val contentType: Option[String] = response.getHeaderValue("Content-Type")
  
  implicit val parser = BodyParsers.text()
  
  printf("Body: %s%n", response.as[String])

  Definition Classes

  root

•  package types

  Defines standardized types for header classes in scamper.headers.

  Defines standardized types for header classes in scamper.headers.

  import scamper.Implicits.{ stringToEntity, stringToUri }
  import scamper.RequestMethod.Registry.GET
  import scamper.ResponseStatus.Registry.Ok
  import scamper.headers.{ Accept, ContentType, TransferEncoding }
  import scamper.types.{ MediaRange, MediaType, TransferCoding }
  
  val json = MediaRange("application", "json", 0.9f)
  val html = MediaRange.parse("text/html; q=0.1")
  
  val req = GET("/motd").withAccept(json, html)
  
  val text = MediaType.parse("text/plain")
  val gzip = TransferCoding("gzip")
  
  val res = Ok("There is an answer.").withContentType(text).withTransferEncoding(gzip)

  Using values defined in Implicits, properly formatted strings can be implicitly converted to standardized types.

  import scamper.Implicits.{ stringToEntity, stringToUri }
  import scamper.RequestMethod.Registry.GET
  import scamper.ResponseStatus.Registry.Ok
  import scamper.headers.{ Accept, ContentType, TransferEncoding }
  import scamper.types.Implicits._
  
  val req = GET("/motd").withAccept("application/json; q=0.9", "text/html; q=0.1")
  
  val res = Ok("There is an answer.").withContentType("text/plain").withTransferEncoding("gzip")

  Definition Classes

  scamper

• ByteContentRange
• ByteRange
• CacheDirective
• CacheDirectives
• CharsetRange
• ContentCoding
• ContentCodingRange
• ContentRangeType
• DispositionType
• EntityTag
• Implicits
• KeepAliveParameters
• LanguageRange
• LanguageTag
• LinkValue
• MediaRange
• MediaType
• PragmaDirective
• PragmaDirectives
• Preference
• Preferences
• ProductType
• Protocol
• RangeType
• TransferCoding
• TransferCodingRange
• ViaType
• WarningType

scamper.types

ByteRange

Companion object ByteRange