Packages

•  package root

  Provided herein is API documentation for Scamper, the HTTP library for Scala.

  Provided herein is API documentation for Scamper, the HTTP library for Scala.

  Definition Classes

  root

•  package scamper

  Defines core types.

  Defines core types.

  HTTP Messages

  At the core of 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 a factory method 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").setHeaders(
    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 a factory method defined in its companion object. Or you can start with a ResponseStatus and use builder methods to further define the response.

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

  Definition Classes

  root

•  package server

  Provides HTTP server implementation.

  Provides HTTP server implementation.

  Building HTTP Server

  To build a server, you begin with ServerApplication. This is a mutable structure to which you apply changes to configure the server. Once the desired settings are applied, you invoke one of several methods to create the server.

  import java.io.File
  import scamper.BodyParser
  import scamper.Implicits.stringToEntity
  import scamper.ResponseStatus.Registry.{ NotFound, Ok }
  import scamper.server.HttpServer
  import scamper.server.Implicits._
  
  // Get server application
  val app = HttpServer.app()
  
  // Add request handler to log all requests
  app.incoming { req =>
    println(req.startLine)
    req
  }
  
  // Add request handler to specific request method and path
  app.get("/about") { req =>
    Ok("This server is powered by Scamper.")
  }
  
  // Add request handler using path parameter
  app.put("/data/:id") { req =>
    def update(id: Int, data: String): Boolean = ???
  
    implicit val parser = BodyParser.text()
  
    // Get path parameter
    val id = req.params.getInt("id")
  
    update(id, req.as[String]) match {
      case true  => Ok()
      case false => NotFound()
    }
  }
  
  // Serve static files
  app.files("/main", new File("/path/to/public"))
  
  // Gzip response body if not empty
  app.outgoing { res =>
    res.body.isKnownEmpty match {
      case true  => res
      case false => res.setGzipContentEncoding()
    }
  }
  
  // Create server
  val server = app.create(8080)
  
  printf("Host: %s%n", server.host)
  printf("Port: %d%n", server.port)
  
  // Run server for 60 seconds
  Thread.sleep(60 * 1000)
  
  // Close server when done
  server.close()

  Definition Classes

  scamper

• ErrorHandler
• HttpServer
• Implicits
• ParameterNotConvertible
• ParameterNotFound
• PathParameters
• RequestHandler
• ResponseAborted
• ResponseFilter
• Router
• ServerApplication
• WebSocketUpgrade

scamper.server

RequestHandler 

Companion object RequestHandler