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

Class ServiceProviderHandler

java.lang.Object

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

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

public class ServiceProviderHandler
extends ResourceHandler<ServiceProvider>

author Pascal Knueppel
created at: 18.10.2019 - 09:38

the service provider configuration endpoint implementation

Constructor Summary

Constructors

Constructor	Description
ServiceProviderHandler()

Method Summary

Modifier and Type	Method	Description
ServiceProvider	createResource(ServiceProvider resource, Authorization authorization)	creating of service provider configurations not supported
void	deleteResource(String id, Authorization authorization)	deleting of service provider configurations not supported
ServiceProvider	getResource(String id, Authorization authorization)	gets the one and only service provider configuration for this endpoint definition
PartialListResponse	listResources(long startIndex, int count, FilterNode filter, SchemaAttribute sortBy, SortOrder sortOrder, List<SchemaAttribute> attributes, List<SchemaAttribute> excludedAttributes, Authorization authorization)	listing of service provider configurations not supported
ServiceProvider	updateResource(ServiceProvider resourceToUpdate, Authorization authorization)	updating of service provider configurations not supported

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceProviderHandler

public ServiceProviderHandler()

Method Detail

createResource

public ServiceProvider createResource(ServiceProvider resource,
                                      Authorization authorization)

creating of service provider configurations not supported

Specified by:

createResource in class ResourceHandler<ServiceProvider>

Parameters:

resource - the resource to store

authorization - should return the roles of an user and may contain arbitrary data needed in the handler implementation

Returns:

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

getResource

public ServiceProvider getResource(String id,
                                   Authorization authorization)

gets the one and only service provider configuration for this endpoint definition

Specified by:

getResource in class ResourceHandler<ServiceProvider>

Parameters:

id - the id is obsolete here should be null

authorization -

Returns:

the one and only service provider configuration

listResources

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

listing of service provider configurations not supported

Specified by:

listResources in class ResourceHandler<ServiceProvider>

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 send 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

authorization - should return the roles of an user and may contain arbitrary data needed in the handler implementation

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 ServiceProvider updateResource(ServiceProvider resourceToUpdate,
                                      Authorization authorization)

updating of service provider configurations not supported

Specified by:

updateResource in class ResourceHandler<ServiceProvider>

Parameters:

resourceToUpdate - the resource that should override an existing one

authorization - should return the roles of an user and may contain arbitrary data needed in the handler implementation

Returns:

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

deleteResource

public void deleteResource(String id,
                           Authorization authorization)

deleting of service provider configurations not supported

Specified by:

deleteResource in class ResourceHandler<ServiceProvider>

Parameters:

id - the id of the resource to delete

authorization - should return the roles of an user and may contain arbitrary data needed in the handler implementation