package http

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. http
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package client
  2. package impl
  3. package internal
  4. package router

Type Members

  1. trait Endpoint extends Annotation
    Annotations
    @Retention() @Target()
  2. sealed abstract class GrpcStatus extends PackSupport
  3. trait HttpBackend[Req, Resp, F[_]] extends AnyRef

    A base interface to implement http-server specific implementation

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

  5. class HttpClientException extends Exception

  6. case class HttpClientMaxRetryException(response: HttpResponse[_], retryContext: RetryContext, cause: Throwable) extends HttpClientException with Product with Serializable
  7. 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.

  8. 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

  9. 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[_]

  10. trait HttpFilterType extends AnyRef
  11. trait HttpLogger extends AutoCloseable

    Interface for writing HTTP request/response logs

  12. 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

  13. trait HttpMessage[Raw] extends HttpMessageBase[Raw]
  14. trait HttpMessageBase[Raw] extends AnyRef
  15. 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.

  16. case class HttpMultiMapEntry(key: String, value: String) extends Product with Serializable
  17. 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.

  18. trait HttpRequestAdapter[Req] extends AnyRef

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

  19. 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.

  20. trait HttpResponseAdapter[Resp] extends AnyRef

    A type class to bridge the original response type and HttpResponse

  21. class HttpServerException extends Exception with HttpServerExceptionBase

    Exception to report errors to client

  22. trait HttpServerExceptionBase extends AnyRef

  23. class HttpStatus extends PackSupport
  24. trait HttpSyncClient[Req, Resp] extends HttpSyncClientBase[Req, Resp] with AutoCloseable

    A synchronous HTTP Client interface

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

    A synchronous HttpClient that awaits responses.

  26. abstract class HttpSyncClientAdapterBase[F[_], Req, Resp] extends HttpSyncClient[Req, Resp]
  27. trait HttpSyncClientBase[Req, Resp] extends AnyRef
  28. trait RPC extends Annotation
    Annotations
    @Retention() @Target()
  29. trait RPCContext extends AnyRef
  30. sealed trait RPCEncoding extends AnyRef

  31. 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.

  32. 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

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

    RPC endpoint information

  34. sealed abstract class RPCStatus extends PackSupport

    A base class for defining standard RPC error codes

  35. sealed trait RPCStatusType extends PackSupport

    RPC status types

  36. 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

  37. trait RxHttpEndpoint extends AnyRef

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

  38. 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].

  39. trait RxRouteFilterBase extends AnyRef
  40. trait RxRouter extends AnyRef
  41. trait RxRouterObjectBase extends AnyRef
  42. 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]
}
  43. case class ServerAddress(host: String, port: Int, scheme: String = "http") extends Product with Serializable

    Server address holder

  44. trait description extends Annotation
    Annotations
    @Retention() @Target()

Deprecated Type Members

  1. 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

Value Members

  1. val compat: CompatApi
  2. case object BuildInfo extends Product with Serializable

    This object was generated by sbt-buildinfo.

  3. object EmptyRPCContext extends RPCContext

    An empty RPCContext

  4. object GrpcStatus

    gRPC error code definitions in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto

  5. object Http

    An entry point to access airframe-http functionalities

  6. object HttpBackend
  7. object HttpClient extends LogSupport
  8. object HttpClientException extends LogSupport

    Common classifiers for HTTP client responses and exceptions in order to retry HTTP requests.

  9. object HttpContext
  10. object HttpFilter
  11. object HttpHeader
  12. object HttpLogger extends LogSupport
  13. object HttpMessage

    Http request/response data type definitions

  14. object HttpMethod
  15. object HttpMultiMap extends Serializable
  16. object HttpStatus

    HTTP status code collection.

  17. object RPCContext
  18. object RPCEncoding
  19. object RPCException extends Serializable
  20. object RPCStatus

    Define the standard RPC code that can be used for generic RPC service implementation.

    Define the standard RPC code that can be used for generic RPC service implementation.

    This covers all gRPC statuses and have pre-defined mappings to HTTP status (4xx, 5xx) code.

    If you need an application-specific error code, use an additional argument of the RPCError class.

  21. object RPCStatusType
  22. object RxHttpFilter
  23. object RxRouter extends RxRouterObjectBase
  24. object ServerAddress extends LogSupport

Inherited from AnyRef

Inherited from Any

Ungrouped