Package io.kroxylicious.proxy.model

Class VirtualClusterModel

java.lang.Object

io.kroxylicious.proxy.model.VirtualClusterModel

All Implemented Interfaces:

AutoCloseable

public class VirtualClusterModel
extends Object
implements AutoCloseable

Runtime representation of a virtual cluster: its name, target Kafka cluster, gateways, TLS configuration, and the components whose lifecycle is bound to this VC.

Owned resources

The VCM owns and is responsible for closing two per-VC components directly:

• FilterChainFactory — the filter chain factory for this VC. Each VCM has its own FCF.
• TlsCredentialSupplierManager — the TLS credential supplier for this VC.

For VCs that use dynamic routing, the DynamicRouting instance carries and owns the RouterChainFactory; the VCM closes it via the routing model.

Lifecycle

The VCM is created when the VC is configured (or reconfigured via hot-reload), and closed via close() when the VC's lifecycle reaches Stopped. The VirtualClusterRegistry drives the close.

close() is idempotent: the underlying components guard against double-close, so accidental redundant close calls are safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VirtualClusterModel.VirtualClusterGatewayModel

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_SOCKET_FRAME_MAX_SIZE_BYTES

Constructor Summary

Constructors

Constructor	Description
VirtualClusterModel(String clusterName, TargetCluster targetCluster, boolean logNetwork, boolean logFrames, List<NamedFilterDefinition> filters)
VirtualClusterModel(String clusterName, RoutingModel routing, boolean logNetwork, boolean logFrames, List<NamedFilterDefinition> filters, CacheConfiguration topicNameCacheConfig, TransportSubjectBuilderConfig transportSubjectBuilderConfig, Duration drainTimeout, PluginFactoryRegistry pluginFactoryRegistry)

Method Summary

Modifier and Type	Method	Description
void	addGateway(String name, NodeIdentificationStrategy nodeIdentificationStrategy, Optional<io.kroxylicious.proxy.config.tls.Tls> tls)
void	close()	Closes resources associated with this virtual cluster — the TLS credential supplier manager(s) held by the routing model and the FilterChainFactory.
static void	configureCipherSuites(io.netty.handler.ssl.SslContextBuilder sslContextBuilder, io.kroxylicious.proxy.config.tls.Tls tlsConfiguration)
static void	configureEnabledProtocols(io.netty.handler.ssl.SslContextBuilder sslContextBuilder, io.kroxylicious.proxy.config.tls.Tls tlsConfiguration)
static NettyTrustProvider	configureTrustProvider(io.kroxylicious.proxy.config.tls.Tls tlsConfiguration)
io.kroxylicious.proxy.router.Router	createRouter()
Duration	drainTimeout()
FilterChainFactory	filterChainFactory()	Returns this VC's filter chain factory.
Map<String,EndpointGateway>	gateways()
String	getClusterName()
List<NamedFilterDefinition>	getFilters()
TopicNameCacheFilter	getTopicNameCacheFilter()
UpstreamClusterModel	getUpstreamClusterForRoute(String routeName)	Returns the UpstreamClusterModel for a specific route, or null if the route does not target an upstream cluster (e.g. it targets a nested router).
boolean	isLogFrames()
boolean	isLogNetwork()
void	logVirtualClusterSummary()
RoutingModel	routing()
int	socketFrameMaxSizeBytes()
io.kroxylicious.proxy.authentication.TransportSubjectBuilder	subjectBuilder(PluginFactoryRegistry pfr)
String	toString()
boolean	usesDynamicTlsCredentials()	Checks if this virtual cluster uses dynamic TLS credential supplier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_SOCKET_FRAME_MAX_SIZE_BYTES

public static final int DEFAULT_SOCKET_FRAME_MAX_SIZE_BYTES

See Also:

• Constant Field Values

Constructor Details

VirtualClusterModel

@VisibleForTesting
public VirtualClusterModel(String clusterName,
 TargetCluster targetCluster,
 boolean logNetwork,
 boolean logFrames,
 List<NamedFilterDefinition> filters)

VirtualClusterModel

public VirtualClusterModel(String clusterName,
 RoutingModel routing,
 boolean logNetwork,
 boolean logFrames,
 List<NamedFilterDefinition> filters,
 CacheConfiguration topicNameCacheConfig,
 @Nullable
 TransportSubjectBuilderConfig transportSubjectBuilderConfig,
 Duration drainTimeout,
 @Nullable
 PluginFactoryRegistry pluginFactoryRegistry)

Method Details

filterChainFactory

public FilterChainFactory filterChainFactory()

Returns this VC's filter chain factory. The returned factory is alive for the lifetime of this VCM; closing the VCM (via close(), driven by VirtualClusterRegistry on transition into Stopped) also closes the FCF. Callers should not retain the reference past the VC's lifetime.

createRouter

public io.kroxylicious.proxy.router.Router createRouter()

drainTimeout

public Duration drainTimeout()

routing

public RoutingModel routing()

logVirtualClusterSummary

public void logVirtualClusterSummary()

addGateway

public void addGateway(String name,
 NodeIdentificationStrategy nodeIdentificationStrategy,
 Optional<io.kroxylicious.proxy.config.tls.Tls> tls)

getClusterName

public String getClusterName()

isLogNetwork

public boolean isLogNetwork()

isLogFrames

public boolean isLogFrames()

socketFrameMaxSizeBytes

public int socketFrameMaxSizeBytes()

toString

public String toString()

Overrides:

toString in class Object

getUpstreamClusterForRoute

@Nullable
public UpstreamClusterModel getUpstreamClusterForRoute(String routeName)

Returns the UpstreamClusterModel for a specific route, or null if the route does not target an upstream cluster (e.g. it targets a nested router).

close

public void close()

Closes resources associated with this virtual cluster — the TLS credential supplier manager(s) held by the routing model and the FilterChainFactory. Called by VirtualClusterRegistry on lifecycle transition into Stopped. Safe to call multiple times — the FCF's underlying Wrapper.close is idempotent via an internal AtomicBoolean, and TlsCredentialSupplierManager.close tolerates re-entry.

Specified by:

close in interface AutoCloseable

usesDynamicTlsCredentials

public boolean usesDynamicTlsCredentials()

Checks if this virtual cluster uses dynamic TLS credential supplier.

Returns:

true if a credential supplier is configured

configureTrustProvider

public static NettyTrustProvider configureTrustProvider(io.kroxylicious.proxy.config.tls.Tls tlsConfiguration)

configureCipherSuites

public static void configureCipherSuites(io.netty.handler.ssl.SslContextBuilder sslContextBuilder,
 io.kroxylicious.proxy.config.tls.Tls tlsConfiguration)

configureEnabledProtocols

public static void configureEnabledProtocols(io.netty.handler.ssl.SslContextBuilder sslContextBuilder,
 io.kroxylicious.proxy.config.tls.Tls tlsConfiguration)

getFilters

public List<NamedFilterDefinition> getFilters()

gateways

public Map<String,EndpointGateway> gateways()

subjectBuilder

public io.kroxylicious.proxy.authentication.TransportSubjectBuilder subjectBuilder(PluginFactoryRegistry pfr)

getTopicNameCacheFilter

public TopicNameCacheFilter getTopicNameCacheFilter()