Package de.captaingoldfish.scim.sdk.server.schemas.validation

Class AbstractResourceValidator

java.lang.Object

de.captaingoldfish.scim.sdk.server.schemas.validation.AbstractResourceValidator

Direct Known Subclasses:

RequestResourceValidator, ResponseResourceValidator

public abstract class AbstractResourceValidator
extends Object

Since:

21.04.2021

Author:

Pascal Knueppel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractResourceValidator.ValidatedExtension	the representation of a validated extension

Constructor Summary

Constructors

Constructor	Description
AbstractResourceValidator(ResourceType resourceType, AbstractSchemaValidator schemaValidator)

Method Summary

Modifier and Type	Method	Description
protected void	checkForMissingRequiredExtensions(List<Schema> requiredExtensionList, List<Schema> inResourcePresentExtensions)	checks if the extensions within the documents body are missing a required extension
protected abstract int	getHttpStatusCode()	the http status code to use in the DocumentValidationException if the validation fails.
protected ResourceType	getResourceType()	the resource type that is the representative for the validation that will be executed on the document
protected AbstractSchemaValidator	getSchemaValidator()	the schema validator implementation to use
ScimObjectNode	validateDocument(com.fasterxml.jackson.databind.JsonNode document)	checks the given document against the schema definition of the resourceType
protected List<AbstractResourceValidator.ValidatedExtension>	validateExtensions(List<Schema> extensions, List<Schema> inResourcePresentExtensions, com.fasterxml.jackson.databind.JsonNode resource)	validates the extensions that are present within the document that should be validated

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractResourceValidator

public AbstractResourceValidator(ResourceType resourceType,
 AbstractSchemaValidator schemaValidator)

Method Details

getHttpStatusCode

protected abstract int getHttpStatusCode()

the http status code to use in the DocumentValidationException if the validation fails. Should be 400 (bad request) for requests and 500 (internal server error) for responses

validateDocument

public ScimObjectNode validateDocument(com.fasterxml.jackson.databind.JsonNode document)

checks the given document against the schema definition of the resourceType

Parameters:

document - the document that should be validated

Returns:

the validated resource

validateExtensions

protected List<AbstractResourceValidator.ValidatedExtension> validateExtensions(List<Schema> extensions,
 List<Schema> inResourcePresentExtensions,
 com.fasterxml.jackson.databind.JsonNode resource)

validates the extensions that are present within the document that should be validated

Parameters:

extensions - all extensions that are defined within the resourceType

inResourcePresentExtensions - all extensions that were found within the documents body

Returns:

the list of validated extensions. If an extension evaluated to an empty object it will not be present within this list

checkForMissingRequiredExtensions

protected void checkForMissingRequiredExtensions(List<Schema> requiredExtensionList,
 List<Schema> inResourcePresentExtensions)

checks if the extensions within the documents body are missing a required extension

Parameters:

requiredExtensionList - the list of extensions that are required for the resourceType

inResourcePresentExtensions - all extensions that were found within the documents body

getResourceType

protected ResourceType getResourceType()

the resource type that is the representative for the validation that will be executed on the document

getSchemaValidator

protected AbstractSchemaValidator getSchemaValidator()

the schema validator implementation to use