Package me.ahoo.cosid.spring.boot.starter.machine

Class CosIdMachineAutoConfiguration

java.lang.Object

me.ahoo.cosid.spring.boot.starter.machine.CosIdMachineAutoConfiguration

@AutoConfiguration
@EnableConfigurationProperties(MachineProperties.class)
public class CosIdMachineAutoConfiguration
extends Object

Auto-configuration for CosId machine ID management components.

This configuration class sets up the complete machine ID ecosystem including:

• Instance identification and machine ID distribution
• Machine state storage and persistence
• Clock synchronization and backwards handling
• Machine ID guarding and health monitoring
• Lifecycle management for startup/shutdown

The configuration supports multiple distribution strategies:

• Manual: Fixed machine ID assignment
• StatefulSet: Kubernetes StatefulSet-based distribution
• JDBC: Database-backed distribution
• Redis: Redis-backed distribution
• Zookeeper: Zookeeper-backed distribution
• Proxy: Remote proxy server distribution
• MongoDB: MongoDB-backed distribution

Example configuration:

 cosid:
   machine:
     enabled: true
     distributor:
       type: manual
       manual:
         machine-id: 1
 

Constructor Summary

Constructors

Constructor	Description
CosIdMachineAutoConfiguration(CosIdProperties cosIdProperties, MachineProperties machineProperties)	Constructs a new machine auto-configuration with the provided properties.

Method Summary

Modifier and Type	Method	Description
ClockBackwardsSynchronizer	clockBackwardsSynchronizer()
CosIdMachineIdLifecycle	cosIdMachineIdLifecycle(MachineIdGuarder machineIdGuarder, MachineIdDistributor machineIdDistributor, GuardDistribute guardDistribute)
BuiltInStoreProvider	cosIdManualMachineStoreProvider()	The manual backend for CosIdStoreProvider selection.
BuiltInStoreProvider	cosIdStatefulSetMachineStoreProvider()	The Kubernetes StatefulSet backend for CosIdStoreProvider selection.
GuardDistribute	guardDistribute(MachineIdDistributor machineIdDistributor, MachineIdGuarder machineIdGuarder)
InstanceId	instanceId(HostAddressSupplier hostAddressSupplier)	Creates the instance identifier for this application instance.
MachineId	machineId(GuardDistribute guardDistribute, InstanceId instanceId)	Creates the machine ID for this instance.
ManualMachineIdDistributor	machineIdDistributor(MachineStateStorage localMachineState, ClockBackwardsSynchronizer clockBackwardsSynchronizer)
MachineIdGuarder	machineIdGuarder(MachineIdDistributor machineIdDistributor)	Creates the machine ID guarder for monitoring machine ID conflicts.
MachineStateStorage	machineStateStorage()
StatefulSetMachineIdDistributor	statefulSetMachineIdDistributor(MachineStateStorage localMachineState, ClockBackwardsSynchronizer clockBackwardsSynchronizer)

Methods inherited from class java.lang.Object

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

Constructor Details

CosIdMachineAutoConfiguration

public CosIdMachineAutoConfiguration(CosIdProperties cosIdProperties,
 MachineProperties machineProperties)

Constructs a new machine auto-configuration with the provided properties.

Parameters:

cosIdProperties - the main CosId configuration properties

machineProperties - the machine-specific configuration properties

Method Details

instanceId

@Bean
@ConditionalOnMissingBean
public InstanceId instanceId(HostAddressSupplier hostAddressSupplier)

Creates the instance identifier for this application instance.

The instance ID uniquely identifies this application instance within the distributed system. It can be explicitly configured or automatically generated from the host address and process ID.

The stability flag indicates whether this instance has a stable network identity that persists across restarts.

Parameters:

hostAddressSupplier - supplier for the host address

Returns:

the instance identifier

machineId

@Bean
@ConditionalOnMissingBean(MachineId.class)
public MachineId machineId(GuardDistribute guardDistribute,
 InstanceId instanceId)

Creates the machine ID for this instance.

The machine ID is a unique identifier assigned to this instance within the distributed system. It's distributed by the configured distributor and used as part of snowflake ID generation.

Parameters:

guardDistribute - the distributor responsible for assigning machine IDs

instanceId - the instance identifier

Returns:

the assigned machine ID

machineStateStorage

@Bean
@ConditionalOnMissingBean
public MachineStateStorage machineStateStorage()

clockBackwardsSynchronizer

@Bean
@ConditionalOnMissingBean
public ClockBackwardsSynchronizer clockBackwardsSynchronizer()

machineIdDistributor

@Bean
@ConditionalOnMissingBean(MachineIdDistributor.class)
@ConditionalOnMachineStoreType("manual")
@ConditionalOnBuiltInMachineStore
public ManualMachineIdDistributor machineIdDistributor(MachineStateStorage localMachineState,
 ClockBackwardsSynchronizer clockBackwardsSynchronizer)

cosIdManualMachineStoreProvider

@Bean
public BuiltInStoreProvider cosIdManualMachineStoreProvider()

The manual backend for CosIdStoreProvider selection.

statefulSetMachineIdDistributor

@Bean
@ConditionalOnMissingBean(MachineIdDistributor.class)
@ConditionalOnMachineStoreType("stateful_set")
@ConditionalOnBuiltInMachineStore
public StatefulSetMachineIdDistributor statefulSetMachineIdDistributor(MachineStateStorage localMachineState,
 ClockBackwardsSynchronizer clockBackwardsSynchronizer)

cosIdStatefulSetMachineStoreProvider

@Bean
public BuiltInStoreProvider cosIdStatefulSetMachineStoreProvider()

The Kubernetes StatefulSet backend for CosIdStoreProvider selection.

machineIdGuarder

@Bean
@ConditionalOnMissingBean
public MachineIdGuarder machineIdGuarder(MachineIdDistributor machineIdDistributor)

Creates the machine ID guarder for monitoring machine ID conflicts.

The guarder periodically checks for machine ID conflicts and maintains the health status of machine ID distribution. If guarding is disabled, returns a no-operation guarder.

Parameters:

machineIdDistributor - the machine ID distributor to guard

Returns:

the machine ID guarder instance

guardDistribute

@Bean
@ConditionalOnMissingBean
public GuardDistribute guardDistribute(MachineIdDistributor machineIdDistributor,
 MachineIdGuarder machineIdGuarder)

cosIdMachineIdLifecycle

@Bean
@ConditionalOnMissingBean
public CosIdMachineIdLifecycle cosIdMachineIdLifecycle(MachineIdGuarder machineIdGuarder,
 MachineIdDistributor machineIdDistributor,
 GuardDistribute guardDistribute)