Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Typed WQL results: map CIM values to Java objects instead of strings

Đang mở
#194 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
30/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Sôi nổi
Công nghệ
java
Lĩnh vực
api, backend

Hướng nghiên cứu

Start by tracing WqlRow.get(String), the WQL query execution path, and the legacy WinRMWqlExecutor.getRows() and WindowsRemoteExecutor.executeWql APIs. Review how WS-Management exposes CIM class and value information before deciding the typed opt-in shape. Done means a defined mapping for scalar, array, datetime, embedded, and NULL values while preserving the existing string API; the issue does not name tests or implementation files.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement

Follow-up to #189 (PR #193), where WMI array properties were fixed to come back as a single string joined with | (configurable with WinRMClient.Builder.arraySeparator(String)).

Problem

Every WQL value is exposed as a String, whatever its CIM type. Consumers parse numbers, booleans, dates and now |-joined arrays themselves:

  • WqlRow.get(String) is declared Object but always returns a String.
  • An array property is a joined string: a single-element array is indistinguishable from a scalar, and an element that contains the separator is ambiguous.
  • NULL is an empty string, indistinguishable from an empty string value.
  • CIM datetimes arrive in the WS-Management form (<cim:Datetime>2024-05-01T12:34:56.789Z</cim:Datetime> for CIM_DATETIME values, or an interval), which nobody wants to parse by hand.

Proposal

A typed result variant where the row values are native Java objects, alongside the existing string-based API (which stays the default, and the only one for the legacy WinRMWqlExecutor.getRows() / List<List<String>>).

Suggested shape, to be refined:

  • Opt in per query, e.g. client.wql(query).typed().execute(), or a WqlRow.typed(String) / WqlRow.list(String) accessor family; the legacy List<Map<String, Object>> of WindowsRemoteExecutor.executeWql could also carry typed values under an opt-in flag, so WinRMWqlExecutor keeps its strings.
  • Mapping from the type information WS-Management gives us. The instance XML carries no xsi:type; the CIM type must come from the class schema (a WSMan Get of the class definition, winrm get wmi/...?__CLASS, or the p: XML schema), or from the value form (<cim:Datetime> wrapper, xsi:nil, repeated elements).

Suggested mapping:

CIM type Java
string, char16 String
boolean Boolean
sint8/sint16/sint32/sint64, uint8/uint16/uint32 Integer / Long (uint64 → BigInteger or Long)
real32/real64 Float / Double
datetime java.time.Instant / OffsetDateTime for timestamps, Duration for intervals
reference String (the object path)
embedded object nested WqlRow
array of any of the above List<T>
NULL (xsi:nil="true") null

Open questions

  • Where the CIM type information comes from without an extra round trip per query (cache the class schema per client and class?).
  • Whether the WS-Management datetime encoding is consistent across Windows versions (2008 R2 through 2022 are available as test hosts).
  • Whether the CLI should emit JSON arrays/numbers/booleans/null when typed values are available (today it emits strings only).

Not in scope

The string API stays as it is: the | join and the empty-string NULL are documented behavior since 2.3.00.

Ngôn ngữ chính
Java
Star
13
Fork
4
Merge trung bình
12 giờ 44 phút
Pull request đã merge (30 ngày)
17

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của MetricsHub/winrm-java

Tất cả issue của MetricsHub/winrm-java

Issue tương tự

Thêm issue về Java

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.