ClientIPLookupSpec

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)

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new ClientIPLookupSpec(headerName: String, requiredHeaderAndValue: Option[(String, String)], valueToUse: ClientIPHeaderValueToUse)

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val headerName: String

The header name to grab the client ip from (e.g.
The header name to grab the client ip from (e.g. X-Forwarded-For)
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
val requiredHeaderAndValue: Option[(String, String)]

An optional header/value pair that must exist in order to look at the headerName
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val valueToUse: ClientIPHeaderValueToUse

Which value to use when there are multiple values (e.g.
Which value to use when there are multiple values (e.g. X-Forward-For: 1.2.3.4,4.5.6.7)
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 Doc: package HttpServerOptions

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

Instance Constructors

new ClientIPLookupSpec(headerName: String, requiredHeaderAndValue: Option[(String, String)], valueToUse: ClientIPHeaderValueToUse)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val headerName: String

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val requiredHeaderAndValue: Option[(String, String)]

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

val valueToUse: ClientIPHeaderValueToUse

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 Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped