Type Members

1.  class Endpoint extends Annotation with Annotation with ClassfileAnnotation

   Annotations

   @Retention() @Target()

2.  sealed abstract class GrpcStatus extends PackSupport
3.  case class HttpAccessLogConfig(fileName: String = "log/http_access.json", maxFiles: Int = 100, maxSize: Long = 100 * 1024 * 1024) extends Product with Serializable
4.  trait HttpAccessLogWriter extends AutoCloseable

5.  trait HttpBackend[Req, Resp, F[_]] extends AnyRef

   A base interface to implement http-server specific implementation

6.  trait HttpClientBase[F[_], Req, Resp] extends AnyRef

7.  class HttpClientException extends Exception

8.  case class HttpClientMaxRetryException(response: HttpResponse[_], retryContext: RetryContext, cause: Throwable) extends HttpClientException with Product with Serializable
9.  trait HttpContext[Req, Resp, F[_]] extends HttpContextBase

   Used for passing the subsequent actions to HttpFilter and for defining the leaf action of request processing chain.

10.  trait HttpContextBase extends AnyRef

    A base type to use classOf[HttpContextBase].

    A base type to use classOf[HttpContextBase]. classOf[HttpContext[_, _, _] is not supported for higherkinded types

11.  trait HttpFilter[Req, Resp, F[_]] extends HttpFilterType

    A filter interface to define actions for handling HTTP requests and responses.

    A filter interface to define actions for handling HTTP requests and responses.

    Implementations of HttpFilter must wrap an exception occurred in the filter.apply(request, context) with F[_]

12.  trait HttpFilterType extends AnyRef
13.  trait HttpLogger extends AutoCloseable

    Interface for writing HTTP request/response logs

14.  case class HttpLoggerConfig(logFileName: String = "log/http_access.json", excludeHeaders: Set[String] = HttpLogger.defaultExcludeHeaders, extraTags: Map[String, Any] = Map.empty, logFilter: (Map[String, Any]) ⇒ Map[String, Any] = identity, logFormatter: (Map[String, Any]) ⇒ String = HttpLogger.jsonFormatter, maxNumFiles: Int = 100, maxFileSize: Long = 100 * 1024 * 1024) extends Product with Serializable

    Http logger configuration

15.  trait HttpMessage[Raw] extends HttpMessageBase[Raw]
16.  trait HttpMessageBase[Raw] extends AnyRef
17.  case class HttpMultiMap(underlying: Map[String, Any] = Map.empty) extends Product with Serializable

    Immutable case-insensitive MultiMap structure for representing Http headers, query parameters, etc.

18.  case class HttpMultiMapEntry(key: String, value: String) extends Product with Serializable
19.  trait HttpRequest[Req] extends AnyRef

    HttpRequest[Req] wraps native request classes (e.g., okhttp's Response, finagle Response, etc.) so that we can implement common logic for various backends.

20.  trait HttpRequestAdapter[Req] extends AnyRef

    A type class to bridge the original requests and backend-specific request types (e.g., finagle, okhttp, etc.)

21.  trait HttpResponse[Resp] extends AnyRef

    HttpResponse[Resp] wraps native response classes (e.g., okhttp's Response, finagle Response, etc.) so that we can implement common logic for various backends.

22.  trait HttpResponseAdapter[Resp] extends AnyRef

    A type class to bridge the original response type and HttpResponse

23.  class HttpServerException extends Exception with HttpServerExceptionBase

    Exception to report errors to client

24.  trait HttpServerExceptionBase extends AnyRef

25.  class HttpStatus extends PackSupport
26.  trait HttpSyncClient[Req, Resp] extends HttpSyncClientBase[Req, Resp] with AutoCloseable

    A synchronous HTTP Client interface

27.  class HttpSyncClientAdapter[F[_], Req, Resp] extends HttpSyncClientAdapterBase[F, Req, Resp]

    A synchronous HttpClient that awaits responses.

28.  abstract class HttpSyncClientAdapterBase[F[_], Req, Resp] extends HttpSyncClient[Req, Resp]
29.  trait HttpSyncClientBase[Req, Resp] extends AnyRef
30.  class RPC extends Annotation with Annotation with ClassfileAnnotation

    Annotations

    @Retention() @Target()

31.  trait RPCContext extends AnyRef
32.  sealed trait RPCEncoding extends AnyRef

33.  case class RPCErrorMessage(code: Int = RPCStatus.UNKNOWN_I1.code, codeName: String = RPCStatus.UNKNOWN_I1.name, message: String = "", stackTrace: Option[Seq[GenericStackTraceElement]] = None, cause: Option[Throwable] = None, appErrorCode: Option[Int] = None, metadata: Map[String, Any] = Map.empty) extends Product with Serializable

    A model class for RPC error message body.

    A model class for RPC error message body. This message will be embedded to HTTP response body or gRPC trailer.

    We need this class to avoid directly serde RPCException classes with airframe-codec, so that we can properly propagate the exact stack trace to the client.

34.  case class RPCException(status: RPCStatus = RPCStatus.INTERNAL_ERROR_I0, message: String = "", cause: Option[Throwable] = None, appErrorCode: Option[Int] = None, metadata: Map[String, Any] = Map.empty) extends Exception with LogSupport with Product with Serializable

    RPCException provides a backend-independent (e.g., Finagle or gRPC) RPC error reporting mechanism.

    RPCException provides a backend-independent (e.g., Finagle or gRPC) RPC error reporting mechanism. Create this exception with (RPCStatus code).toException(...) method.

    If necessary, we can add more standard error_details parameter like https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto

35.  case class RPCMethod(path: String, rpcInterfaceName: String, methodName: String, requestSurface: Surface, responseSurface: Surface) extends Product with Serializable

    RPC endpoint information

36.  sealed abstract class RPCStatus extends PackSupport

    A base class for defining standard RPC error codes

37.  sealed trait RPCStatusType extends PackSupport

    RPC status types

38.  case class Router(surface: Option[Surface] = None, children: Seq[Router] = Seq.empty, localRoutes: Seq[Route] = Seq.empty, filterSurface: Option[Surface] = None, filterInstance: Option[HttpFilterType] = None, controllerInstance: Option[Any] = None) extends RouterBase with LogSupport with Product with Serializable

    Router defines mappings from HTTP requests to Routes.

    Router defines mappings from HTTP requests to Routes.

    Router can be nested

    • Router1 with Filter1
      • Router2: endpoints e1, e2
      • Router3: endpoints e3 with Filter2
    • Router4: endpoints e4

    From this router definition, the backend HTTP server specific implementation will build a mapping table like this: e1 -> Filter1 andThen process(e1) e2 -> Filter1 andThen process(e2) e3 -> Filter1 andThen Filter2 andThen process(e3) e4 -> process(e4)

39.  trait RxHttpBackend extends AnyRef

    Rx-based http server backend interface, which will be used for hiding the server implementation detailes between Netty, Finagle, and gRPC

40.  trait RxHttpEndpoint extends AnyRef

    RxHttpEndpoint is a terminal for processing requests and returns Rx[Response].

41.  trait RxHttpFilter extends AnyRef

    An RxHttpFilter is a filter for receiving the response from the endpoint via endpoint.apply(request), and transforming it into another Rx[Response].

42.  trait RxRouteFilterBase extends AnyRef
43.  trait RxRouter extends AnyRef
44.  trait RxRouterObjectBase extends AnyRef
45.  trait RxRouterProvider extends AnyRef

    An interface used for RPC clients (sbt-airframe) to discover the default router for the RPC endpoint.

    An interface used for RPC clients (sbt-airframe) to discover the default router for the RPC endpoint.

    Example usage:

    import wvlet.airframe.http._
    
    @RPC
    trait MyRPC {
      def hello(name:String) : String
    }
    
    object MyRPC extends RxRouterProvider {
      // sbt-airframe will generate an RPC client using this router
      override def router: RxRouter = RxRouter.of[MyRPC]
    }

46.  case class ServerAddress(host: String, port: Int, scheme: String = "http") extends Product with Serializable

    Server address holder

47.  case class StaticContent(resourcePaths: List[ResourceType] = List.empty) extends Product with Serializable
48.  class description extends Annotation with Annotation with ClassfileAnnotation

    Annotations

    @Retention() @Target()

49.  trait HttpClient[F[_], Req, Resp] extends HttpClientBase[F, Req, Resp] with AutoCloseable

    Asynchronous HTTP Client interface

    Asynchronous HTTP Client interface

    F

    An abstraction for Future type (e.g., Resolves the differences between Twitter Future, Scala Future, etc.)

    Annotations

    @deprecated

    Deprecated

    (Since version 24.5.0) Use wvlet.airframe.http.client.Sync/AsyncClient