Record Class RemoteIp

java.lang.Object

java.lang.Record

org.springframework.boot.tomcat.RemoteIp

Record Components:

header - settings for the header or null to keep defaults

proxies - setting for the proxies or null to keep defaults

usage - when the configuration should be used

public record RemoteIp(@Nullable RemoteIp.Header header, @Nullable RemoteIp.Proxies proxies, RemoteIp.Usage usage)
extends Record

Settings for Tomcat's remote IPs.

Since:

4.2.0

Author:

Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RemoteIp.Header	Remote IP header settings.
static final record	RemoteIp.Proxies	Remote IP proxy settings.
static enum	RemoteIp.Usage

Field Summary

Fields

Modifier and Type	Field	Description
static final RemoteIp	DEFAULTS	Use RemoteIpValve defaults.

Constructor Summary

Constructors

Constructor	Description
RemoteIp(@Nullable RemoteIp.Header header, @Nullable RemoteIp.Proxies proxies)
RemoteIp(@Nullable RemoteIp.Header header, @Nullable RemoteIp.Proxies proxies, RemoteIp.Usage usage)	Creates an instance of a RemoteIp record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable RemoteIp.Header	header()	Returns the value of the header record component.
@Nullable RemoteIp.Proxies	proxies()	Returns the value of the proxies record component.
final String	toString()	Returns a string representation of this record class.
RemoteIp.Usage	usage()	Returns the value of the usage record component.

Methods inherited from class Object

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

Field Details

DEFAULTS

public static final RemoteIp DEFAULTS

Use RemoteIpValve defaults.

Constructor Details

RemoteIp

public RemoteIp(@Nullable RemoteIp.Header header,
 @Nullable RemoteIp.Proxies proxies,
 RemoteIp.Usage usage)

Creates an instance of a RemoteIp record class.

Parameters:

header - the value for the header record component

proxies - the value for the proxies record component

usage - the value for the usage record component

RemoteIp

public RemoteIp(@Nullable RemoteIp.Header header,
 @Nullable RemoteIp.Proxies proxies)

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

header

public @Nullable RemoteIp.Header header()

Returns the value of the header record component.

Returns:

the value of the header record component

proxies

public @Nullable RemoteIp.Proxies proxies()

Returns the value of the proxies record component.

Returns:

the value of the proxies record component

usage

public RemoteIp.Usage usage()

Returns the value of the usage record component.

Returns:

the value of the usage record component