Package com.tccc.kos.core.service.device.serialnum.run

Class RunKosSerialNumberProvider

java.lang.Object

com.tccc.kos.core.service.device.serialnum.run.RunKosSerialNumberProvider

All Implemented Interfaces:

Ready, SerialNumberProvider

public class RunKosSerialNumberProvider
extends Object
implements SerialNumberProvider

A SerialNumberProvider implementation that reads the serial number from /run/kos/serialNumber in the constructor. If this file does not exist, the provider will never become ready.

This provider does not allow the serial number to be set. Calling setSerialNumber() will throw UnsupportedOperationException.

This provider is typically used when the serial number is programmed into an external device, such as an eprom that is part of the cable harness or chassis. This value is typically read by code in a layer and written to the /run/kos/serialNumber file before java starts.

Version:

2024-10-29

Constructor Summary

Constructors

Constructor	Description
RunKosSerialNumberProvider()

Method Summary

Modifier and Type	Method	Description
ReadyIndicator	getReady()	Fetches the associated ready indicator.
String	getSerialNumber()	Return the serial number of the device.
void	setSerialNumber(String serialNumber)	Set the serial number of the device.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tccc.kos.commons.util.ready.Ready

isReady, setReady

Constructor Details

RunKosSerialNumberProvider

public RunKosSerialNumberProvider()

Method Details

setSerialNumber

public void setSerialNumber(String serialNumber)
                     throws Exception

Description copied from interface: SerialNumberProvider

Set the serial number of the device.

Specified by:

setSerialNumber in interface SerialNumberProvider

Parameters:

serialNumber - the new device serial number

Throws:

Exception

getReady

public ReadyIndicator getReady()

Description copied from interface: Ready

Fetches the associated ready indicator.

Specified by:

getReady in interface Ready

Returns:

the associated ReadyIndicator object

getSerialNumber

public String getSerialNumber()

Description copied from interface: SerialNumberProvider

Return the serial number of the device.

Specified by:

getSerialNumber in interface SerialNumberProvider