Class Win32EnvironmentService

java.lang.Object
io.github.eggy03.ferrumx.windows.service.system.Win32EnvironmentService
All Implemented Interfaces:
CommonServiceInterface<Win32Environment>
public class Win32EnvironmentService extends Object implements CommonServiceInterface<Win32Environment>
Service class for fetching information about environment variables in a Windows System.

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

Usage examples

// Convenience API (creates its own short-lived session)
Win32EnvironmentService service = new Win32EnvironmentService();
List<Win32Environment> env = service.get();

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

// API with execution timeout (auto-created session is terminated if the timeout is exceeded)
Win32EnvironmentService service = new Win32EnvironmentService();
List<Win32Environment> env = 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

    • Win32EnvironmentService

      public Win32EnvironmentService()

  • Method Details

    • get

      @UsesJPowerShell @NotNull public @NotNull @Unmodifiable List<Win32Environment> get()
      Retrieves an immutable list of env variables present in the system.

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

      Specified by:
      get in interface CommonServiceInterface<Win32Environment>
      Returns:
      an immutable list of Win32Environment objects representing the env variables. Returns an empty list if no env variables are detected.
      Since:
      3.0.0

    • get

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

    • get

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