Class TLSBabelChannelBuilder

java.lang.Object

pt.unl.fct.di.novasys.babel2.channels.AbstractBabelChannelBuilder<TLSBabelChannelBuilder>

pt.unl.fct.di.novasys.babel2.channels.AbstractIPBabelChannelBuilder<TLSBabelChannelBuilder>

pt.unl.fct.di.novasys.babel2.channels.tcp_tls.TLSBabelChannelBuilder

All Implemented Interfaces:

BabelChannelBuilder

public class TLSBabelChannelBuilder
extends AbstractIPBabelChannelBuilder<TLSBabelChannelBuilder>

Builder for TLSBabelChannel instances.

Configures TLS channel parameters such as the local binding address, event loop group, connection capacity, maximum buffered messages, trust manager factory, key material, tie-breaking comparator, authentication mode, handshake identity verification, and permitted peer nodes prior to channel creation.

Example usage:

TLSBabelChannelBuilder builder = TLSBabelChannel.builder()
        .setBindingAddress(new InetSocketAddress("0.0.0.0", 7000))
        .setNumberOfConnections(100)
        .setAuthMode(TCPBabelChannelAuthMode.MIXED_AUTH)
        .setPermittedNodes(Set.of(allowedPeer1, allowedPeer2))
        .setTrustManagerFactory(new PeerIdentityTrustManagerFactory())
        .verifyIdentity();

When registered with Babel via Babel.builder().registerProtocol(protocol, holderFactory, builder), build(Babel, NodeStore, BabelNode, BabelProtocol) is invoked for each registering protocol. The underlying TLSBabelChannel is created on the first invocation and shared across protocols.

Field Summary

Fields inherited from class AbstractIPBabelChannelBuilder

DEFAULT_CONNECTION_UP_DELAY, DEFAULT_CONNECTION_UP_DELAY_UNIT

Modifier and Type	Field	Description
static final long	DEFAULT_CONNECTION_UP_DELAY	Default delay in milliseconds before dispatching connection-up notifications.
static final TimeUnit	DEFAULT_CONNECTION_UP_DELAY_UNIT	Default time unit for AbstractIPBabelChannelBuilder.DEFAULT_CONNECTION_UP_DELAY.

Fields inherited from class AbstractBabelChannelBuilder

DEFAULT_NUMBER_OF_CONNECTIONS, DEFAULT_NUMBER_OF_MESSAGES

Modifier and Type	Field	Description
static final int	DEFAULT_NUMBER_OF_CONNECTIONS	Default number of connections to expect when initializing the channel.
static final int	DEFAULT_NUMBER_OF_MESSAGES	Default number of message types expected by this channel.

Constructor Summary

Constructors

Constructor	Description
TLSBabelChannelBuilder()	Constructs a new, unconfigured TLSBabelChannelBuilder.

Method Summary

Modifier and Type	Method	Description
BabelChannel	build(Babel runtime, NodeStore store, BabelNode identity, BabelProtocol protocol)	Creates a new BabelChannel instance, registering it with the given runtime and limiting its interest to the provided message types.
TLSBabelChannelBuilder	setAuthMode(AbstractTCPBabelChannel.TCPBabelChannelAuthMode authMode)	Configures the authentication mode for the channel, controlling which message types (unsigned, signed, or mixed) are permitted.
TLSBabelChannelBuilder	setComparator(Comparator<? extends BabelNode> comparator)	Sets the comparator used for tie-breaking when two nodes connect to each other simultaneously.
TLSBabelChannelBuilder	setKeyMaterial(CertGenerator.KeyMaterial keyMaterial)	Sets pre-generated CertGenerator.KeyMaterial containing the ephemeral private key and certificate.
TLSBabelChannelBuilder	setPermittedNodes(@Nullable Set<? extends BabelNode> permittedNodes)	Sets the set of permitted nodes for the channel.
TLSBabelChannelBuilder	setTrustManager(TrustManager trustManager)	Sets the TrustManager used to validate peer TLS certificates during the TLS handshake.
TLSBabelChannelBuilder	setTrustManagerFactory(TrustManagerFactory trustManager)	Sets the TrustManagerFactory used to validate peer TLS certificates during the TLS handshake.
TLSBabelChannelBuilder	verifyIdentity()	Enables cryptographic handshake identity verification using the local node's private key.

Methods inherited from class AbstractIPBabelChannelBuilder

getBindingAddress, getConnectionUpDelay, getConnectionUpDelayUnit, getEventLoopGroup, setBindingAddress, setConnectionUpDelay, setConnectionUpDelay, setEventLoopGroup

