Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// Generated by delombok at Sat Aug 24 10:10:59 CEST 2024
package de.captaingoldfish.scim.sdk.server.endpoints;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Optional;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Supplier;
import com.fasterxml.jackson.databind.JsonNode;
import de.captaingoldfish.scim.sdk.common.constants.enums.SortOrder;
import de.captaingoldfish.scim.sdk.common.exceptions.InternalServerException;
import de.captaingoldfish.scim.sdk.common.resources.ResourceNode;
import de.captaingoldfish.scim.sdk.common.resources.ServiceProvider;
import de.captaingoldfish.scim.sdk.common.schemas.Schema;
import de.captaingoldfish.scim.sdk.common.schemas.SchemaAttribute;
import de.captaingoldfish.scim.sdk.server.endpoints.features.EndpointType;
import de.captaingoldfish.scim.sdk.server.endpoints.validation.RequestValidator;
import de.captaingoldfish.scim.sdk.server.filter.FilterNode;
import de.captaingoldfish.scim.sdk.server.interceptor.Interceptor;
import de.captaingoldfish.scim.sdk.server.interceptor.NoopInterceptor;
import de.captaingoldfish.scim.sdk.server.patch.DefaultPatchOperationHandler;
import de.captaingoldfish.scim.sdk.server.patch.PatchOperationHandler;
import de.captaingoldfish.scim.sdk.server.response.PartialListResponse;
import de.captaingoldfish.scim.sdk.server.schemas.ResourceType;
import de.captaingoldfish.scim.sdk.server.schemas.validation.AbstractResourceValidator;
import de.captaingoldfish.scim.sdk.server.schemas.validation.ResponseResourceValidator;
/**
* author Pascal Knueppel
* created at: 07.10.2019 - 23:17
*
* this abstract class is the base for the developer to implement
*/
public abstract class ResourceHandler
{
/**
* the generic type of this class
*/
private Class type;
/**
* the current service provider configuration of the resource-type
*/
private ServiceProvider serviceProvider;
/**
* the resource type that is the basic definition of this handler implementation
*/
private ResourceType resourceType;
/**
* allows to access the definition of the main schema
*/
private Schema schema;
/**
* allows to access the attribute definitions of a schema extension
*/
private List schemaExtensions;
/**
* gives access to the changePassword value of the current service provider configuration
*/
private Supplier changePasswordSupported;
/**
* gives access to the filter max results value of the current service provider configuration
*/
private Supplier maxResults;
/**
* this function is used to resolve a resource type by the $ref-uri attribute or by the type-attribute of a
* resource-reference attribute
*/
private Function getResourceTypeByRef;
/**
* default constructor that resolves the generic type for this class
*/
public ResourceHandler()
{
Class clazz = getClass();
Type type = clazz.getGenericSuperclass();
boolean isParametrizedType;
do
{
isParametrizedType = type instanceof ParameterizedType;
if (isParametrizedType)
{
ParameterizedType parameterizedType = (ParameterizedType)type;
this.type = (Class)parameterizedType.getActualTypeArguments()[0];
}
else
{
clazz = clazz.getSuperclass();
type = clazz.getGenericSuperclass();
}
}
while (!isParametrizedType && !ResourceHandler.class.getName().equals(clazz.getName()));
if (this.type == null)
{
throw new InternalServerException("ResourceHandler implementations must be generified!", null, null);
}
}
/**
* permanently create a resource
*
* @param resource the resource to store
* @param context the current request context that holds additional useful information. This object is never
* null
* @return the stored resource with additional meta information as id, created, lastModified timestamps etc.
*/
public abstract T createResource(T resource, Context context);
/**
* extract a resource by its id
*
* @param id the id of the resource to return
* @param 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
* @param 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
* @param context the current request context that holds additional useful information. This object is never
* null
* @return the found resource
*/
public abstract T getResource(String id,
List attributes,
List excludedAttributes,
Context context);
/**
* extracts a resource by its id for further update or delete operation. This method may be used to apply a
* row lock to control concurrent access to data
*
* @param id the id of the resource to return
* @param 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
* @param 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
* @param context the current request context that holds additional useful information. This object is never
* null
* @return the found resource
*/
public T getResourceForUpdate(String id,
List attributes,
List excludedAttributes,
Context context,
EndpointType endpointType)
{
return getResource(id, attributes, excludedAttributes, context);
}
/**
* queries several resources based on the following values
*
* @param startIndex the start index that has a minimum value of 1. So the given startIndex here will never be
* lower than 1
* @param count the number of entries that should be returned to the client. The minimum value of this value
* is 0.
* @param filter the parsed filter expression if the client has given a filter
* @param sortBy the attribute value that should be used for sorting
* @param sortOrder the sort order
* @param 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
* @param 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
* @param context the current request context that holds additional useful information. This object is never
* null
* @return 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
*/
public abstract PartialListResponse listResources(long startIndex,
int count,
FilterNode filter,
SchemaAttribute sortBy,
SortOrder sortOrder,
List attributes,
List excludedAttributes,
Context context);
/**
* should update an existing resource with the given one. Simply use the id of the given resource and override
* the existing one with the given one. Be careful there have been no checks in advance for you if the
* resource to update does exist. This has to be done manually.
*
* NOTE:
* this method is also called by patch. But in the case of patch the check if the resource does exist will
* have been executed and the given resource is the already updated resource.
*
* @param resourceToUpdate the resource that should override an existing one
* @param context the current request context that holds additional useful information. This object is never
* null
* @return the updated resource with the values changed and a new lastModified value
*/
public abstract T updateResource(T resourceToUpdate, Context context);
/**
* permanently deletes the resource with the given id
*
* @param id the id of the resource to delete
* @param context the current request context that holds additional useful information. This object is never
* null
*/
public abstract void deleteResource(String id, Context context);
/**
* Retrieves a handler that is able to apply single
* {@link de.captaingoldfish.scim.sdk.common.request.PatchRequestOperation}s to a resource. The lifetime of
* the returned implementation will end after all patch-operations were applied to the resource and the
* {@link PatchOperationHandler#doAfter()} method was called.
*
* @param context the current SCIM request context
* @return the patch-handler implementation that applies specific patch-operation to the current resource
*/
public PatchOperationHandler getPatchOpResourceHandler(String resourceId, Context context)
{
return new DefaultPatchOperationHandler<>(type, serviceProvider.getPatchConfig(), resourceType, context);
}
/**
* @return true if the value in the in the corresponding value in the
* {@link de.captaingoldfish.scim.sdk.common.resources.ServiceProvider} configuration is true, false
* else
*/
public final boolean isChangePasswordSupported()
{
return Optional.ofNullable(changePasswordSupported).map(Supplier::get).orElse(false);
}
/**
* @return the maximum results value from the current
* {@link de.captaingoldfish.scim.sdk.common.resources.ServiceProvider} configuration
*/
public final int getMaxResults()
{
return Optional.ofNullable(maxResults).map(Supplier::get).orElse(Integer.MAX_VALUE);
}
/**
* @return allows to define a custom request validator that is executed after schema validation and before the
* call to the actual {@link ResourceHandler} implementation.
*/
public RequestValidator getRequestValidator()
{
return null;
}
/**
* this method is used to resolve a resource type by the $ref-uri attribute or by the type-attribute of a
* resource-reference attribute
*
* @param ref the $ref or type value of a resource-reference attribute e.g.: "User" or
* "http://localhost:8080/scim/v2/Users" or "http://localhost:8080/scim/v2/Users/${id}"
* @return the resource type definition of the referenced type.
*/
public Optional getResourceTypeByRef(String ref)
{
return Optional.ofNullable(getResourceTypeByRef).map(function -> function.apply(ref));
}
/**
* Retrieves an interceptor to execute a single operation within customized code
*
* @param endpointType tells you from which endpoint the interceptor was requested
*/
public Interceptor getInterceptor(EndpointType endpointType)
{
return new NoopInterceptor();
}
/**
* an arbitrary method that might be useful for implementations that need to do some initialization after the
* registration of the resource is complete
*/
protected void postConstruct(ResourceType resourceType)
{
// do nothing
}
/**
* can be used to override the response-verifier if custom validation is wanted
*
* @param attributesList the attributes from the request
* @param excludedAttributesList the excluded attributes from the request
* @param requestDocument the request document
* @param referenceUrlSupplier the url-supplier to build specific urls for resources
* @return an optional response-validator
*/
protected Optional getResponseValidator(List attributesList,
List excludedAttributesList,
JsonNode requestDocument,
BiFunction referenceUrlSupplier)
{
return Optional.of(new ResponseResourceValidator(serviceProvider, resourceType, attributesList,
excludedAttributesList, requestDocument, referenceUrlSupplier));
}
/**
* the generic type of this class
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Class getType()
{
return this.type;
}
/**
* the generic type of this class
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected void setType(final Class type)
{
this.type = type;
}
/**
* the current service provider configuration of the resource-type
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public ServiceProvider getServiceProvider()
{
return this.serviceProvider;
}
/**
* the current service provider configuration of the resource-type
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected void setServiceProvider(final ServiceProvider serviceProvider)
{
this.serviceProvider = serviceProvider;
}
/**
* the resource type that is the basic definition of this handler implementation
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public ResourceType getResourceType()
{
return this.resourceType;
}
/**
* the resource type that is the basic definition of this handler implementation
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected void setResourceType(final ResourceType resourceType)
{
this.resourceType = resourceType;
}
/**
* allows to access the definition of the main schema
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Schema getSchema()
{
return this.schema;
}
/**
* allows to access the definition of the main schema
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected void setSchema(final Schema schema)
{
this.schema = schema;
}
/**
* allows to access the attribute definitions of a schema extension
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public List getSchemaExtensions()
{
return this.schemaExtensions;
}
/**
* allows to access the attribute definitions of a schema extension
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected void setSchemaExtensions(final List schemaExtensions)
{
this.schemaExtensions = schemaExtensions;
}
/**
* gives access to the changePassword value of the current service provider configuration
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Supplier getChangePasswordSupported()
{
return this.changePasswordSupported;
}
/**
* gives access to the changePassword value of the current service provider configuration
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
void setChangePasswordSupported(final Supplier changePasswordSupported)
{
this.changePasswordSupported = changePasswordSupported;
}
/**
* gives access to the filter max results value of the current service provider configuration
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
void setMaxResults(final Supplier maxResults)
{
this.maxResults = maxResults;
}
/**
* this function is used to resolve a resource type by the $ref-uri attribute or by the type-attribute of a
* resource-reference attribute
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
void setGetResourceTypeByRef(final Function getResourceTypeByRef)
{
this.getResourceTypeByRef = getResourceTypeByRef;
}
}
