Class Win32PortConnectorService

java.lang.Object
io.github.eggy03.ferrumx.windows.service.mainboard.Win32PortConnectorService
All Implemented Interfaces:
CommonServiceInterface<Win32PortConnector>
public class Win32PortConnectorService extends Object implements CommonServiceInterface<Win32PortConnector>
Service class for fetching mainboard port information from the system.

This class executes the Cimv2.WIN32_PORT_CONNECTOR PowerShell command and maps the resulting JSON into an immutable list of Win32PortConnector objects.

Usage examples

// Convenience API (creates its own short-lived session)
Win32PortConnectorService service = new Win32PortConnectorService();
List<Win32PortConnector> ports = service.get();

// API with re-usable session (caller manages session lifecycle)
try (PowerShell session = PowerShell.openSession()) {
    Win32PortConnectorService service = new Win32PortConnectorService();
    List<Win32PortConnector> ports = service.get(session);
}

// API with execution timeout (auto-created session is terminated if the timeout is exceeded)
Win32PortConnectorService service = new Win32PortConnectorService();
List<Win32PortConnector> ports = service.get(10);

Execution models and concurrency

This service supports multiple PowerShell execution strategies:

  • jPowerShell-based execution via get() and get(PowerShell):
    These methods rely on jPowerShell sessions. Due to internal global configuration of jPowerShell, 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 on jPowerShell and instead, launches a standalone PowerShell process per invocation using TerminalUtility. 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 Details

    • Win32PortConnectorService

      public Win32PortConnectorService()

  • Method Details

    • get

      @UsesJPowerShell @NotNull public @NotNull @Unmodifiable List<Win32PortConnector> get()
      Retrieves an immutable list of mainboard ports present in the system.

      Each invocation creates and uses a short-lived PowerShell session internally.

      Specified by:
      get in interface CommonServiceInterface<Win32PortConnector>
      Returns:
      an immutable list of Win32PortConnector objects representing the system's mainboard ports. Returns an empty list if no ports are detected.
      Since:
      3.0.0

    • get

      @UsesJPowerShell @NotNull public @NotNull @Unmodifiable List<Win32PortConnector> get(@NonNull @NonNull com.profesorfalken.jpowershell.PowerShell powerShell)
      Retrieves an immutable list of mainboard ports present in the system using the caller's PowerShell session.
      Specified by:
      get in interface CommonServiceInterface<Win32PortConnector>
      Parameters:
      powerShell - an existing PowerShell session managed by the caller
      Returns:
      an immutable list of Win32PortConnector objects representing the system's mainboard ports. Returns an empty list if no ports are detected.
      Since:
      3.0.0

    • get

      @IsolatedPowerShell @NotNull public @NotNull @Unmodifiable List<Win32PortConnector> get(long timeout)
      Retrieves an immutable list of mainboard ports present 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:
      get in interface CommonServiceInterface<Win32PortConnector>
      Parameters:
      timeout - the maximum time (in seconds) to wait for the PowerShell command to complete before terminating the process
      Returns:
      an immutable list of Win32PortConnector objects representing the system's mainboard ports. Returns an empty list if no ports are detected.
      Since:
      3.1.0