Modifier and Type	Method	Description
protected final InetSocketAddress	getBindingAddress()	Returns the currently configured binding address.
protected final long	getConnectionUpDelay()	Returns the configured connection up delay value.
protected final TimeUnit	getConnectionUpDelayUnit()	Returns the time unit of the connection up delay.
protected final io.netty.channel.EventLoopGroup	getEventLoopGroup()	Returns the configured event loop group, initializing a default one via BabelIpUtils.createLoopGroup() if none has been set.
final TLSBabelChannelBuilder	setBindingAddress(InetSocketAddress bindingAddress)	Sets the local IP socket address to which the channel should bind.
final TLSBabelChannelBuilder	setConnectionUpDelay(long delayMillis)	Sets the delay in milliseconds before notifying the runtime that a connection is fully up.
final TLSBabelChannelBuilder	setConnectionUpDelay(long delay, TimeUnit unit)	Sets the delay and unit before notifying the runtime that a connection is fully up.
final TLSBabelChannelBuilder	setEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)	Configures the Netty EventLoopGroup used for network I/O.

Methods inherited from class AbstractBabelChannelBuilder

getChannel, getNumberOfConnections, getNumberOfMessages, setChannel, setNumberOfConnections, setNumberOfMessages, validateStateOrThrow

Modifier and Type	Method	Description
protected final @Nullable BabelChannel	getChannel()	Returns the channel instance created by this builder, or null if not yet built.
protected final int	getNumberOfConnections()	Gets the expected number of connections set in this builder.
protected final int	getNumberOfMessages()	Gets the expected number of messages set in this builder.
protected final void	setChannel(BabelChannel channel)	Sets the constructed channel instance created by this builder.
final TLSBabelChannelBuilder	setNumberOfConnections(int numberOfConnections)	Sets the default number of connections expected.
final TLSBabelChannelBuilder	setNumberOfMessages(int numberOfMessages)	Sets the expected number of distinct message types handled by this channel.
protected final void	validateStateOrThrow()	Validates that this builder has not yet built its channel instance.

Methods inherited from class Object

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

Constructor Details

TLSBabelChannelBuilder

public TLSBabelChannelBuilder()

Constructs a new, unconfigured TLSBabelChannelBuilder.

Method Details

setTrustManagerFactory

public TLSBabelChannelBuilder setTrustManagerFactory(TrustManagerFactory trustManager)

Sets the TrustManagerFactory used to validate peer TLS certificates during the TLS handshake.

Parameters:

trustManager - the trust manager factory to use

Returns:

this builder instance for method chaining

setTrustManager

public TLSBabelChannelBuilder setTrustManager(TrustManager trustManager)

Sets the TrustManager used to validate peer TLS certificates during the TLS handshake.

If the trust manager is an instance of PeerIdentityTrustManager, it is converted using PeerIdentityTrustManager.toTrustManagerFactory(). Otherwise, it is wrapped in a SimpleTrustManagerFactory.

Parameters:

trustManager - the trust manager to use

Returns:

this builder instance for method chaining

setKeyMaterial

public TLSBabelChannelBuilder setKeyMaterial(CertGenerator.KeyMaterial keyMaterial)

Sets pre-generated CertGenerator.KeyMaterial containing the ephemeral private key and certificate.

Parameters:

keyMaterial - the key material to use

Returns:

this builder instance for method chaining

setComparator

public TLSBabelChannelBuilder setComparator(Comparator<? extends BabelNode> comparator)

Sets the comparator used for tie-breaking when two nodes connect to each other simultaneously.

Defaults to PublicKeyBabelNodeComparator.INSTANCE if not explicitly configured.

Parameters:

comparator - the comparator used to determine connection priority

Returns:

this builder instance for method chaining

verifyIdentity

public TLSBabelChannelBuilder verifyIdentity()

Enables cryptographic handshake identity verification using the local node's private key.

Returns:

this builder instance for method chaining

setAuthMode

public TLSBabelChannelBuilder setAuthMode(AbstractTCPBabelChannel.TCPBabelChannelAuthMode authMode)

Configures the authentication mode for the channel, controlling which message types (unsigned, signed, or mixed) are permitted.

Parameters:

authMode - the desired AbstractTCPBabelChannel.TCPBabelChannelAuthMode

Returns:

this builder instance for method chaining

setPermittedNodes

public TLSBabelChannelBuilder setPermittedNodes(@Nullable Set<? extends BabelNode> permittedNodes)

Sets the set of permitted nodes for the channel.

When configured, incoming handshake connections from nodes not present in this set will be rejected. If null, all nodes are permitted.

Parameters:

permittedNodes - the set of permitted nodes, or null to allow all nodes

Returns:

this builder instance for method chaining

build

public BabelChannel build(Babel runtime,
 NodeStore store,
 BabelNode identity,
 BabelProtocol protocol)

Creates a new BabelChannel instance, registering it with the given runtime and limiting its interest to the provided message types.

Creates the underlying TLSBabelChannel on the first invocation and stores it, returning the existing instance on subsequent calls.

Parameters:

runtime - the owning Babel runtime

store - the NodeStore that will be used by this channel

identity - BabelNode object used to represent this Babel instance to other instances

protocol - the protocol instance associated with this channel

Returns:

a ready-to-use BabelChannel