Class ScimResourceType
java.lang.Object
com.revetsec.scim.ScimResourceType
Immutable application-resource registration. Endpoints are authority-free absolute paths
beneath the trusted service-provider base URI, without traversal, query or fragment.
- Since:
- 1.0.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classMutable, non-thread-safe complete resource-type configuration. -
Method Summary
Modifier and TypeMethodDescriptionCanonicalizes a registered path for authorization rules and supplied-path comparisons.booleanCompares complete semantic registrations.Returns the optional description.Returns the bounded endpoint path.getId()Returns the optional trusted discovery identifier.getName()Returns the resource type name.Returns the core schema.Returns the immutable extension registrations.static @NonNull ScimResourceTypeReturns the standard Group registration with PATCH 204.inthashCode()Returns the complete semantic registration hash.Returns whether an unprojected PATCH response uses 204.toString()Returns a fixed redacted description.static @NonNull ScimResourceTypeReturns the shared standard core User registration without schema extensions and with PATCH 200.static @NonNull ScimResourceType.BuilderStarts a resource type with its required bounded token name.
-
Method Details
-
withName
Starts a resource type with its required bounded token name.- Parameters:
name- the resource type name- Returns:
- a new builder
- Since:
- 1.0.0
-
userInstance
Returns the shared standard core User registration without schema extensions and with PATCH 200. Register the Enterprise User schema explicitly throughScimResourceType.Builder.schemaExtensions(List)when the application supports that extension. This registration does not enable PATCH.- Returns:
- the shared User resource type
- Since:
- 1.0.0
-
groupInstance
Returns the standard Group registration with PATCH 204.- Returns:
- the shared Group resource type
- Since:
- 1.0.0
-
getName
-
getId
-
getDescription
Returns the optional description.- Returns:
- the optional description
- Since:
- 1.0.0
-
getEndpoint
Returns the bounded endpoint path.- Returns:
- the bounded endpoint path
- Since:
- 1.0.0
-
getSchema
Returns the core schema. An equal rebuilt standard User or Group retains its configured identifier, name and description and uses the builtin attribute spellings.- Returns:
- the core schema
- Since:
- 1.0.0
-
getSchemaExtensions
Returns the immutable extension registrations. An equal rebuilt Enterprise User extension retains its configured identifier, name, description and required characteristic and uses the builtin attribute spellings.- Returns:
- the immutable extension registrations
- Since:
- 1.0.0
-
canonicalAttributePath
public @NonNull Optional<@NonNull ScimAttributePath> canonicalAttributePath(@NonNull ScimAttributePath path) Canonicalizes a registered path for authorization rules and supplied-path comparisons. Core schema paths become unqualified; extension paths retain the registered schema URI. This only resolves schema spelling and does not authorize an operation or a caller.- Parameters:
path- a parsed attribute path- Returns:
- its canonical registered form, or empty for an unknown path
- Since:
- 1.0.0
-
isPatchResponseNoContent
Returns whether an unprojected PATCH response uses 204.- Returns:
- whether an unprojected PATCH response uses 204
- Since:
- 1.0.0
-
equals
-
hashCode
-
toString
-