Class ScimQuery
java.lang.Object
com.revetsec.scim.ScimQuery
Immutable engine-created query bound to its originating provider's schema and semantic registration.
Filter-policy approval and projection do not authorize a caller. Applications authenticate callers,
select tenants, authorize access and execute the returned normalized filter with stable ordering.
A page built from this query must be rendered by the originating provider or a base-URI-only copy.
Applications own cursor authenticity, context binding and expiry; core checks only bounded framing.
- Since:
- 1.0.0
-
Method Summary
Modifier and TypeMethodDescriptionReturns this query's bound projection, separately from attribute authorization.getCount()Returns the effective nonnegative page-size bound after defaults and configured caps.Returns the original decoded opaque cursor when explicitly supplied.Returns the complete normalized, schema-bound, policy-approved filter, when supplied.Returns the selected page-framing method.Returns the original explicitly supplied signed count, before normalization or clamping.Returns the exact registered resource-type object targeted by this query.Returns the canonical schema-bound sort path, when requested.Returns the selected direction when sortBy is present; otherwise returns empty.Returns the normalized one-based start index for INDEX framing, and empty for CURSOR.Reports first-page framing: true exactly for CURSOR with an absent or empty cursor.toString()Returns a redacted diagnostic.
-
Method Details
-
getResourceType
Returns the exact registered resource-type object targeted by this query.- Returns:
- the originating registration
- Since:
- 1.0.0
-
getFilter
Returns the complete normalized, schema-bound, policy-approved filter, when supplied. Applications execute this returned tree rather than the original request text; policy approval does not establish caller authorization.- Returns:
- the approved filter, or empty when no filter was supplied
- Since:
- 1.0.0
-
getAttributeSelection
Returns this query's bound projection, separately from attribute authorization. The selection retains the originating provider's semantic registration.- Returns:
- the bound projection
- Since:
- 1.0.0
-
getSortBy
Returns the canonical schema-bound sort path, when requested. Applications own appropriate string collation, primary-or-first multivalue selection, absent-value ordering and a stable authoritative-ID tie-break.- Returns:
- the sort path, or empty when sorting was not requested
- Since:
- 1.0.0
-
getSortOrder
Returns the selected direction when sortBy is present; otherwise returns empty. A supplied sortBy with no sortOrder selectsScimSortOrder.ASCENDING.- Returns:
- the bound direction, or empty when sorting was not requested
- Since:
- 1.0.0
-
getPaginationMethod
Returns the selected page-framing method. An explicit cursor selects CURSOR, an explicit startIndex selects INDEX, and otherwise the provider's configured default applies. Cursor and startIndex cannot both be supplied.- Returns:
- the selected pagination method
- Since:
- 1.0.0
-
getStartIndex
Returns the normalized one-based start index for INDEX framing, and empty for CURSOR. The index defaults to one; explicitly supplied values below one become one.- Returns:
- the effective index, or empty for cursor pagination
- Since:
- 1.0.0
-
getCount
Returns the effective nonnegative page-size bound after defaults and configured caps. INDEX requests are clamped to those caps; oversized CURSOR requests reject during parsing. Zero denotes a count-only operation with no resources or traversal cursors and an accurate totalResults value in the application-authored page.- Returns:
- the effective count
- Since:
- 1.0.0
-
getRequestedCount
Returns the original explicitly supplied signed count, before normalization or clamping. Negative values remain visible here even though the effective count becomes zero. Empty means the count field was absent. Applications can retain both this presence/original value andgetCount()when checking a cursor's page-size context.- Returns:
- the original requested count, or empty when the field was absent
- Since:
- 1.0.0
-
getCursor
Returns the original decoded opaque cursor when explicitly supplied. An explicit empty string remains present and denotes the first cursor page. An absent cursor also denotes the first page when CURSOR is the configured default. Core validates grammar and framing; applications authenticate the token and bind tenant, caller, permissions, resource type, approved query, sort, projection, page size and expiry.- Returns:
- the supplied cursor, including an explicit empty string, or empty when absent
- Since:
- 1.0.0
-
isFirstCursorPage
Reports first-page framing: true exactly for CURSOR with an absent or empty cursor. This is always false for INDEX and establishes neither cursor authenticity nor storage state.- Returns:
- whether this is the first cursor page
- Since:
- 1.0.0
-
toString
-