Package org.apache.pekko.http.scaladsl.model.headers

Class CustomHeader

java.lang.Object

org.apache.pekko.http.javadsl.model.HttpHeader

org.apache.pekko.http.scaladsl.model.HttpHeader

org.apache.pekko.http.javadsl.model.headers.CustomHeader

org.apache.pekko.http.scaladsl.model.headers.CustomHeader

All Implemented Interfaces:

Renderable, ToStringRenderable

Direct Known Subclasses:

InternalCustomHeader, ModeledCustomHeader, NewConnectionPoolSpec.ConnNrHeader

public abstract class CustomHeader
extends 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.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pekko.http.scaladsl.model.HttpHeader

HttpHeader.ParsingResult, HttpHeader.ParsingResult$

Constructor Summary

Constructors

Constructor	Description
CustomHeader()

Method Summary

Modifier and Type	Method	Description
String	lowercaseName()	Returns the lower-cased name of the header.
final <R extends Rendering> Rendering	render(R r)

Methods inherited from class org.apache.pekko.http.javadsl.model.headers.CustomHeader

name, value

Methods inherited from class org.apache.pekko.http.scaladsl.model.HttpHeader

fastFind, is, isNot, parse, unapply, unsafeToString

Methods inherited from class org.apache.pekko.http.javadsl.model.HttpHeader

parse, renderInRequests, renderInResponses

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.pekko.http.impl.util.ToStringRenderable

toString

Constructor Details

CustomHeader

public CustomHeader()

Method Details

lowercaseName

public String lowercaseName()

Description copied from class: HttpHeader

Returns the lower-cased name of the header.

Specified by:

lowercaseName in class HttpHeader

render

public final <R extends Rendering> Rendering render(R r)