Class Win32NetworkAdapterToConfigurationService
java.lang.Object
io.github.eggy03.ferrumx.windows.service.compounded.Win32NetworkAdapterToConfigurationService
- All Implemented Interfaces:
CommonServiceInterface<Win32NetworkAdapterToConfiguration>
public class Win32NetworkAdapterToConfigurationService
extends Object
implements CommonServiceInterface<Win32NetworkAdapterToConfiguration>
Service class for fetching network adapter and related configuration information from the system.
This class executes the ScriptEnum.WIN32_NETWORK_ADAPTER_TO_CONFIGURATION script
and maps the resulting JSON into an immutable list of Win32NetworkAdapterToConfiguration objects.
Usage examples
// Convenience API (creates its own short-lived session)
Win32NetworkAdapterToConfigurationService service = new Win32NetworkAdapterToConfigurationService();
List<Win32NetworkAdapterToConfiguration> netAdapConList = service.get();
// API with re-usable session (caller manages session lifecycle)
try (PowerShell session = PowerShell.openSession()) {
List<Win32NetworkAdapterToConfiguration> netAdapConList = service.get(session);
}
// API with execution timeout (auto-created session is terminated if the timeout is exceeded)
Win32NetworkAdapterToConfigurationService service = new Win32NetworkAdapterToConfigurationService();
List<Win32NetworkAdapterToConfiguration> netAdapConList = 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
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription@NotNull @Unmodifiable List<Win32NetworkAdapterToConfiguration> get()Retrieves an immutable list of network adapters and related configuration connected in the system.@NotNull @Unmodifiable List<Win32NetworkAdapterToConfiguration> get(long timeout) Retrieves an immutable list of network adapters and related configuration connected in the system using an isolated PowerShell process with a configurable timeout.@NotNull @Unmodifiable List<Win32NetworkAdapterToConfiguration> get(@NonNull com.profesorfalken.jpowershell.PowerShell powerShell) Retrieves an immutable list of network adapters and related configuration connected in the system using the caller'sPowerShellsession.
-
Constructor Details
-
Win32NetworkAdapterToConfigurationService
public Win32NetworkAdapterToConfigurationService()
-
-
Method Details
-
get
@UsesJPowerShell @NotNull public @NotNull @Unmodifiable List<Win32NetworkAdapterToConfiguration> get()Retrieves an immutable list of network adapters and related configuration connected in the system.Each invocation creates and uses a short-lived PowerShell session internally.
- Specified by:
getin interfaceCommonServiceInterface<Win32NetworkAdapterToConfiguration>- Returns:
- an immutable list of
Win32NetworkAdapterToConfigurationobjects representing connected network adapter and related configuration. Returns an empty list if no network adapter and related configuration are detected. - Since:
- 3.0.0
-
get
@UsesJPowerShell @NotNull public @NotNull @Unmodifiable List<Win32NetworkAdapterToConfiguration> get(@NonNull @NonNull com.profesorfalken.jpowershell.PowerShell powerShell) Retrieves an immutable list of network adapters and related configuration connected in the system using the caller'sPowerShellsession.- Specified by:
getin interfaceCommonServiceInterface<Win32NetworkAdapterToConfiguration>- Parameters:
powerShell- an existing PowerShell session managed by the caller- Returns:
- an immutable list of
Win32NetworkAdapterToConfigurationobjects representing connected network adapter and related configuration. Returns an empty list if no network adapter and related configuration are detected. - Since:
- 3.0.0
-
get
@IsolatedPowerShell @NotNull public @NotNull @Unmodifiable List<Win32NetworkAdapterToConfiguration> get(long timeout) Retrieves an immutable list of network adapters and related configuration connected in the system 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<Win32NetworkAdapterToConfiguration>- Parameters:
timeout- the maximum time (in seconds) to wait for the PowerShell command to complete before terminating the process- Returns:
- an immutable list of
Win32NetworkAdapterToConfigurationobjects representing connected network adapter and related configuration. Returns an empty list if no network adapter and related configuration are detected. - Since:
- 3.1.0
-