Packages

package root

Definition Classes: root

package com

Definition Classes: root

package twitter

Start with com.twitter.finagle.

Definition Classes: com

package finagle

Finagle is an extensible RPC system.

Services are represented by class com.twitter.finagle.Service. Clients make use of com.twitter.finagle.Service objects while servers implement them.

Finagle contains a number of protocol implementations; each of these implement Client and/or com.twitter.finagle.Server. For example, Finagle's HTTP implementation, com.twitter.finagle.Http (in package finagle-http), exposes both.

Thus a simple HTTP server is built like this:

import com.twitter.finagle.{Http, Service}
import com.twitter.finagle.http.{Request, Response}
import com.twitter.util.{Await, Future}

val service = new Service[Request, Response] {
  def apply(req: Request): Future[Response] =
    Future.value(Response())
}
val server = Http.server.serve(":8080", service)
Await.ready(server)

We first define a service to which requests are dispatched. In this case, the service returns immediately with a HTTP 200 OK response, and with no content.

This service is then served via the Http protocol on TCP port 8080. Finally we wait for the server to stop serving.

We can now query our web server:

% curl -D - localhost:8080
HTTP/1.1 200 OK

Building an HTTP client is also simple. (Note that type annotations are added for illustration.)

import com.twitter.finagle.{Http, Service}
import com.twitter.finagle.http.{Request, Response}
import com.twitter.util.{Future, Return, Throw}

val client: Service[Request, Response] = Http.client.newService("localhost:8080")
val f: Future[Response] = client(Request()).respond {
  case Return(rep) =>
    printf("Got HTTP response %s\n", rep)
  case Throw(exc) =>
    printf("Got error %s\n", exc)
}

Http.client.newService("localhost:8080") constructs a new com.twitter.finagle.Service instance connected to localhost TCP port 8080. We then issue a HTTP/1.1 GET request to URI "/". The service returns a com.twitter.util.Future representing the result of the operation. We listen to this future, printing an appropriate message when the response arrives.

The Finagle homepage contains useful documentation and resources for using Finagle.

Definition Classes: twitter

package http

Definition Classes: finagle

package codec

Definition Classes: http

package collection

Definition Classes: http

package cookie

Definition Classes: http

package exp

Definition Classes: http

package filter

Definition Classes: http

package headers

Definition Classes: http

package param

Definition Classes: http

package path

Definition Classes: http

package service

Definition Classes: http

package util

Definition Classes: http

AuthenticatedIdentityContext

Chunk

CookieMap

CookieMapVersionSpecific

HeaderMapVersionSpecific

KerberosAuthenticationFilter

LoadBalancedHostFilter

ParamMapVersionSpecific

TooLongMessageException

Uri

Version

defaultClientProtocol

defaultServerProtocol

serverErrorsAsFailures

com.twitter.finagle.http

SpnegoAuthenticator

object SpnegoAuthenticator

A SPNEGO HTTP authenticator as defined in https://tools.ietf.org/html/rfc4559, which gets its credentials from a provided CredentialSource... usually JAAS.

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

SpnegoAuthenticator
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

trait Authenticated[Req] extends AnyRef
An authenticated HTTP request, with its GSS context.
sealed abstract class Client[Req, Rsp] extends Filter[Req, Rsp, Req, Rsp]
case class ClientFilter(credSrc: ClientSource) extends Client[Request, Response] with Product with Serializable
case class Negotiated(established: Option[GSSContext], wwwAuthenticate: Option[String]) extends Product with Serializable
sealed trait ReqSupport[Req] extends AnyRef
A typeclass to get/set fields of http requests of type Req.
A typeclass to get/set fields of http requests of type Req. TODO: Remove after http and http are merged
sealed trait RspSupport[Rsp] extends AnyRef
A typeclass to get/set fields of http responses of type Rsp.
A typeclass to get/set fields of http responses of type Rsp. TODO: Remove after http and http are merged
sealed abstract class Server[Req, Rsp] extends Filter[Req, Rsp, Authenticated[Req], Rsp]
case class ServerFilter(credSrc: ServerSource) extends Server[Request, Response] with Product with Serializable
type Token = Array[Byte]

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
val AuthScheme: String
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
implicit val httpRequestSupport: ReqSupport[Request]
implicit val httpResponseSupport: RspSupport[Response]
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(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
object Authenticated
object Credentials
object Token

Packages

SpnegoAuthenticator

object SpnegoAuthenticator

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

SpnegoAuthenticator

object SpnegoAuthenticator

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

SpnegoAuthenticator