Class

akka.http.scaladsl.model.headers

CustomHeader

Related Doc: package headers

Permalink

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

Instance Constructors

  1. new CustomHeader()

    Permalink

Abstract Value Members

  1. abstract def name(): String

    Permalink
    Definition Classes
    CustomHeader → HttpHeader → HttpHeader

  2. abstract def renderInRequests(): Boolean

    Permalink
    Definition Classes
    HttpHeader

  3. abstract def renderInResponses(): Boolean

    Permalink
    Definition Classes
    HttpHeader

  4. abstract def value(): String

    Permalink
    Definition Classes
    CustomHeader → HttpHeader → HttpHeader

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from CustomHeader to any2stringadd[CustomHeader] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (CustomHeader, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CustomHeader to ArrowAssoc[CustomHeader] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (CustomHeader) ⇒ Boolean, msg: ⇒ Any): CustomHeader

    Permalink
    Implicit information
    This member is added by an implicit conversion from CustomHeader to Ensuring[CustomHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (CustomHeader) ⇒ Boolean): CustomHeader

    Permalink
    Implicit information
    This member is added by an implicit conversion from CustomHeader to Ensuring[CustomHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): CustomHeader

    Permalink
    Implicit information
    This member is added by an implicit conversion from CustomHeader to Ensuring[CustomHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): CustomHeader

    Permalink
    Implicit information
    This member is added by an implicit conversion from CustomHeader to Ensuring[CustomHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from CustomHeader to StringFormat[CustomHeader] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. def is(nameInLowerCase: String): Boolean

    Permalink
    Definition Classes
    HttpHeader → HttpHeader

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. def isNot(nameInLowerCase: String): Boolean

    Permalink
    Definition Classes
    HttpHeader → HttpHeader

  21. def lowercaseName(): String

    Permalink
    Definition Classes
    CustomHeader → HttpHeader → HttpHeader

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. final def render[R <: Rendering](r: R): r.type

    Permalink
    Definition Classes
    CustomHeader → Renderable

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  27. def toString(): String

    Permalink
    Definition Classes
    ToStringRenderable → AnyRef → Any

  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. def →[B](y: B): (CustomHeader, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CustomHeader to ArrowAssoc[CustomHeader] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

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 from CustomHeader to any2stringadd[CustomHeader]

Inherited by implicit conversion StringFormat from CustomHeader to StringFormat[CustomHeader]

Inherited by implicit conversion Ensuring from CustomHeader to Ensuring[CustomHeader]

Inherited by implicit conversion ArrowAssoc from CustomHeader to ArrowAssoc[CustomHeader]

Ungrouped