Package com.unboundid.scim2.server.utils

Class ResourceTypeDefinition.Builder

java.lang.Object

com.unboundid.scim2.server.utils.ResourceTypeDefinition.Builder

Enclosing class:

ResourceTypeDefinition

public static class ResourceTypeDefinition.Builder
extends Object

Builder for creating a ResourceTypeDefinition.

Constructor Summary

Constructors

Constructor	Description
Builder(String name, String endpoint)	Create a new builder.

Method Summary

Modifier and Type	Method	Description
ResourceTypeDefinition.Builder	addOptionalSchemaExtension(SchemaResource schemaExtension)	Adds a operation schema extension for a resource type.
ResourceTypeDefinition.Builder	addRequiredSchemaExtension(SchemaResource schemaExtension)	Adds a required schema extension for a resource type.
ResourceTypeDefinition	build()	Build the ResourceTypeDefinition.
ResourceTypeDefinition.Builder	setCoreSchema(SchemaResource coreSchema)	Sets the core schema of the resource type.
ResourceTypeDefinition.Builder	setDescription(String description)	Sets the description of the resource type.
ResourceTypeDefinition.Builder	setDiscoverable(boolean discoverable)	Sets whether this resource type is discoverable over the /ResourceTypes endpoint.
ResourceTypeDefinition.Builder	setId(String id)	Sets the ID of the resource type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(@NotNull
               String name,
               @NotNull
               String endpoint)

Create a new builder.

Parameters:

name - The name of the resource type.

endpoint - The endpoint of the resource type.

Method Detail

setId

@NotNull
public ResourceTypeDefinition.Builder setId(@Nullable
                                            String id)

Sets the ID of the resource type.

Parameters:

id - the ID of the resource type.

Returns:

this builder.

setDescription

@NotNull
public ResourceTypeDefinition.Builder setDescription(@Nullable
                                                     String description)

Sets the description of the resource type.

Parameters:

description - the description of the resource type.

Returns:

this builder.

setCoreSchema

@NotNull
public ResourceTypeDefinition.Builder setCoreSchema(@Nullable
                                                    SchemaResource coreSchema)

Sets the core schema of the resource type.

Parameters:

coreSchema - the core schema of the resource type.

Returns:

this builder.

addRequiredSchemaExtension

@NotNull
public ResourceTypeDefinition.Builder addRequiredSchemaExtension(@NotNull
                                                                 SchemaResource schemaExtension)

Adds a required schema extension for a resource type.

Parameters:

schemaExtension - the required schema extension for the resource type.

Returns:

this builder.

addOptionalSchemaExtension

@NotNull
public ResourceTypeDefinition.Builder addOptionalSchemaExtension(@NotNull
                                                                 SchemaResource schemaExtension)

Adds a operation schema extension for a resource type.

Parameters:

schemaExtension - the operation schema extension for the resource type.

Returns:

this builder.

setDiscoverable

@NotNull
public ResourceTypeDefinition.Builder setDiscoverable(boolean discoverable)

Sets whether this resource type is discoverable over the /ResourceTypes endpoint.

Parameters:

discoverable - true this resource type is discoverable over the /ResourceTypes endpoint or false otherwise.

Returns:

this builder.

build

@NotNull
public ResourceTypeDefinition build()

Build the ResourceTypeDefinition.

Returns:

The newly created ResourceTypeDefinition.