Packages

package headers

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. final case class Accept(mediaRanges: Seq[MediaRange]) extends javadsl.model.headers.Accept with RequestHeader with Product with Serializable
  2. final case class Accept-Charset(charsetRanges: Seq[HttpCharsetRange]) extends AcceptCharset with RequestHeader with Product with Serializable
  3. final case class Accept-Encoding(encodings: Seq[HttpEncodingRange]) extends AcceptEncoding with RequestHeader with Product with Serializable
  4. final case class Accept-Language(languages: Seq[LanguageRange]) extends AcceptLanguage with RequestHeader with Product with Serializable
  5. final case class Accept-Ranges(rangeUnits: Seq[RangeUnit]) extends AcceptRanges with ResponseHeader with Product with Serializable
  6. final case class Access-Control-Allow-Credentials(allow: Boolean) extends AccessControlAllowCredentials with ResponseHeader with Product with Serializable
  7. final case class Access-Control-Allow-Headers(headers: Seq[String]) extends AccessControlAllowHeaders with ResponseHeader with Product with Serializable
  8. final case class Access-Control-Allow-Methods(methods: Seq[HttpMethod]) extends AccessControlAllowMethods with ResponseHeader with Product with Serializable
  9. final case class Access-Control-Allow-Origin extends AccessControlAllowOrigin with ResponseHeader with Product with Serializable
  10. final case class Access-Control-Expose-Headers(headers: Seq[String]) extends AccessControlExposeHeaders with ResponseHeader with Product with Serializable
  11. final case class Access-Control-Max-Age(deltaSeconds: Long) extends AccessControlMaxAge with ResponseHeader with Product with Serializable
  12. final case class Access-Control-Request-Headers(headers: Seq[String]) extends AccessControlRequestHeaders with RequestHeader with Product with Serializable
  13. final case class Access-Control-Request-Method(method: HttpMethod) extends AccessControlRequestMethod with RequestHeader with Product with Serializable
  14. final case class Age(deltaSeconds: Long) extends javadsl.model.headers.Age with ResponseHeader with Product with Serializable
  15. final case class Allow(methods: Seq[HttpMethod]) extends javadsl.model.headers.Allow with ResponseHeader with Product with Serializable
  16. final case class Authorization(credentials: HttpCredentials) extends javadsl.model.headers.Authorization with RequestHeader with Product with Serializable
  17. final case class BasicHttpCredentials(username: String, password: String) extends javadsl.model.headers.BasicHttpCredentials with Product with Serializable
  18. sealed abstract class ByteRange extends javadsl.model.headers.ByteRange with ValueRenderable
  19. final case class Cache-Control(directives: Seq[CacheDirective]) extends CacheControl with RequestResponseHeader with Product with Serializable
  20. sealed trait CacheDirective extends Renderable with javadsl.model.headers.CacheDirective
  21. final case class Connection(tokens: Seq[String]) extends javadsl.model.headers.Connection with RequestResponseHeader with Product with Serializable
  22. final case class Content-Disposition(dispositionType: ContentDispositionType, params: Map[String, String] = Map.empty) extends ContentDisposition with RequestResponseHeader with Product with Serializable
  23. final case class Content-Encoding(encodings: Seq[HttpEncoding]) extends ContentEncoding with RequestResponseHeader with Product with Serializable
  24. final case class Content-Length extends ContentLength with RequestResponseHeader with Product with Serializable

    Instances of this class will only be created transiently during header parsing and will never appear in HttpMessage.header.

    Instances of this class will only be created transiently during header parsing and will never appear in HttpMessage.header. To access the Content-Length, see subclasses of HttpEntity.

  25. final case class Content-Range(rangeUnit: RangeUnit, contentRange: ContentRange) extends javadsl.model.headers.ContentRange with RequestResponseHeader with Product with Serializable
  26. final case class Content-Type extends javadsl.model.headers.ContentType with RequestResponseHeader with Product with Serializable

    Instances of this class will only be created transiently during header parsing and will never appear in HttpMessage.header.

    Instances of this class will only be created transiently during header parsing and will never appear in HttpMessage.header. To access the Content-Type, see subclasses of HttpEntity.

  27. sealed trait ContentDispositionType extends Renderable with javadsl.model.headers.ContentDispositionType
  28. final case class Cookie(cookies: Seq[HttpCookiePair]) extends javadsl.model.headers.Cookie with RequestHeader with Product with Serializable
  29. abstract class CustomHeader extends javadsl.model.headers.CustomHeader

    Superclass for user-defined custom headers defined by implementing name and value.

    Superclass for user-defined custom headers defined by implementing name and value.

    Prefer to extend ModeledCustomHeader and ModeledCustomHeaderCompanion instead if planning to use the defined header in match clauses (e.g. in the routing layer of Akka HTTP), as they allow the custom header to be matched from RawHeader and vice-versa.

  30. final case class Date(date: DateTime) extends javadsl.model.headers.Date with RequestResponseHeader with Product with Serializable
  31. final case class ETag(etag: EntityTag) extends javadsl.model.headers.ETag with ResponseHeader with Product with Serializable
  32. final case class EntityTag(tag: String, weak: Boolean = false) extends javadsl.model.headers.EntityTag with ValueRenderable with Product with Serializable
  33. sealed abstract class EntityTagRange extends javadsl.model.headers.EntityTagRange with ValueRenderable
  34. sealed abstract case class Expect extends HttpHeader with RequestHeader with Product with Serializable
  35. final case class Expires(date: DateTime) extends javadsl.model.headers.Expires with ResponseHeader with Product with Serializable
  36. final case class GenericHttpCredentials(scheme: String, token: String, params: Map[String, String] = Map.empty) extends HttpCredentials with Product with Serializable
  37. final case class Host(host: Uri.Host, port: Int = 0) extends javadsl.model.headers.Host with RequestHeader with Product with Serializable
  38. final case class HttpChallenge(scheme: String, realm: String, params: Map[String, String] = Map.empty) extends javadsl.model.headers.HttpChallenge with ValueRenderable with Product with Serializable

    Note: the token of challenge is stored in the params Map as a parameter whose name is empty String("") for binary compatibility, but it will be parsed and rendered correctly.

  39. final case class HttpCookie(name: String, value: String, expires: Option[DateTime] = None, maxAge: Option[Long] = None, domain: Option[String] = None, path: Option[String] = None, secure: Boolean = false, httpOnly: Boolean = false, extension: Option[String] = None) extends javadsl.model.headers.HttpCookie with ToStringRenderable with Product with Serializable

    for a full definition of the http cookie header fields, see http://tools.ietf.org/html/rfc6265

  40. sealed abstract case class HttpCookiePair extends javadsl.model.headers.HttpCookiePair with ToStringRenderable with Product with Serializable

    for a full definition of the http cookie header fields, see http://tools.ietf.org/html/rfc6265 This class is sealed abstract to prevent generation of default apply method in companion

  41. abstract class HttpCredentials extends javadsl.model.headers.HttpCredentials with ValueRenderable
  42. final case class HttpEncoding extends javadsl.model.headers.HttpEncoding with LazyValueBytesRenderable with WithQValue[HttpEncodingRange] with Product with Serializable
  43. sealed abstract class HttpEncodingRange extends javadsl.model.headers.HttpEncodingRange with ValueRenderable with WithQValue[HttpEncodingRange]
  44. final case class HttpOrigin(scheme: String, host: Host) extends javadsl.model.headers.HttpOrigin with ValueRenderable with Product with Serializable
  45. abstract class HttpOriginRange extends javadsl.model.headers.HttpOriginRange with ValueRenderable
  46. final case class If-Match(m: EntityTagRange) extends IfMatch with RequestHeader with Product with Serializable
  47. final case class If-Modified-Since(date: DateTime) extends IfModifiedSince with RequestHeader with Product with Serializable
  48. final case class If-None-Match(m: EntityTagRange) extends IfNoneMatch with RequestHeader with Product with Serializable
  49. final case class If-Range(entityTagOrDateTime: Either[EntityTag, DateTime]) extends HttpHeader with RequestHeader with Product with Serializable
  50. final case class If-Unmodified-Since(date: DateTime) extends IfUnmodifiedSince with RequestHeader with Product with Serializable
  51. final case class IgnoredDirective(value: String) extends StrictTransportSecurityDirective with Product with Serializable
  52. final case class Language(primaryTag: String, subTags: Seq[String]) extends javadsl.model.headers.Language with ValueRenderable with WithQValue[LanguageRange] with Product with Serializable
  53. sealed trait LanguageRange extends javadsl.model.headers.LanguageRange with ValueRenderable with WithQValue[LanguageRange]
  54. final case class Last-Event-ID(id: String) extends LastEventId with RequestHeader with Product with Serializable
  55. final case class Last-Modified(date: DateTime) extends LastModified with ResponseHeader with Product with Serializable
  56. final case class Link(values: Seq[LinkValue]) extends javadsl.model.headers.Link with RequestResponseHeader with Product with Serializable
  57. sealed abstract class LinkParam extends javadsl.model.headers.LinkParam with ToStringRenderable
  58. final case class LinkValue(uri: Uri, params: Seq[LinkParam]) extends javadsl.model.headers.LinkValue with ValueRenderable with Product with Serializable
  59. final case class Location(uri: Uri) extends javadsl.model.headers.Location with ResponseHeader with Product with Serializable
  60. final case class MaxAge(value: Long) extends StrictTransportSecurityDirective with Product with Serializable
  61. sealed abstract class ModeledCompanion[T] extends Renderable
  62. abstract class ModeledCustomHeader[H <: ModeledCustomHeader[H]] extends CustomHeader

    Support class for building user-defined custom headers defined by implementing name and value.

    Support class for building user-defined custom headers defined by implementing name and value. By implementing a ModeledCustomHeader instead of CustomHeader directly, all needed unapply methods are provided for this class, such that it can be pattern matched on from RawHeader and the other way around as well.

  63. abstract class ModeledCustomHeaderCompanion[H <: ModeledCustomHeader[H]] extends AnyRef

    To be extended by companion object of a custom header extending ModeledCustomHeader.

    To be extended by companion object of a custom header extending ModeledCustomHeader. Implements necessary apply and unapply methods to make the such defined header feel "native".

  64. sealed trait ModeledHeader extends HttpHeader with Serializable
  65. final case class OAuth2BearerToken(token: String) extends javadsl.model.headers.OAuth2BearerToken with Product with Serializable
  66. final case class Origin(origins: Seq[HttpOrigin]) extends javadsl.model.headers.Origin with RequestHeader with Product with Serializable
  67. final case class ProductVersion(product: String = "", version: String = "", comment: String = "") extends javadsl.model.headers.ProductVersion with ValueRenderable with Product with Serializable
  68. final case class Proxy-Authenticate(challenges: Seq[HttpChallenge]) extends ProxyAuthenticate with ResponseHeader with Product with Serializable
  69. final case class Proxy-Authorization(credentials: HttpCredentials) extends ProxyAuthorization with RequestHeader with Product with Serializable
  70. final case class Range(rangeUnit: RangeUnit, ranges: Seq[ByteRange]) extends javadsl.model.headers.Range with RequestHeader with Product with Serializable
  71. sealed abstract class RangeUnit extends javadsl.model.headers.RangeUnit with ValueRenderable
  72. final case class Raw-Request-URI(uri: String) extends RawRequestURI with SyntheticHeader with Product with Serializable
  73. final case class RawHeader(name: String, value: String) extends javadsl.model.headers.RawHeader with Product with Serializable
  74. final case class Referer(uri: Uri) extends javadsl.model.headers.Referer with RequestHeader with Product with Serializable
  75. final case class Remote-Address(address: RemoteAddress) extends javadsl.model.headers.RemoteAddress with SyntheticHeader with Product with Serializable
  76. final case class Retry-After(delaySecondsOrDateTime: RetryAfterParameter) extends RetryAfter with ResponseHeader with Product with Serializable
  77. final case class RetryAfterDateTime(dateTime: DateTime) extends RetryAfterParameter with Product with Serializable
  78. final case class RetryAfterDuration(delayInSeconds: Long) extends RetryAfterParameter with Product with Serializable
  79. sealed abstract class RetryAfterParameter extends AnyRef

    Defines different values admitted to define a `Retry-After` header.

    Defines different values admitted to define a `Retry-After` header.

    Spec: https://tools.ietf.org/html/rfc7231#section-7.1.3

  80. final case class Server(products: Seq[ProductVersion]) extends javadsl.model.headers.Server with ResponseHeader with Product with Serializable
  81. final case class Set-Cookie(cookie: HttpCookie) extends SetCookie with ResponseHeader with Product with Serializable
  82. final case class Strict-Transport-Security(maxAge: Long, includeSubDomains: Boolean = false) extends StrictTransportSecurity with ResponseHeader with Product with Serializable
  83. sealed abstract class StrictTransportSecurityDirective extends AnyRef

    Not for user extension

    Not for user extension

    Annotations
    @DoNotInherit()
  84. final case class Timeout-Access(timeoutAccess: TimeoutAccess) extends javadsl.model.headers.TimeoutAccess with SyntheticHeader with Product with Serializable
  85. final case class Tls-Session-Info(session: SSLSession) extends TlsSessionInfo with SyntheticHeader with ScalaSessionAPI with Product with Serializable
  86. final case class Transfer-Encoding(encodings: Seq[TransferEncoding]) extends javadsl.model.headers.TransferEncoding with RequestResponseHeader with Product with Serializable
  87. final case class Upgrade(protocols: Seq[UpgradeProtocol]) extends HttpHeader with RequestResponseHeader with Product with Serializable
  88. final case class UpgradeProtocol(name: String, version: Option[String] = None) extends ValueRenderable with Product with Serializable
  89. final case class User-Agent(products: Seq[ProductVersion]) extends UserAgent with RequestHeader with Product with Serializable
  90. final case class WWW-Authenticate(challenges: Seq[HttpChallenge]) extends WWWAuthenticate with ResponseHeader with Product with Serializable
  91. final case class WebSocketExtension(name: String, params: Map[String, String] = Map.empty) extends ValueRenderable with Product with Serializable

    A websocket extension as defined in http://tools.ietf.org/html/rfc6455#section-4.3

  92. final case class X-Forwarded-For(addresses: Seq[RemoteAddress]) extends XForwardedFor with RequestHeader with Product with Serializable
  93. final case class X-Forwarded-Host(host: Uri.Host) extends XForwardedHost with RequestHeader with Product with Serializable

    De-facto standard as per https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host

    De-facto standard as per https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host

    Annotations
    @ApiMayChange()
  94. final case class X-Forwarded-Proto(protocol: String) extends XForwardedProto with RequestHeader with Product with Serializable

    de-facto standard as per https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto

    de-facto standard as per https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto

    Annotations
    @ApiMayChange()
  95. final case class X-Real-Ip(address: RemoteAddress) extends XRealIp with RequestHeader with Product with Serializable

