Class ScimSchema

java.lang.Object
com.revetsec.scim.ScimSchema

@Immutable @CheckReturnValue public final class ScimSchema extends Object
Immutable SCIM schema registration. Schema identifiers are bounded absolute URI strings; they are never fetched. Application schemas cannot override common resource attributes.
Since:
1.0.0
  • Method Details

    • withId

      Starts an application schema with its required absolute URI identifier.
      Parameters:
      id - the required schema identifier
      Returns:
      a new builder
      Since:
      1.0.0
    • getId

      public @NonNull String getId()
      Returns the schema URI identifier.
      Returns:
      the schema URI identifier
      Since:
      1.0.0
    • getName

      Returns the human-readable schema name.
      Returns:
      the human-readable schema name
      Since:
      1.0.0
    • getDescription

      Returns the optional schema description.
      Returns:
      the optional schema description
      Since:
      1.0.0
    • getAttributes

      Returns the immutable schema-specific definitions. Common resource definitions are inherited.
      Returns:
      the immutable schema-specific definitions
      Since:
      1.0.0
    • userInstance

      public static @NonNull ScimSchema userInstance()
      Returns the shared standard User schema, with reviewed RFC corrections.
      Returns:
      the standard schema
      Since:
      1.0.0
    • groupInstance

      Returns the shared standard Group schema, with reviewed RFC corrections.
      Returns:
      the standard schema
      Since:
      1.0.0
    • enterpriseUserInstance

      Returns the shared standard Enterprise User extension schema, with reviewed RFC corrections.
      Returns:
      the standard schema
      Since:
      1.0.0
    • serviceProviderConfigInstance

      Returns the shared standard ServiceProviderConfig discovery schema, with reviewed RFC corrections.
      Returns:
      the standard schema
      Since:
      1.0.0
    • resourceTypeInstance

      Returns the shared standard ResourceType discovery schema, with reviewed RFC corrections.
      Returns:
      the standard schema
      Since:
      1.0.0
    • schemaInstance

      Returns the shared standard Schema discovery schema, with reviewed RFC corrections.
      Returns:
      the standard schema
      Since:
      1.0.0
    • equals

      public boolean equals(@Nullable Object other)
      Compares semantic schema registrations, folding the schema identifier.
      Overrides:
      equals in class Object
      Parameters:
      other - the comparison value
      Returns:
      whether registrations have equal characteristics
      Since:
      1.0.0
    • hashCode

      public int hashCode()
      Returns the semantic registration hash.
      Overrides:
      hashCode in class Object
      Returns:
      the semantic hash
      Since:
      1.0.0
    • toString

      Returns a fixed redacted description.
      Overrides:
      toString in class Object
      Returns:
      a fixed redacted description
      Since:
      1.0.0