Package io.jans.scim.model.scim2.annotations

Annotation Type Attribute

  • @Retention(RUNTIME)
@Target(FIELD)
public @interface Attribute
    Annotation used to attach meta information to attributes and subattributes of SCIM resources (descendants of class BaseScimResource).

    This annotation reflects what is shown in section 2.2 RFC 7643. Default values assigned per section 7.

    • Element Detail

      • isCaseExact

        boolean isCaseExact
        Determines if the attribute value is case sensitive.
        Returns:
        A flag indicating the attribute value's case sensitivity.
        Default:
        false

      • isRequired

        boolean isRequired
        Determines if the attribute value is required.
        Returns:
        A flag indicating if the attribute value is required.
        Default:
        false

      • description

        String description
        The description of the attribute.
        Returns:
        The description of the attribute.
        Default:
        ""

      • canonicalValues

        String[] canonicalValues
        The canonical values that may appear in an attribute.
        Returns:
        The canonical values that may appear in an attribute as an Array of Strings.
        Default:
        {}

      • returned

        AttributeDefinition.Returned returned
        The return constraint for the attribute.
        Returns:
        The return constraint for the attribute.
        Default:
        io.jans.scim.model.scim2.AttributeDefinition.Returned.DEFAULT

      • uniqueness

        AttributeDefinition.Uniqueness uniqueness
        The uniqueness constraint for the attribute.
        Returns:
        The uniqueness constraint for the attribute.
        Default:
        io.jans.scim.model.scim2.AttributeDefinition.Uniqueness.NONE

      • referenceTypes

        String[] referenceTypes
        The reference types for the attribute.
        Returns:
        The reference types for the attribute as an Array of Strings.
        Default:
        {}

      • mutability

        AttributeDefinition.Mutability mutability
        The mutability constraint for the attribute.
        Returns:
        The mutability constraint for the attribute.
        Default:
        io.jans.scim.model.scim2.AttributeDefinition.Mutability.READ_WRITE

      • multiValueClass

        Class multiValueClass
        If the attribute is multi-valued, this holds the type of the child object.
        Returns:
        For a multi-valued attribute, the type of the child object.
        Default:
        javax.lang.model.type.NullType.class

      • type

        AttributeDefinition.Type type
        The type of the attribute according to types defined by section 2.3 of RFC 7643
        Returns:
        Associated data type
        Default:
        io.jans.scim.model.scim2.AttributeDefinition.Type.STRING