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 Pekko HTTP), as they allow the custom header to be matched from RawHeader and vice-versa.

Source
headers.scala
Linear Supertypes
Known Subclasses
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
    CustomHeaderHttpHeaderHttpHeader
  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
    CustomHeaderHttpHeaderHttpHeader

Concrete Value Members

  1. 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
    HttpHeaderHttpHeader
  2. def isNot(nameInLowerCase: String): Boolean

    Returns !is(nameInLowerCase).

    Returns !is(nameInLowerCase).

    Definition Classes
    HttpHeaderHttpHeader
  3. def lowercaseName(): String

    Returns the lower-cased name of the header.

    Returns the lower-cased name of the header.

    Definition Classes
    CustomHeaderHttpHeaderHttpHeader
  4. final def render[R <: Rendering](r: R): r.type
    Definition Classes
    CustomHeader → Renderable
  5. def toString(): String
    Definition Classes
    ToStringRenderable → AnyRef → Any
  6. def unsafeToString: String
    Definition Classes
    HttpHeader