Package io.kroxylicious.proxy.config

Record Class Configuration

java.lang.Object

java.lang.Record

io.kroxylicious.proxy.config.Configuration

Record Components:

management - management configuration

clusterDefinitions - Named target cluster definitions, referenced by virtual clusters and routes.

filterDefinitions - A list of named filter definitions (names must be unique)

defaultFilters - The names of the filterDefinitions() to be use when a VirtualCluster doesn't specify its own VirtualCluster.filters().

routerDefinitions - Named router definitions.

virtualClusters - The virtual clusters

micrometer - The micrometer config

useIoUring - true to use iouring

development - Development options

network - Controls aspects of network configuration for the proxy.

proxyProtocol - PROXY protocol configuration.

public record Configuration(ManagementConfiguration management, List<ClusterDefinition> clusterDefinitions, List<NamedFilterDefinition> filterDefinitions, List<String> defaultFilters, List<RouterDefinition> routerDefinitions, List<VirtualCluster> virtualClusters, List<MicrometerDefinition> micrometer, boolean useIoUring, Optional<Map<String,Object>> development, NetworkDefinition network, ProxyProtocolConfig proxyProtocol)
extends Record

The root of the proxy configuration.

Constructor Summary

Constructors

Constructor

Description

Configuration(ManagementConfiguration management, List<ClusterDefinition> clusterDefinitions, List<NamedFilterDefinition> filterDefinitions, List<String> defaultFilters, List<RouterDefinition> routerDefinitions, List<VirtualCluster> virtualClusters, List<MicrometerDefinition> micrometer, boolean useIoUring, Optional<Map<String,Object>> development, NetworkDefinition network, ProxyProtocolConfig proxyProtocol)

Creates an instance of configuration.

Method Summary

Modifier and Type	Method	Description
List<ClusterDefinition>	clusterDefinitions()	Returns the value of the clusterDefinitions record component.
List<String>	defaultFilters()	Returns the value of the defaultFilters record component.
Optional<Map<String,Object>>	development()	Returns the value of the development record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<NamedFilterDefinition>	filterDefinitions()	Returns the value of the filterDefinitions record component.
List<MicrometerDefinition>	getMicrometer()
final int	hashCode()	Returns a hash code value for this object.
boolean	isUseIoUring()
ManagementConfiguration	management()	Returns the value of the management record component.
List<MicrometerDefinition>	micrometer()	Returns the value of the micrometer record component.
NetworkDefinition	network()	Returns the value of the network record component.
ProxyProtocolConfig	proxyProtocol()	Returns the value of the proxyProtocol record component.
ProxyProtocolMode	proxyProtocolMode()
List<RouterDefinition>	routerDefinitions()	Returns the value of the routerDefinitions record component.
final String	toString()	Returns a string representation of this record class.
boolean	useIoUring()	Returns the value of the useIoUring record component.
List<VirtualClusterModel>	virtualClusterModel(PluginFactoryRegistry pfr)
VirtualClusterModel	virtualClusterModel(PluginFactoryRegistry pfr, String clusterName)	Builds the VirtualClusterModel for a single virtual cluster by name.
List<VirtualCluster>	virtualClusters()	Returns the value of the virtualClusters record component.

Methods inherited from class java.lang.Object

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

Constructor Details

Configuration

public Configuration(@Nullable
 ManagementConfiguration management,
 @Nullable
 List<ClusterDefinition> clusterDefinitions,
 @Nullable
 List<NamedFilterDefinition> filterDefinitions,
 @Nullable
 List<String> defaultFilters,
 @Nullable
 List<RouterDefinition> routerDefinitions,
 List<VirtualCluster> virtualClusters,
 @Nullable
 List<MicrometerDefinition> micrometer,
 boolean useIoUring,
 Optional<Map<String,Object>> development,
 @Nullable
 NetworkDefinition network,
 @Nullable
 ProxyProtocolConfig proxyProtocol)

Creates an instance of configuration.

Method Details

getMicrometer

public List<MicrometerDefinition> getMicrometer()

isUseIoUring

public boolean isUseIoUring()

proxyProtocolMode

public ProxyProtocolMode proxyProtocolMode()

virtualClusterModel

public List<VirtualClusterModel> virtualClusterModel(PluginFactoryRegistry pfr)

virtualClusterModel

public VirtualClusterModel virtualClusterModel(PluginFactoryRegistry pfr,
 String clusterName)

Builds the VirtualClusterModel for a single virtual cluster by name. Unlike virtualClusterModel(PluginFactoryRegistry), this avoids constructing models (and therefore avoids running each filter's initialize()) for any virtual cluster other than the one requested. Used by OperationsPlanner so a reconfigure that targets one cluster doesn't orphan-initialise the filters of unrelated clusters.

Throws:

IllegalArgumentException - if no virtual cluster with that name exists in this configuration

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

management

@Nullable
public ManagementConfiguration management()

Returns the value of the management record component.

Returns:

the value of the management record component

clusterDefinitions

@Nullable
public List<ClusterDefinition> clusterDefinitions()

Returns the value of the clusterDefinitions record component.

Returns:

the value of the clusterDefinitions record component

filterDefinitions

@Nullable
public List<NamedFilterDefinition> filterDefinitions()

Returns the value of the filterDefinitions record component.

Returns:

the value of the filterDefinitions record component

defaultFilters

@Nullable
public List<String> defaultFilters()

Returns the value of the defaultFilters record component.

Returns:

the value of the defaultFilters record component

routerDefinitions

@Nullable
public List<RouterDefinition> routerDefinitions()

Returns the value of the routerDefinitions record component.

Returns:

the value of the routerDefinitions record component

virtualClusters

public List<VirtualCluster> virtualClusters()

Returns the value of the virtualClusters record component.

Returns:

the value of the virtualClusters record component

micrometer

@Nullable
public List<MicrometerDefinition> micrometer()

Returns the value of the micrometer record component.

Returns:

the value of the micrometer record component

useIoUring

public boolean useIoUring()

Returns the value of the useIoUring record component.

Returns:

the value of the useIoUring record component

development

public Optional<Map<String,Object>> development()

Returns the value of the development record component.

Returns:

the value of the development record component

network

@Nullable
public NetworkDefinition network()

Returns the value of the network record component.

Returns:

the value of the network record component

proxyProtocol

@Nullable
public ProxyProtocolConfig proxyProtocol()

Returns the value of the proxyProtocol record component.

Returns:

the value of the proxyProtocol record component