Package de.captaingoldfish.scim.sdk.server.endpoints.handler

Class ResourceTypeHandler

java.lang.Object

de.captaingoldfish.scim.sdk.server.endpoints.ResourceHandler<ResourceType>

de.captaingoldfish.scim.sdk.server.endpoints.handler.ResourceTypeHandler

public class ResourceTypeHandler
extends ResourceHandler<ResourceType>

author Pascal Knueppel
created at: 17.10.2019 - 22:44

the resourceType handler for the resourceType endpoint that will provide the different resources

Constructor Summary

Constructors

Constructor	Description
ResourceTypeHandler(ResourceTypeFactory resourceTypeFactory)

Method Summary

Modifier and Type	Method	Description
ResourceType	createResource(ResourceType resource, Context context)	creating of resource types not supported
void	deleteResource(String id, Context context)	deleting of resource types not supported
ResourceType	getResource(String id, List<SchemaAttribute> attributes, List<SchemaAttribute> excludedAttributes, Context context)	extract a resource by its id
PartialListResponse	listResources(long startIndex, int count, FilterNode filter, SchemaAttribute sortBy, SortOrder sortOrder, List<SchemaAttribute> attributes, List<SchemaAttribute> excludedAttributes, Context context)	queries several resources based on the following values
ResourceType	updateResource(ResourceType resourceToUpdate, Context context)	updating of resource types not supported

Methods inherited from class de.captaingoldfish.scim.sdk.server.endpoints.ResourceHandler

getChangePasswordSupported, getMaxResults, getRequestValidator, getSchema, getSchemaExtensions, getType, isChangePasswordSupported, setSchema, setSchemaExtensions

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceTypeHandler

public ResourceTypeHandler(ResourceTypeFactory resourceTypeFactory)

Method Detail

createResource

public ResourceType createResource(ResourceType resource,
                                   Context context)

creating of resource types not supported

Specified by:

createResource in class ResourceHandler<ResourceType>

Parameters:

resource - the resource to store

context - the current request context that holds additional useful information. This object is never null

Returns:

the stored resource with additional meta information as id, created, lastModified timestamps etc.

getResource

public ResourceType getResource(String id,
                                List<SchemaAttribute> attributes,
                                List<SchemaAttribute> excludedAttributes,
                                Context context)

extract a resource by its id

Specified by:

getResource in class ResourceHandler<ResourceType>

Parameters:

id - the id of the resource to return

attributes - the attributes that should be returned to the client. If the client sends this parameter the evaluation of these parameters might help to improve database performance by omitting unnecessary table joins

excludedAttributes - the attributes that should NOT be returned to the client. If the client send this parameter the evaluation of these parameters might help to improve database performance by omitting unnecessary table joins

context - the current request context that holds additional useful information. This object is never null

Returns:

the found resource

listResources

public PartialListResponse listResources(long startIndex,
                                         int count,
                                         FilterNode filter,
                                         SchemaAttribute sortBy,
                                         SortOrder sortOrder,
                                         List<SchemaAttribute> attributes,
                                         List<SchemaAttribute> excludedAttributes,
                                         Context context)

queries several resources based on the following values

Specified by:

listResources in class ResourceHandler<ResourceType>

Parameters:

startIndex - the start index that has a minimum value of 1. So the given startIndex here will never be lower than 1

count - the number of entries that should be returned to the client. The minimum value of this value is 0.

filter - the parsed filter expression if the client has given a filter

sortBy - the attribute value that should be used for sorting

sortOrder - the sort order

attributes - the attributes that should be returned to the client. If the client sends this parameter the evaluation of these parameters might help to improve database performance by omitting unnecessary table joins

excludedAttributes - the attributes that should NOT be returned to the client. If the client send this parameter the evaluation of these parameters might help to improve database performance by omitting unnecessary table joins

context - the current request context that holds additional useful information. This object is never null

Returns:

a list of several resources and a total results value. You may choose to leave the totalResults value blank but this might lead to erroneous results on the client side

updateResource

public ResourceType updateResource(ResourceType resourceToUpdate,
                                   Context context)

updating of resource types not supported

Specified by:

updateResource in class ResourceHandler<ResourceType>

Parameters:

resourceToUpdate - the resource that should override an existing one

context - the current request context that holds additional useful information. This object is never null

Returns:

the updated resource with the values changed and a new lastModified value

deleteResource

public void deleteResource(String id,
                           Context context)

deleting of resource types not supported

Specified by:

deleteResource in class ResourceHandler<ResourceType>

Parameters:

id - the id of the resource to delete

context - the current request context that holds additional useful information. This object is never null