HttpServerOptions

Type Members

sealed trait ClientIPHeaderValueToUse extends AnyRef
final case class ClientIPLookupSpec(headerName: String, requiredHeaderAndValue: Option[(String, String)], valueToUse: ClientIPHeaderValueToUse) extends Product with Serializable

This allows you to override the Request.remoteIp with an IP Address from an HTTP header field
This allows you to override the Request.remoteIp with an IP Address from an HTTP header field
Example:
```
ClientIPLookupSpec(
  headerName = "X-Client-IP",
  requiredHeaderAndValue = Some(("X-Is-From-CDN", "secret value set by the CDN/Proxy"))
  valueIdx = ClientIPHeaderValueToUse.Last
)
```
In this case if a request comes in with an "X-Client-IP" value but no "X-Is-From-CDN" header value then the "X-Client-IP" will not be used. If the "X-Client-IP" header does exist and is set to whatever we configured then the "X-Client-IP" will be used.
headerName
The header name to grab the client ip from (e.g. X-Forwarded-For)
requiredHeaderAndValue
An optional header/value pair that must exist in order to look at the headerName
valueToUse
Which value to use when there are multiple values (e.g. X-Forward-For: 1.2.3.4,4.5.6.7)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object ClientIPHeaderValueToUse
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val default: HttpServerOptions
val defaultClientIPLookupSpec: ClientIPLookupSpec

This is the original default behavior of using the last value of the "X-Forwarded-For" header
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: class HttpServerOptions | package server

object HttpServerOptions extends Serializable

Type Members

sealed trait ClientIPHeaderValueToUse extends AnyRef

final case class ClientIPLookupSpec(headerName: String, requiredHeaderAndValue: Option[(String, String)], valueToUse: ClientIPHeaderValueToUse) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object ClientIPHeaderValueToUse

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val default: HttpServerOptions

val defaultClientIPLookupSpec: ClientIPLookupSpec

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped