Packages

package headers

Content Hierarchy

Type Members

  1. abstract class Accept extends scaladsl.model.HttpHeader

    Model for the Accept header.

    Model for the Accept header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-5.3.2

  2. abstract class AcceptCharset extends scaladsl.model.HttpHeader

    Model for the Accept-Charset header.

    Model for the Accept-Charset header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-5.3.3

  3. abstract class AcceptEncoding extends scaladsl.model.HttpHeader

    Model for the Accept-Encoding header.

    Model for the Accept-Encoding header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-5.3.4

  4. abstract class AcceptLanguage extends scaladsl.model.HttpHeader

    Model for the Accept-Language header.

    Model for the Accept-Language header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-5.3.5

  5. abstract class AcceptRanges extends scaladsl.model.HttpHeader

    Model for the Accept-Ranges header.

    Model for the Accept-Ranges header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-26#section-2.3

  6. abstract class AccessControlAllowCredentials extends scaladsl.model.HttpHeader

    Model for the Access-Control-Allow-Credentials header.

    Model for the Access-Control-Allow-Credentials header. Specification: http://www.w3.org/TR/cors/#access-control-allow-credentials-response-header

  7. abstract class AccessControlAllowHeaders extends scaladsl.model.HttpHeader

    Model for the Access-Control-Allow-Headers header.

    Model for the Access-Control-Allow-Headers header. Specification: http://www.w3.org/TR/cors/#access-control-allow-headers-response-header

  8. abstract class AccessControlAllowMethods extends scaladsl.model.HttpHeader

    Model for the Access-Control-Allow-Methods header.

    Model for the Access-Control-Allow-Methods header. Specification: http://www.w3.org/TR/cors/#access-control-allow-methods-response-header

  9. abstract class AccessControlAllowOrigin extends scaladsl.model.HttpHeader

    Model for the Access-Control-Allow-Origin header.

    Model for the Access-Control-Allow-Origin header. Specification: http://www.w3.org/TR/cors/#access-control-allow-origin-response-header

  10. abstract class AccessControlExposeHeaders extends scaladsl.model.HttpHeader

    Model for the Access-Control-Expose-Headers header.

    Model for the Access-Control-Expose-Headers header. Specification: http://www.w3.org/TR/cors/#access-control-expose-headers-response-header

  11. abstract class AccessControlMaxAge extends scaladsl.model.HttpHeader

    Model for the Access-Control-Max-Age header.

    Model for the Access-Control-Max-Age header. Specification: http://www.w3.org/TR/cors/#access-control-max-age-response-header

  12. abstract class AccessControlRequestHeaders extends scaladsl.model.HttpHeader

    Model for the Access-Control-Request-Headers header.

    Model for the Access-Control-Request-Headers header. Specification: http://www.w3.org/TR/cors/#access-control-request-headers-request-header

  13. abstract class AccessControlRequestMethod extends scaladsl.model.HttpHeader

    Model for the Access-Control-Request-Method header.

    Model for the Access-Control-Request-Method header. Specification: http://www.w3.org/TR/cors/#access-control-request-method-request-header

  14. abstract class Age extends scaladsl.model.HttpHeader

    Model for the Age header.

    Model for the Age header. Specification: http://tools.ietf.org/html/rfc7234#section-5.1

  15. abstract class Allow extends scaladsl.model.HttpHeader

    Model for the Allow header.

    Model for the Allow header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-7.4.1

  16. abstract class Authorization extends scaladsl.model.HttpHeader

    Model for the Authorization header.

    Model for the Authorization header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p7-auth-26#section-4.2

  17. abstract class BasicHttpCredentials extends scaladsl.model.headers.HttpCredentials
  18. abstract class ByteRange extends AnyRef
  19. abstract class CacheControl extends scaladsl.model.HttpHeader

    Model for the Cache-Control header.

    Model for the Cache-Control header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p6-cache-26#section-5.2

  20. trait CacheDirective extends AnyRef

    See also

    CacheDirectives for convenience access to often used values.

  21. final class CacheDirectives extends AnyRef
  22. abstract class Connection extends scaladsl.model.HttpHeader

    Model for the Connection header.

    Model for the Connection header. Specification: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.10

  23. abstract class ContentDisposition extends scaladsl.model.HttpHeader

    Model for the Content-Disposition header.

    Model for the Content-Disposition header. Specification: http://tools.ietf.org/html/rfc6266

  24. trait ContentDispositionType extends AnyRef

    See also

    ContentDispositionTypes for convenience access to often used values.

  25. final class ContentDispositionTypes extends AnyRef
  26. abstract class ContentEncoding extends scaladsl.model.HttpHeader

    Model for the Content-Encoding header.

    Model for the Content-Encoding header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-3.1.2.2

  27. abstract class ContentLength extends scaladsl.model.HttpHeader

    Model for the Content-Length header.

    Model for the Content-Length header. Specification: https://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-26#section-3.3.2

  28. abstract class ContentLocation extends scaladsl.model.HttpHeader

    Model for the ContentLocation header.

    Model for the ContentLocation header. Specification: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

  29. abstract class ContentRange extends scaladsl.model.HttpHeader

    Model for the Content-Range header.

    Model for the Content-Range header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-26#section-4.2

  30. abstract class ContentType extends scaladsl.model.HttpHeader

    Model for the Content-Type header.

    Model for the Content-Type header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-3.1.1.5

  31. abstract class Cookie extends scaladsl.model.HttpHeader

    Model for the Cookie header.

    Model for the Cookie header. Specification: https://tools.ietf.org/html/rfc6265#section-4.2

  32. abstract class CustomHeader extends scaladsl.model.HttpHeader

    The model of an HTTP header.

    The model of an HTTP header. In its most basic form headers are simple name-value pairs. Header names are compared in a case-insensitive way.

    Implement ModeledCustomHeader and ModeledCustomHeaderFactory instead of CustomHeader to be able to use the convenience methods that allow parsing the custom user-defined header from org.apache.pekko.http.javadsl.model.HttpHeader.

  33. abstract class Date extends scaladsl.model.HttpHeader

    Model for the Date header.

    Model for the Date header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-7.1.1.2

  34. abstract class ETag extends scaladsl.model.HttpHeader

    Model for the ETag header.

    Model for the ETag header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p4-conditional-26#section-2.3

  35. abstract class EntityTag extends AnyRef
  36. abstract class EntityTagRange extends AnyRef

    See also

    EntityTagRanges for convenience access to often used values.

  37. final class EntityTagRanges extends AnyRef
  38. abstract class Expires extends scaladsl.model.HttpHeader

    Model for the Expires header.

    Model for the Expires header. Specification: http://tools.ietf.org/html/rfc7234#section-5.3

  39. abstract class Host extends scaladsl.model.HttpHeader
  40. abstract class HttpChallenge extends AnyRef
  41. abstract class HttpCookie extends AnyRef
    Annotations
    @DoNotInherit()
  42. abstract class HttpCookiePair extends AnyRef

    Represents a cookie pair as used in the Cookie header as specified in http://tools.ietf.org/search/rfc6265#section-4.2.1

  43. abstract class HttpCredentials extends AnyRef
  44. abstract class HttpEncoding extends AnyRef
  45. abstract class HttpEncodingRange extends AnyRef

    See also

    HttpEncodingRanges for convenience access to often used values.

  46. final class HttpEncodingRanges extends AnyRef
  47. final class HttpEncodings extends AnyRef
  48. abstract class HttpOrigin extends AnyRef
  49. abstract class HttpOriginRange extends AnyRef

    See also

    HttpOriginRanges for convenience access to often used values.

  50. final class HttpOriginRanges extends AnyRef
  51. abstract class IfMatch extends scaladsl.model.HttpHeader

    Model for the If-Match header.

    Model for the If-Match header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p4-conditional-26#section-3.1

  52. abstract class IfModifiedSince extends scaladsl.model.HttpHeader

    Model for the If-Modified-Since header.

    Model for the If-Modified-Since header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p4-conditional-26#section-3.3

  53. abstract class IfNoneMatch extends scaladsl.model.HttpHeader

    Model for the If-None-Match header.

    Model for the If-None-Match header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p4-conditional-26#section-3.2

  54. abstract class IfUnmodifiedSince extends scaladsl.model.HttpHeader

    Model for the If-Unmodified-Since header.

    Model for the If-Unmodified-Since header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p4-conditional-26#section-3.4

  55. abstract class Language extends AnyRef
  56. trait LanguageRange extends AnyRef
  57. class LanguageRanges extends AnyRef
  58. abstract class LastEventId extends scaladsl.model.HttpHeader

    The Last-Event-ID header is sent by a client to the server to signal the ID of the last sever-sent event received.

  59. abstract class LastModified extends scaladsl.model.HttpHeader

    Model for the Last-Modified header.

    Model for the Last-Modified header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p4-conditional-26#section-2.2

  60. abstract class Link extends scaladsl.model.HttpHeader

    Model for the Link header.

    Model for the Link header. Specification: http://tools.ietf.org/html/rfc5988#section-5

  61. abstract class LinkParam extends AnyRef
  62. final class LinkParams extends AnyRef
  63. abstract class LinkValue extends AnyRef
  64. abstract class Location extends scaladsl.model.HttpHeader

    Model for the Location header.

    Model for the Location header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-7.1.2

  65. abstract class ModeledCustomHeader 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. Implement ModeledCustomHeader and ModeledCustomHeaderFactory instead of CustomHeader to be able to use the convenience methods that allow parsing the custom user-defined header from org.apache.pekko.http.javadsl.model.HttpHeader.

  66. abstract class ModeledCustomHeaderFactory[H <: ModeledCustomHeader] extends AnyRef

    Companion class for the ModeledCustomHeader class.

    Companion class for the ModeledCustomHeader class. It offers methods to create ModeledCustomHeader from String or HttpHeader.

  67. abstract class OAuth2BearerToken extends scaladsl.model.headers.HttpCredentials
  68. abstract class Origin extends scaladsl.model.HttpHeader

    Model for the Origin header.

    Model for the Origin header. Specification: http://tools.ietf.org/html/rfc6454#section-7

  69. abstract class ProductVersion extends AnyRef
  70. abstract class ProxyAuthenticate extends scaladsl.model.HttpHeader

    Model for the Proxy-Authenticate header.

    Model for the Proxy-Authenticate header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p7-auth-26#section-4.3

  71. abstract class ProxyAuthorization extends scaladsl.model.HttpHeader

    Model for the Proxy-Authorization header.

    Model for the Proxy-Authorization header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p7-auth-26#section-4.4

  72. abstract class Range extends scaladsl.model.HttpHeader

    Model for the Range header.

    Model for the Range header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-26#section-3.1

  73. abstract class RangeUnit extends AnyRef
  74. final class RangeUnits extends AnyRef
  75. abstract class RawHeader extends scaladsl.model.HttpHeader

    A header in its 'raw' name/value form, not parsed into a modelled header class.

    A header in its 'raw' name/value form, not parsed into a modelled header class. To add a custom header type, implement ModeledCustomHeader and ModeledCustomHeaderFactory rather than extending RawHeader

    Annotations
    @DoNotInherit()
  76. abstract class RawRequestURI extends scaladsl.model.HttpHeader

    Model for the Raw-Request-URI header.

    Model for the Raw-Request-URI header. Custom header we use for transporting the raw request URI either to the application (server-side) or to the request rendering stage (client-side).

  77. abstract class Referer extends scaladsl.model.HttpHeader

    Model for the Referer header.

    Model for the Referer header. Specification: http://tools.ietf.org/html/rfc7231#section-5.5.2

  78. abstract class RetryAfter extends scaladsl.model.HttpHeader

    Model for the Retry-After header.

    Model for the Retry-After header. Specification: //https://tools.ietf.org/html/rfc7231#section-7.1.3

  79. sealed final class SameSite extends Enum[SameSite]

    The Cookie SameSite attribute as defined by <a href="https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00">RFC6265bis and <a href="https://tools.ietf.org/html/draft-west-cookie-incrementalism-00">Incrementally Better Cookies.

  80. abstract class SecWebSocketProtocol extends scaladsl.model.HttpHeader

    Model for the Sec-WebSocket-Protocol header.

  81. abstract class Server extends scaladsl.model.HttpHeader

    Model for the Server header.

    Model for the Server header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-7.4.2

  82. abstract class SetCookie extends scaladsl.model.HttpHeader

    Model for the Set-Cookie header.

    Model for the Set-Cookie header. Specification: https://tools.ietf.org/html/rfc6265

  83. abstract class StrictTransportSecurity extends scaladsl.model.HttpHeader

    Model for the Strict-Transport-Security header.

    Model for the Strict-Transport-Security header. Specification: https://tools.ietf.org/html/rfc6797

  84. abstract class TE extends scaladsl.model.HttpHeader

    Model for the Transfer-Encoding header.

    Model for the Transfer-Encoding header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-26#section-3.3.1

  85. abstract class TimeoutAccess extends scaladsl.model.HttpHeader

    Model for the synthetic Timeout-Access header.

  86. abstract class TlsSessionInfo extends CustomHeader

    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 pekko.http.[client|server].parsing.tls-session-info-header = on.

  87. abstract class TransferEncoding extends scaladsl.model.HttpHeader

    Model for the Transfer-Encoding header.

    Model for the Transfer-Encoding header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-26#section-3.3.1

  88. abstract class UserAgent extends scaladsl.model.HttpHeader

    Model for the User-Agent header.

    Model for the User-Agent header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-26#section-5.5.3

  89. abstract class WWWAuthenticate extends scaladsl.model.HttpHeader

    Model for the WWW-Authenticate header.

    Model for the WWW-Authenticate header. Specification: http://tools.ietf.org/html/draft-ietf-httpbis-p7-auth-26#section-4.1

  90. abstract class XForwardedFor extends scaladsl.model.HttpHeader

    Model for the X-Forwarded-For header.

    Model for the X-Forwarded-For header. Specification: http://en.wikipedia.org/wiki/X-Forwarded-For

  91. abstract class XForwardedHost extends scaladsl.model.HttpHeader

    Model for the X-Forwarded-Host header.

    Model for the X-Forwarded-Host header. Specification: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host

  92. abstract class XForwardedProto extends scaladsl.model.HttpHeader

    Model for the X-Forwarded-Proto header.

    Model for the X-Forwarded-Proto header. Specification: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto

  93. abstract class XRealIp extends scaladsl.model.HttpHeader

    Model for the X-Real-Ip header.

Deprecated Type Members

  1. abstract class RemoteAddress extends scaladsl.model.HttpHeader

    Model for the Remote-Address header.

    Model for the Remote-Address header. Custom header we use for optionally transporting the peer's IP in an HTTP header.

    Deprecated since Akka HTTP 10.2.0: use the remote-header-attribute instead.

    Annotations
    @Deprecated
    Deprecated

Ungrouped