Value Members

  1. object Accept extends ModeledCompanion[Accept] with Serializable
  2. object Accept-Charset extends ModeledCompanion[Accept-Charset] with Serializable
  3. object Accept-Encoding extends ModeledCompanion[Accept-Encoding] with Serializable
  4. object Accept-Language extends ModeledCompanion[Accept-Language] with Serializable
  5. object Accept-Ranges extends ModeledCompanion[Accept-Ranges] with Serializable
  6. object Access-Control-Allow-Credentials extends ModeledCompanion[Access-Control-Allow-Credentials] with Serializable
  7. object Access-Control-Allow-Headers extends ModeledCompanion[Access-Control-Allow-Headers] with Serializable
  8. object Access-Control-Allow-Methods extends ModeledCompanion[Access-Control-Allow-Methods] with Serializable
  9. object Access-Control-Allow-Origin extends ModeledCompanion[Access-Control-Allow-Origin] with Serializable
  10. object Access-Control-Expose-Headers extends ModeledCompanion[Access-Control-Expose-Headers] with Serializable
  11. object Access-Control-Max-Age extends ModeledCompanion[Access-Control-Max-Age] with Serializable
  12. object Access-Control-Request-Headers extends ModeledCompanion[Access-Control-Request-Headers] with Serializable
  13. object Access-Control-Request-Method extends ModeledCompanion[Access-Control-Request-Method] with Serializable
  14. object Age extends ModeledCompanion[Age] with Serializable
  15. object Allow extends ModeledCompanion[Allow] with Serializable
  16. object Authorization extends ModeledCompanion[Authorization] with Serializable
  17. object BasicHttpCredentials extends Serializable
  18. object ByteRange
  19. object Cache-Control extends ModeledCompanion[Cache-Control] with Serializable
  20. object CacheDirective
  21. object CacheDirectives
  22. object Connection extends ModeledCompanion[Connection] with Serializable
  23. object Content-Disposition extends ModeledCompanion[Content-Disposition] with Serializable

    Document http://tools.ietf.org/html/rfc6266 updates document https://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html.

    Document http://tools.ietf.org/html/rfc6266 updates document https://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html. Between these two there is slight but important difference regarding how parameter values are formatted. In RFC6266 parameters values are without quotes and in RFC2616 they are quoted. Since common practice among http servers is to understand quoted values, we use older document as reference here.

  24. object Content-Encoding extends ModeledCompanion[Content-Encoding] with Serializable
  25. object Content-Length extends ModeledCompanion[Content-Length] with Serializable
  26. object Content-Range extends ModeledCompanion[Content-Range] with Serializable
  27. object Content-Type extends ModeledCompanion[Content-Type] with Serializable
  28. object ContentDispositionTypes
  29. object Cookie extends ModeledCompanion[Cookie] with Serializable
  30. object Date extends ModeledCompanion[Date] with Serializable
  31. object ETag extends ModeledCompanion[ETag] with Serializable
  32. object EntityTag extends Serializable
  33. object EntityTagRange
  34. object Expect extends ModeledCompanion[Expect] with Serializable
  35. object Expires extends ModeledCompanion[Expires] with Serializable
  36. object GenericHttpCredentials extends Serializable
  37. object Host extends ModeledCompanion[Host] with Serializable
  38. object HttpChallenge extends AbstractFunction3[String, String, Map[String, String], HttpChallenge] with Serializable
  39. object HttpChallenges
  40. object HttpCookie extends Serializable
  41. object HttpCookiePair extends Serializable
  42. object HttpEncoding extends Serializable
  43. object HttpEncodingRange
  44. object HttpEncodings extends ObjectRegistry[String, HttpEncoding]
  45. object HttpOrigin extends Serializable
  46. object HttpOriginRange
  47. object If-Match extends ModeledCompanion[If-Match] with Serializable
  48. object If-Modified-Since extends ModeledCompanion[If-Modified-Since] with Serializable
  49. object If-None-Match extends ModeledCompanion[If-None-Match] with Serializable
  50. object If-Range extends ModeledCompanion[If-Range] with Serializable
  51. object If-Unmodified-Since extends ModeledCompanion[If-Unmodified-Since] with Serializable
  52. object IncludeSubDomains extends StrictTransportSecurityDirective with Product with Serializable
  53. object Language extends Serializable
  54. object LanguageRange
  55. object Last-Event-ID extends ModeledCompanion[Last-Event-ID] with Serializable
  56. object Last-Modified extends ModeledCompanion[Last-Modified] with Serializable
  57. object Link extends ModeledCompanion[Link] with Serializable
  58. object LinkParam
  59. object LinkParams
  60. object LinkValue extends Serializable
  61. object Location extends ModeledCompanion[Location] with Serializable
  62. object Origin extends ModeledCompanion[Origin] with Serializable
  63. object ProductVersion extends Serializable
  64. object Proxy-Authenticate extends ModeledCompanion[Proxy-Authenticate] with Serializable
  65. object Proxy-Authorization extends ModeledCompanion[Proxy-Authorization] with Serializable
  66. object Range extends ModeledCompanion[Range] with Serializable
  67. object RangeUnits
  68. object Raw-Request-URI extends ModeledCompanion[Raw-Request-URI] with Serializable
  69. object RawHeader extends Serializable
  70. object Referer extends ModeledCompanion[Referer] with Serializable
  71. object Remote-Address extends ModeledCompanion[Remote-Address] with Serializable
  72. object Retry-After extends ModeledCompanion[Retry-After] with Serializable
  73. object Server extends ModeledCompanion[Server] with Serializable
  74. object Set-Cookie extends ModeledCompanion[Set-Cookie] with Serializable
  75. object Strict-Transport-Security extends ModeledCompanion[Strict-Transport-Security] with Serializable
  76. object Timeout-Access extends ModeledCompanion[Timeout-Access] with Serializable
  77. object Tls-Session-Info extends ModeledCompanion[Tls-Session-Info] with Serializable

    Model for the synthetic Tls-Session-Info header which carries the SSLSession of the connection the message carrying this header was received with.

    Model for the synthetic Tls-Session-Info header which carries the SSLSession of the connection the message carrying this header was received with.

    This header will only be added if it enabled in the configuration by setting

    akka.http.[client|server].parsing.tls-session-info-header = on

  78. object Transfer-Encoding extends ModeledCompanion[Transfer-Encoding] with Serializable
  79. object Upgrade extends ModeledCompanion[Upgrade] with Serializable
  80. object User-Agent extends ModeledCompanion[User-Agent] with Serializable
  81. object WWW-Authenticate extends ModeledCompanion[WWW-Authenticate] with Serializable
  82. object X-Forwarded-For extends ModeledCompanion[X-Forwarded-For] with Serializable
  83. object X-Forwarded-Host extends ModeledCompanion[X-Forwarded-Host] with Serializable
  84. object X-Forwarded-Proto extends ModeledCompanion[X-Forwarded-Proto] with Serializable
  85. object X-Real-Ip extends ModeledCompanion[X-Real-Ip] with Serializable

Ungrouped