Class ScimLimits
java.lang.Object
com.revetsec.scim.ScimLimits
Immutable SCIM operation budgets. Each original operation uses one shared work budget.
Wire input and emitted JSON cost one work unit per started 16-byte block. JSON output blocks
accumulate across the complete response. Node visits, validation, matching, headers and framing
have their own additional charges. Byte and node limits are independent hard ceilings, not a
promise that every document below them fits work; builders validate each configured range.
- Since:
- 1.0.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classMutable complete budget configuration; null restores each default. -
Method Summary
Modifier and TypeMethodDescriptionstatic @NonNull ScimLimits.Builderbuilder()Starts budget configuration.static @NonNull ScimLimitsCreates a default snapshot.Returns the filter budget snapshot.Returns the inclusive original request-body byte ceiling.Returns the maximumConditionalHeaderBytes budget.Returns the maximumConditionalTags budget.Returns the maximumCursorCharacters budget.Returns the maximumJsonNodes budget.Returns the maximumPageSize budget.Returns the maximumParameterCharacters budget.Returns the maximumPatchOperations budget.Returns the maximumProjectionPaths budget.Returns the maximumQueryParameters budget.Returns the maximumRawQueryBytes budget.Returns the inclusive prepared-response budget, including body, encoded headers and framing.Returns the maximumResponseHeaderBytes budget.Returns the aggregate operation work allowance.toString()Returns a fixed description.
-
Method Details
-
builder
Starts budget configuration.- Returns:
- a fresh builder
- Since:
- 1.0.0
-
fromDefaults
Creates a default snapshot.- Returns:
- defaults
- Since:
- 1.0.0
-
getMaximumBodyBytes
Returns the inclusive original request-body byte ceiling. Before decoding, the body also requiresceil(bytes / 16)remaining work units; schema/structural processing needs additional work. The ceiling is not an acceptance guarantee.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumPatchOperations
Returns the maximumPatchOperations budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumJsonNodes
Returns the maximumJsonNodes budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumRawQueryBytes
Returns the maximumRawQueryBytes budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumQueryParameters
Returns the maximumQueryParameters budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumParameterCharacters
Returns the maximumParameterCharacters budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumProjectionPaths
Returns the maximumProjectionPaths budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumPageSize
Returns the maximumPageSize budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumCursorCharacters
Returns the maximumCursorCharacters budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumConditionalHeaderBytes
Returns the maximumConditionalHeaderBytes budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumConditionalTags
Returns the maximumConditionalTags budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumResponseHeaderBytes
Returns the maximumResponseHeaderBytes budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumResponseBytes
Returns the inclusive prepared-response budget, including body, encoded headers and framing. JSON emission additionally costsceil(bodyBytes / 16)work units for the entire body, plus node visits; projection and headers share that same operation budget.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getMaximumWorkUnits
Returns the aggregate operation work allowance. Input decoding admission and JSON emission charge started 16-byte blocks; structural and semantic work remains separately charged. A low work allowance can intentionally refuse requests/responses below their byte ceilings. No budget resets per phase or resource.- Returns:
- configured inclusive bound
- Since:
- 1.0.0
-
getFilterLimits
Returns the filter budget snapshot.- Returns:
- filter limits
- Since:
- 1.0.0
-
toString
-