Class Schema.Builder

  • Enclosing class:
    Schema

    public static class Schema.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • schemas

        public Schema.Builder schemas​(List<String> schemas)
        REQUIRED.

        The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

        Parameters:
        schemas - the value to set
        Returns:
        this builder
      • idcsMapsToSameTargetAttributeNameAs

        public Schema.Builder idcsMapsToSameTargetAttributeNameAs​(String idcsMapsToSameTargetAttributeNameAs)
        Contains the canonical name of the other attribute sharing the same idcsTargetAttributeName

        *Added In:** 2209122038

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: always - type: string - uniqueness: none

        Parameters:
        idcsMapsToSameTargetAttributeNameAs - the value to set
        Returns:
        this builder
      • externalId

        public Schema.Builder externalId​(String externalId)
        An identifier for the Resource as defined by the Service Consumer.

        The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer’s tenant.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        externalId - the value to set
        Returns:
        this builder
      • name

        public Schema.Builder name​(String name)
        Schema’s human-readable name

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        name - the value to set
        Returns:
        this builder
      • idcsResourceTypes

        public Schema.Builder idcsResourceTypes​(List<String> idcsResourceTypes)
        Resource types defs this resource refers to

        *SCIM++ Properties:** - caseExact: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        idcsResourceTypes - the value to set
        Returns:
        this builder
      • description

        public Schema.Builder description​(String description)
        Schema’s human-readable description

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        description - the value to set
        Returns:
        this builder
      • idcsMappable

        public Schema.Builder idcsMappable​(Boolean idcsMappable)
        Specifies if the attributes in this schema can be used for mapping with external identity sources such as AD or LDAP

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readOnly - required: true - returned: default - type: boolean - uniqueness: none

        Parameters:
        idcsMappable - the value to set
        Returns:
        this builder
      • idcsAttributeCacheable

        public Schema.Builder idcsAttributeCacheable​(Boolean idcsAttributeCacheable)
        Specifies whether the attribute is cacheable.

        True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \“attributesToGet\” while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.

        *Added In:** 17.3.4

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean

        Parameters:
        idcsAttributeCacheable - the value to set
        Returns:
        this builder
      • idcsOverrideCommonAttribute

        public Schema.Builder idcsOverrideCommonAttribute​(Boolean idcsOverrideCommonAttribute)
        Specifies whether the dataprovider mapping from resource schema should override from common schema with the same name.

        *Added In:** 2102181953

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean

        Parameters:
        idcsOverrideCommonAttribute - the value to set
        Returns:
        this builder
      • attributes

        public Schema.Builder attributes​(List<SchemaAttributes> attributes)
        A complex type that specifies the set of Resource attributes

        *SCIM++ Properties:** - idcsCompositeKey: [] - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex

        Parameters:
        attributes - the value to set
        Returns:
        this builder
      • build

        public Schema build()