Package com.linecorp.armeria.server

Class ClientAddressSource

java.lang.Object

com.linecorp.armeria.server.ClientAddressSource

public final class ClientAddressSource
extends Object

A source which is used to get a client address. Currently there are two sources which are available to provide a client address:

• an HTTP header, such as Forwarded and X-Forwarded-For header
• the source address specified in a PROXY protocol message

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
int	hashCode()
static ClientAddressSource	ofHeader(CharSequence header)	Returns a ClientAddressSource which indicates the value of the specified header in a request will be used to determine a client address.
static ClientAddressSource	ofProxyProtocol()	Returns the ClientAddressSource which indicates the source address specified in a PROXY protocol message will be used to determine a client address.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

ofHeader

public static ClientAddressSource ofHeader(CharSequence header)

Returns a ClientAddressSource which indicates the value of the specified header in a request will be used to determine a client address.

ofProxyProtocol

public static ClientAddressSource ofProxyProtocol()

Returns the ClientAddressSource which indicates the source address specified in a PROXY protocol message will be used to determine a client address.

equals

public boolean equals(@Nullable
 @Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object