de.captaingoldfish.scim.sdk.server.schemas.validation.ResponseResourceValidator Maven / Gradle / Ivy

Go to download
// Generated by delombok at Tue Oct 15 15:18:23 CEST 2024
package de.captaingoldfish.scim.sdk.server.schemas.validation;

import java.util.List;
import java.util.function.BiFunction;
import com.fasterxml.jackson.databind.JsonNode;
import de.captaingoldfish.scim.sdk.common.constants.AttributeNames;
import de.captaingoldfish.scim.sdk.common.constants.HttpStatus;
import de.captaingoldfish.scim.sdk.common.resources.ServiceProvider;
import de.captaingoldfish.scim.sdk.common.resources.base.ScimObjectNode;
import de.captaingoldfish.scim.sdk.common.schemas.Schema;
import de.captaingoldfish.scim.sdk.common.schemas.SchemaAttribute;
import de.captaingoldfish.scim.sdk.server.schemas.ResourceType;


/**
 * @author Pascal Knueppel
 * @since 21.04.2021
 */
public class ResponseResourceValidator extends AbstractResourceValidator
{

  @java.lang.SuppressWarnings("all")
  @lombok.Generated
  private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(ResponseResourceValidator.class);

  public ResponseResourceValidator(ServiceProvider serviceProvider,
                                   ResourceType resourceType,
                                   List attributesList,
                                   List excludedAttributesList,
                                   JsonNode requestDocument,
                                   BiFunction referenceUrlSupplier)
  {
    super(resourceType,
          new ResponseSchemaValidator(serviceProvider, resourceType.getResourceHandlerImpl().getType(), attributesList,
                                      excludedAttributesList, requestDocument, referenceUrlSupplier));
  }

  /**
   * Does validate the meta-attribute after the document itself has been validated
   *
   * @param resource the document that should be validated
   * @return the validated document with the also validated meta attribute
   */
  @Override
  public ScimObjectNode validateDocument(JsonNode resource)
  {
    log.trace("Start validating response resource");
    ScimObjectNode validatedResource = super.validateDocument(resource);
    final JsonNode metaAttributeWrapper = getSchemaValidator().validateDocument(new ScimObjectNode(null),
                                                                                getResourceType().getMetaSchema(),
                                                                                resource);
    if (!metaAttributeWrapper.isEmpty())
    {
      JsonNode metaNode = metaAttributeWrapper.get(AttributeNames.RFC7643.META);
      validatedResource.set(AttributeNames.RFC7643.META, metaNode);
    }
    boolean containsOnlyAttributesSchemasAndMeta = validatedResource.size() == 2
                                                   && validatedResource.has(AttributeNames.RFC7643.SCHEMAS)
                                                   && validatedResource.has(AttributeNames.RFC7643.META);
    boolean isEmpty = validatedResource.isEmpty() || containsOnlyAttributesSchemasAndMeta;
    if (isEmpty)
    {
      log.debug("Validated response resource is empty");
      return null;
    }
    return validatedResource;
  }

  /**
   * validates the presence of the required schema-extensions only if not disabled by the
   * {@link ServiceProvider#isIgnoreRequiredExtensionsOnResponse()} attribute
   *
   * @param requiredExtensionList the list of extensions that are required for the {@link #resourceType}
   * @param inResourcePresentExtensions all extensions that were found within the documents body
   */
  @Override
  protected void checkForMissingRequiredExtensions(List requiredExtensionList,
                                                   List inResourcePresentExtensions)
  {
    if (!getSchemaValidator().getServiceProvider().isIgnoreRequiredExtensionsOnResponse())
    {
      super.checkForMissingRequiredExtensions(requiredExtensionList, inResourcePresentExtensions);
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  protected int getHttpStatusCode()
  {
    return HttpStatus.INTERNAL_SERVER_ERROR;
  }
}