Class Win32NetworkAdapterSettingService
java.lang.Object
io.github.eggy03.ferrumx.windows.service.network.Win32NetworkAdapterSettingService
- All Implemented Interfaces:
CommonServiceInterface<Win32NetworkAdapterSetting>
public class Win32NetworkAdapterSettingService
extends Object
implements CommonServiceInterface<Win32NetworkAdapterSetting>
Service class for fetching the association between a Network Adapter, and it's Configuration from the system.
This class executes the Cimv2.WIN32_NETWORK_ADAPTER_SETTING PowerShell command
and maps the resulting JSON into an immutable list of Win32NetworkAdapterSetting objects.
Usage examples
// Convenience API (creates its own short-lived session)
Win32NetworkAdapterSettingServiceservice = new Win32NetworkAdapterSettingService();
List<Win32NetworkAdapterSetting> nas = service.get();
// API with re-usable session (caller manages session lifecycle)
try (PowerShell session = PowerShell.openSession()) {
Win32NetworkAdapterSettingServiceservice = new Win32NetworkAdapterSettingService();
List<Win32NetworkAdapterSetting> nas = service.get(session);
}
// API with execution timeout (auto-created session is terminated if the timeout is exceeded)
Win32NetworkAdapterSettingServiceservice = new Win32NetworkAdapterSettingService();
List<Win32NetworkAdapterSetting> nas = 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 @Unmodifiable List<Win32NetworkAdapterSetting> get()Retrieves an immutable list ofWin32NetworkAdapterSettingentities present in the system.@NotNull @Unmodifiable List<Win32NetworkAdapterSetting> get(long timeout) Retrieves an immutable list ofWin32NetworkAdapterSettingentities using an isolated PowerShell process with a configurable timeout.@NotNull @Unmodifiable List<Win32NetworkAdapterSetting> get(@NonNull com.profesorfalken.jpowershell.PowerShell powerShell) Retrieves an immutable list ofWin32NetworkAdapterSettingentities using the caller'sPowerShellsession.
-
Constructor Details
-
Win32NetworkAdapterSettingService
public Win32NetworkAdapterSettingService()
-
-
Method Details
-
get
Retrieves an immutable list ofWin32NetworkAdapterSettingentities present in the system.Each invocation creates and uses a short-lived PowerShell session internally.
- Specified by:
getin interfaceCommonServiceInterface<Win32NetworkAdapterSetting>- Returns:
- an immutable list of
Win32NetworkAdapterSettingobjects representing the association between aWin32NetworkAdapterand it'sWin32NetworkAdapterConfiguration. Returns an empty list if none are detected. - Since:
- 3.0.0
-
get
@UsesJPowerShell @NotNull public @NotNull @Unmodifiable List<Win32NetworkAdapterSetting> get(@NonNull @NonNull com.profesorfalken.jpowershell.PowerShell powerShell) Retrieves an immutable list ofWin32NetworkAdapterSettingentities using the caller'sPowerShellsession.Each invocation creates and uses a short-lived PowerShell session internally.
- Specified by:
getin interfaceCommonServiceInterface<Win32NetworkAdapterSetting>- Parameters:
powerShell- the caller-managed PowerShell session passed to the method- Returns:
- an immutable list of
Win32NetworkAdapterSettingobjects representing the association between aWin32NetworkAdapterand it'sWin32NetworkAdapterConfiguration. Returns an empty list if none are detected. - Since:
- 3.0.0
-
get
@IsolatedPowerShell @NotNull public @NotNull @Unmodifiable List<Win32NetworkAdapterSetting> get(long timeout) Retrieves an immutable list ofWin32NetworkAdapterSettingentities 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 interfaceCommonServiceInterface<Win32NetworkAdapterSetting>- Parameters:
timeout- the maximum time (in seconds) to wait for the PowerShell command to complete before terminating the process- Returns:
- an immutable list of
Win32NetworkAdapterSettingobjects representing the association between aWin32NetworkAdapterand it'sWin32NetworkAdapterConfiguration. Returns an empty list if none are detected. - Since:
- 3.1.0
-