abstract class HttpHeader extends AnyRef

The base type representing Http headers. All actual header values will be instances of one of the subtypes defined in the headers packages. Unknown headers will be subtypes of org.apache.pekko.http.javadsl.model.headers.RawHeader. Not for user extension.

Annotations
@DoNotInherit()
Source
HttpHeader.java
Linear Supertypes
AnyRef, Any
Known Subclasses
Accept, AcceptCharset, AcceptEncoding, AcceptLanguage, AcceptRanges, AccessControlAllowCredentials, AccessControlAllowHeaders, AccessControlAllowMethods, AccessControlAllowOrigin, AccessControlExposeHeaders, AccessControlMaxAge, AccessControlRequestHeaders, AccessControlRequestMethod, Age, Allow, Authorization, CacheControl, Connection, ContentDisposition, ContentEncoding, ContentLength, ContentLocation, ContentRange, ContentType, Cookie, CustomHeader, Date, ETag, Expires, Host, IfMatch, IfModifiedSince, IfNoneMatch, IfUnmodifiedSince, LastEventId, LastModified, Link, Location, ModeledCustomHeader, Origin, ProxyAuthenticate, ProxyAuthorization, Range, RawHeader, RawRequestURI, Referer, RetryAfter, SecWebSocketProtocol, Server, SetCookie, StrictTransportSecurity, TE, TimeoutAccess, TlsSessionInfo, Trailer, TransferEncoding, UserAgent, WWWAuthenticate, XForwardedFor, XForwardedHost, XForwardedProto, XRealIp, HttpHeader, Accept, Accept-Charset, Accept-Encoding, Accept-Language, Accept-Ranges, Access-Control-Allow-Credentials, Access-Control-Allow-Headers, Access-Control-Allow-Methods, Access-Control-Allow-Origin, Access-Control-Expose-Headers, Access-Control-Max-Age, Access-Control-Request-Headers, Access-Control-Request-Method, Age, Allow, Authorization, Cache-Control, Connection, Content-Disposition, Content-Encoding, Content-Length, Content-Location, Content-Range, Content-Type, Cookie, CustomHeader, Date, ETag, Expect, Expires, Host, If-Match, If-Modified-Since, If-None-Match, If-Range, If-Unmodified-Since, Last-Event-ID, Last-Modified, Link, Location, ModeledCustomHeader, ModeledHeader, Origin, Proxy-Authenticate, Proxy-Authorization, Range, Raw-Request-URI, RawHeader, Referer, Retry-After, Server, Set-Cookie, Strict-Transport-Security, TE, Timeout-Access, Tls-Session-Info, Trailer, Transfer-Encoding, Upgrade, User-Agent, WWW-Authenticate, X-Forwarded-For, X-Forwarded-Host, X-Forwarded-Proto, X-Real-Ip
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpHeader
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new HttpHeader()

Abstract Value Members

  1. abstract def is(nameInLowerCase: String): Boolean

    Returns true if and only if nameInLowerCase.equals(lowercaseName()).

  2. abstract def isNot(nameInLowerCase: String): Boolean

    Returns !is(nameInLowerCase).

  3. abstract def lowercaseName(): String

    Returns the lower-cased name of the header.

  4. abstract def name(): String

    Returns the name of the header.

  5. abstract def renderInRequests(): Boolean

    Returns true if and only if the header is to be rendered in requests.

  6. abstract def renderInResponses(): Boolean

    Returns true if and only if the header is to be rendered in responses.

  7. abstract def value(): String

    Returns the String representation of the value of the header.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from HttpHeader toany2stringadd[HttpHeader] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HttpHeader, B)
    Implicit
    This member is added by an implicit conversion from HttpHeader toArrowAssoc[HttpHeader] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. def ensuring(cond: (HttpHeader) => Boolean, msg: => Any): HttpHeader
    Implicit
    This member is added by an implicit conversion from HttpHeader toEnsuring[HttpHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (HttpHeader) => Boolean): HttpHeader
    Implicit
    This member is added by an implicit conversion from HttpHeader toEnsuring[HttpHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): HttpHeader
    Implicit
    This member is added by an implicit conversion from HttpHeader toEnsuring[HttpHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): HttpHeader
    Implicit
    This member is added by an implicit conversion from HttpHeader toEnsuring[HttpHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HttpHeader toStringFormat[HttpHeader] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (HttpHeader, B)
    Implicit
    This member is added by an implicit conversion from HttpHeader toArrowAssoc[HttpHeader] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromHttpHeader to any2stringadd[HttpHeader]

Inherited by implicit conversion StringFormat fromHttpHeader to StringFormat[HttpHeader]

Inherited by implicit conversion Ensuring fromHttpHeader to Ensuring[HttpHeader]

Inherited by implicit conversion ArrowAssoc fromHttpHeader to ArrowAssoc[HttpHeader]

Ungrouped