Class HardwareIdService
java.lang.Object
io.github.eggy03.ferrumx.windows.service.compounded.HardwareIdService
- All Implemented Interfaces:
OptionalCommonServiceInterface<HardwareId>
Service class for fetching the HWID information from a system running Windows.
This class executes the ScriptEnum.HWID PowerShell script
and maps the resulting JSON into an Optional HardwareId object.
Usage examples
// Convenience API (creates its own short-lived session)
HardwareIdService service = new HardwareIdService();
Optional<HardwareId> hwid = service.get();
// API with re-usable session (caller manages session lifecycle)
try (PowerShell session = PowerShell.openSession()) {
HardwareIdService service = new HardwareIdService();
Optional<HardwareId> hwid = service.get(session);
}
// API with execution timeout (auto-created session is terminated if the timeout is exceeded)
HardwareIdService service = new HardwareIdService();
Optional<HardwareId> hwid = service.get(10);
Execution models and concurrency
This service supports multiple PowerShell execution strategies:
-
jPowerShell-based execution via
get()andget(PowerShell):
These methods rely onjPowerShellsessions. Due to internal global configuration ofjPowerShell, the PowerShell sessions launched by it is not safe to use concurrently across multiple threads or executors. Running these methods in parallel may result in runtime exceptions. -
Isolated PowerShell execution via
get(long timeout):
This method doesn't rely onjPowerShelland instead, launches a standalone PowerShell process per invocation usingTerminalUtility. Each call is fully isolated and safe to use in multithreaded and executor-based environments.
For concurrent or executor-based workloads, prefer get(long timeout).
- Since:
- 3.0.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription@NotNull Optional<HardwareId> get()Retrieves anOptionalcontaining the HWID information.@NotNull Optional<HardwareId> get(long timeout) Retrieves anOptionalcontaining the HWID information using an isolated PowerShell process with a configurable timeout.@NotNull Optional<HardwareId> get(@NonNull com.profesorfalken.jpowershell.PowerShell powerShell) Retrieves anOptionalcontaining the HWID information using the caller'sPowerShellsession.
-
Constructor Details
-
HardwareIdService
public HardwareIdService()
-
-
Method Details
-
get
Retrieves anOptionalcontaining the HWID information.Each invocation creates and uses a short-lived PowerShell session internally.
- Specified by:
getin interfaceOptionalCommonServiceInterface<HardwareId>- Returns:
- an
OptionalofHardwareIdrepresenting the HWID. ReturnsOptional.empty()if no information is detected. - Since:
- 3.0.0
-
get
@UsesJPowerShell @NotNull public @NotNull Optional<HardwareId> get(@NonNull @NonNull com.profesorfalken.jpowershell.PowerShell powerShell) Retrieves anOptionalcontaining the HWID information using the caller'sPowerShellsession.- Specified by:
getin interfaceOptionalCommonServiceInterface<HardwareId>- Parameters:
powerShell- an existing PowerShell session managed by the caller- Returns:
- an
OptionalofHardwareIdrepresenting the HWID. ReturnsOptional.empty()if no information is detected. - Since:
- 3.0.0
-
get
Retrieves anOptionalcontaining the HWID information using an isolated PowerShell process with a configurable timeout.Each invocation creates an isolated PowerShell process, which is pre-maturely terminated if execution exceeds the specified timeout.
- Specified by:
getin interfaceOptionalCommonServiceInterface<HardwareId>- Parameters:
timeout- the maximum time (in seconds) to wait for the PowerShell command to complete before terminating the process- Returns:
- an
OptionalofHardwareIdrepresenting the HWID. ReturnsOptional.empty()if no information is detected. - Since:
- 3.1.0
-