com.bettercloud.scim2.server.annotation

Annotation Type ScimResource

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface ScimResource

Annotation for SCIM resource classes.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	description The description for the object.
java.lang.String	name The name for the object.
java.lang.Class<?>	schema The "schemas" attribute is a REQUIRED attribute and is an array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	discoverable Whether this resource type and its associated schemas should be discoverable using the SCIM 2 standard /resourceTypes and /schemas endpoints.
java.lang.Class<?>[]	optionalSchemaExtensions The optional schema extension resource classes.
java.lang.Class<?>[]	requiredSchemaExtensions The required schema extension resource classes.

Element Detail

description

public abstract java.lang.String description

The description for the object.

Returns:

The object's description.

name

public abstract java.lang.String name

The name for the object. This is a human readable name.

Returns:

The object's human-readable name.

schema

public abstract java.lang.Class<?> schema

The "schemas" attribute is a REQUIRED attribute and is an array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure. This attribute may be used by parsers to define the attributes present in the JSON structure that is the body to an HTTP request or response. Each String value must be a unique URI. All representations of SCIM schemas MUST include a non-empty array with value(s) of the URIs supported by that representation. The "schemas" attribute for a resource MUST only contain values defined as "schema" and "schemaExtensions" for the resource's defined "resourceType". Duplicate values MUST NOT be included. Value order is not specified and MUST NOT impact behavior.

Returns:

The primary/base resource class.

requiredSchemaExtensions

public abstract java.lang.Class<?>[] requiredSchemaExtensions

The required schema extension resource classes.

Returns:

The required schema extension resource classes.

Default:

{}

optionalSchemaExtensions

public abstract java.lang.Class<?>[] optionalSchemaExtensions

The optional schema extension resource classes.

Returns:

The optional schema extension resource classes.

Default:

{}

discoverable

public abstract boolean discoverable

Whether this resource type and its associated schemas should be discoverable using the SCIM 2 standard /resourceTypes and /schemas endpoints.

Returns:

A flag indicating the discoverability of this resource type and its associated schemas.

Default:

true