scamper20.0.1 < Back

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.

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.

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

HttpServer

Companion trait HttpServer

object HttpServer

Provides factory for creating HttpServer.

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

HttpServer
AnyRef
Any

Hide All
Show All

Visibility

Public
All

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
def app(): ServerApplication
Gets new instance of server application.
def apply(host: InetAddress, port: Int, key: File, cert: File)(handler: RequestHandler): HttpServer
Creates secure server at given host and port using supplied handler.
Creates secure server at given host and port using supplied handler.
The SSL/TLS server connection is created with supplied key and certificate.
host
host address
port
port number
key
private key
cert
public key certificate
handler
request handler
returns
server
def apply(host: InetAddress, port: Int)(handler: RequestHandler): HttpServer
Creates server at given host and port using supplied handler.
Creates server at given host and port using supplied handler.
host
host address
port
port number
handler
request handler
returns
server
def apply(host: String, port: Int, key: File, cert: File)(handler: RequestHandler): HttpServer
Creates secure server at given host and port using supplied handler.
Creates secure server at given host and port using supplied handler.
The SSL/TLS server connection is created with supplied key and certificate.
host
host address
port
port number
key
private key
cert
public key certificate
handler
request handler
returns
server
def apply(host: String, port: Int)(handler: RequestHandler): HttpServer
Creates server at given host and port using supplied handler.
Creates server at given host and port using supplied handler.
host
host address
port
port number
handler
request handler
returns
server
def apply(port: Int, key: File, cert: File)(handler: RequestHandler): HttpServer
Creates secure server at given port using supplied handler.
Creates secure server at given port using supplied handler.
The SSL/TLS server connection is created with supplied key and certificate.
port
port number
key
private key
cert
public key certificate
handler
request handler
returns
server
def apply(port: Int)(handler: RequestHandler): HttpServer
Creates server at given port using supplied handler.
Creates server at given port using supplied handler.
port
port number
handler
request handler
returns
server
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... ) @native()

Packages

HTTP Messages

Building HTTP Server

HttpServer

Companion trait HttpServer

object HttpServer

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

HTTP Messages

Building HTTP Server

HttpServer 

Companion trait HttpServer

object HttpServer

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

HttpServer