Package io.kroxylicious.proxy.model

Class VirtualClusterModel.VirtualClusterGatewayModel

java.lang.Object

io.kroxylicious.proxy.model.VirtualClusterModel.VirtualClusterGatewayModel

All Implemented Interfaces:

EndpointGateway

Enclosing class:

VirtualClusterModel

public static class VirtualClusterModel.VirtualClusterGatewayModel
extends Object
implements EndpointGateway

Method Summary

Modifier and Type	Method	Description
Map<Integer,HostPort>	discoveryAddressMap()	Map of node ids to broker addresses.
HostPort	getAdvertisedBrokerAddress(int nodeId)	Advertised address of broker with the given node id, (advertised hostname and advertised port).
Optional<String>	getBindAddress()	Bind address to be used for network binds.
HostPort	getBrokerAddress(int nodeId)	Broker address for given nodeId.
Integer	getBrokerIdFromBrokerAddress(HostPort brokerAddress)	Generates the node id implied by the given broker address (advertised hostname and bind port).
HostPort	getClusterBootstrapAddress()	Bootstrap address.
Optional<io.netty.handler.ssl.SslContext>	getDownstreamSslContext()
Set<Integer>	getExclusivePorts()
Set<Integer>	getSharedPorts()
Optional<io.kroxylicious.proxy.config.tls.Tls>	getTls()
boolean	isUseTls()	true if this listener uses TLS.
String	name()	Get the gateways name
boolean	requiresServerNameIndication()	Indicates if the provider requires that connections utilise the Server Name Indication (SNI) extension to TLS.
String	toString()
VirtualClusterModel	virtualCluster()

Methods inherited from class java.lang.Object

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

Method Details

virtualCluster

public VirtualClusterModel virtualCluster()

Specified by:

virtualCluster in interface EndpointGateway

getClusterBootstrapAddress

public HostPort getClusterBootstrapAddress()

Description copied from interface: EndpointGateway

Bootstrap address.

Specified by:

getClusterBootstrapAddress in interface EndpointGateway

Returns:

bootstrap address.

getBrokerAddress

public HostPort getBrokerAddress(int nodeId)
                          throws IllegalArgumentException

Description copied from interface: EndpointGateway

Broker address for given nodeId.

Specified by:

getBrokerAddress in interface EndpointGateway

Parameters:

nodeId - node id

Returns:

broker address

Throws:

IllegalArgumentException - address for given broker node cannot be generated.

getBindAddress

public Optional<String> getBindAddress()

Description copied from interface: EndpointGateway

Bind address to be used for network binds.

Specified by:

getBindAddress in interface EndpointGateway

Returns:

bind address

requiresServerNameIndication

public boolean requiresServerNameIndication()

Description copied from interface: EndpointGateway

Indicates if the provider requires that connections utilise the Server Name Indication (SNI) extension to TLS. If this is true, then the provider cannot support plain connections.

Specified by:

requiresServerNameIndication in interface EndpointGateway

Returns:

true if this provider requires Server Name Indication (SNI).

getExclusivePorts

public Set<Integer> getExclusivePorts()

Specified by:

getExclusivePorts in interface EndpointGateway

getSharedPorts

public Set<Integer> getSharedPorts()

Specified by:

getSharedPorts in interface EndpointGateway

discoveryAddressMap

public Map<Integer,HostPort> discoveryAddressMap()

Description copied from interface: EndpointGateway

Map of node ids to broker addresses.

Specified by:

discoveryAddressMap in interface EndpointGateway

Returns:

map of addresses

getBrokerIdFromBrokerAddress

@Nullable
public Integer getBrokerIdFromBrokerAddress(HostPort brokerAddress)

Description copied from interface: EndpointGateway

Generates the node id implied by the given broker address (advertised hostname and bind port). This method make sense only for implementation that embed node id information into the broker address. This information is used at startup time to allow a client that already in possession of a broker address to reconnect to the cluster via Kroxylicious using only that address.
This is an optional method. An implementation can return null.

Specified by:

getBrokerIdFromBrokerAddress in interface EndpointGateway

Parameters:

brokerAddress - broker address

Returns:

broker id

name

public String name()

Description copied from interface: EndpointGateway

Get the gateways name

Specified by:

name in interface EndpointGateway

Returns:

name

getAdvertisedBrokerAddress

public HostPort getAdvertisedBrokerAddress(int nodeId)

Description copied from interface: EndpointGateway

Advertised address of broker with the given node id, (advertised hostname and advertised port). This is what is returned to clients and may differ from the node's bind port as presented by EndpointGateway.getBrokerAddress(int). This enables Kroxylicious to sit behind yet another proxy that uses a different port from the kroxylicious bind port.

Specified by:

getAdvertisedBrokerAddress in interface EndpointGateway

Parameters:

nodeId - node id

Returns:

the broker's advertised address

isUseTls

public boolean isUseTls()

Description copied from interface: EndpointGateway

true if this listener uses TLS.

Specified by:

isUseTls in interface EndpointGateway

Returns:

true if listener uses TLS.

getDownstreamSslContext

public Optional<io.netty.handler.ssl.SslContext> getDownstreamSslContext()

Specified by:

getDownstreamSslContext in interface EndpointGateway

getTls

public Optional<io.kroxylicious.proxy.config.tls.Tls> getTls()

toString

public String toString()

Overrides:

toString in class Object