Packages

abstract class CustomHeader extends javadsl.model.headers.CustomHeader

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.

Source
headers.scala
Linear Supertypes
javadsl.model.headers.CustomHeader, HttpHeader, ToStringRenderable, Renderable, javadsl.model.HttpHeader, AnyRef, Any
Known Subclasses
ModeledCustomHeader
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CustomHeader
  2. CustomHeader
  3. HttpHeader
  4. ToStringRenderable
  5. Renderable
  6. HttpHeader
  7. AnyRef
  8. 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 CustomHeader()

Abstract Value Members

  1. abstract def name(): String

    Returns the name of the header.

    Returns the name of the header.

    Definition Classes
    CustomHeader → HttpHeader → HttpHeader
  2. abstract def renderInRequests(): Boolean

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

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

    Definition Classes
    HttpHeader
  3. abstract def renderInResponses(): Boolean

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

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

    Definition Classes
    HttpHeader
  4. abstract def value(): String

    Returns the String representation of the value of the header.

    Returns the String representation of the value of the header.

    Definition Classes
    CustomHeader → HttpHeader → HttpHeader

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 CustomHeader toany2stringadd[CustomHeader] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CustomHeader, B)
    Implicit
    This member is added by an implicit conversion from CustomHeader toArrowAssoc[CustomHeader] 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]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (CustomHeader) => Boolean, msg: => Any): CustomHeader
    Implicit
    This member is added by an implicit conversion from CustomHeader toEnsuring[CustomHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (CustomHeader) => Boolean): CustomHeader
    Implicit
    This member is added by an implicit conversion from CustomHeader toEnsuring[CustomHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): CustomHeader
    Implicit
    This member is added by an implicit conversion from CustomHeader toEnsuring[CustomHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): CustomHeader
    Implicit
    This member is added by an implicit conversion from CustomHeader toEnsuring[CustomHeader] 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
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. def is(nameInLowerCase: String): Boolean

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

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

    Definition Classes
    HttpHeader → HttpHeader
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isNot(nameInLowerCase: String): Boolean

    Returns !is(nameInLowerCase).

    Returns !is(nameInLowerCase).

    Definition Classes
    HttpHeader → HttpHeader
  19. def lowercaseName(): String

    Returns the lower-cased name of the header.

    Returns the lower-cased name of the header.

    Definition Classes
    CustomHeader → HttpHeader → HttpHeader
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def render[R <: Rendering](r: R): r.type
    Definition Classes
    CustomHeader → Renderable
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    ToStringRenderable → AnyRef → Any
  26. def unsafeToString: String
    Definition Classes
    HttpHeader
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. 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 CustomHeader toStringFormat[CustomHeader] 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): (CustomHeader, B)
    Implicit
    This member is added by an implicit conversion from CustomHeader toArrowAssoc[CustomHeader] 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 javadsl.model.headers.CustomHeader

Inherited from HttpHeader

Inherited from ToStringRenderable

Inherited from Renderable

Inherited from javadsl.model.HttpHeader

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromCustomHeader to any2stringadd[CustomHeader]

Inherited by implicit conversion StringFormat fromCustomHeader to StringFormat[CustomHeader]

Inherited by implicit conversion Ensuring fromCustomHeader to Ensuring[CustomHeader]

Inherited by implicit conversion ArrowAssoc fromCustomHeader to ArrowAssoc[CustomHeader]

Ungrouped