de.gold.scim.common.schemas.Schema Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scim-common Show documentation
The newest version!
package de.gold.scim.common.schemas;

import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

import org.apache.commons.lang3.StringUtils;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ArrayNode;

import de.gold.scim.common.constants.AttributeNames;
import de.gold.scim.common.constants.HttpStatus;
import de.gold.scim.common.constants.ResourceTypeNames;
import de.gold.scim.common.exceptions.InvalidSchemaException;
import de.gold.scim.common.resources.ResourceNode;
import de.gold.scim.common.resources.complex.Meta;
import de.gold.scim.common.utils.JsonHelper;
import lombok.Getter;


/**
 * author Pascal Knueppel 

 * created at: 03.10.2019 - 13:24 

 * 

 * this class will represent a SCIM schema definition
 */
@Getter
public class Schema extends ResourceNode
{

  /**
   * this register shall be a simple reference map that is used for scim filter expressions to find the
   * attributes fast without iterating again and again of the attributes list.

   * All attributes will be added with the value output of the method {@link SchemaAttribute#getScimNodeName()}
   * in lowercase
   */
  private Map attributeRegister = new HashMap<>();

  public Schema(JsonNode jsonNode, String namePrefix)
  {

    setSchemas(JsonHelper.getSimpleAttributeArray(jsonNode, AttributeNames.RFC7643.SCHEMAS)
                         .orElse(Collections.emptyList()));
    String errorMessage = "attribute '" + AttributeNames.RFC7643.ID + "' is missing cannot resolve schema";
    setId(JsonHelper.getSimpleAttribute(jsonNode, AttributeNames.RFC7643.ID)
                    .orElseThrow(() -> new InvalidSchemaException(errorMessage, null, HttpStatus.INTERNAL_SERVER_ERROR,
                                                                  null)));
    setName(JsonHelper.getSimpleAttribute(jsonNode, AttributeNames.RFC7643.NAME).orElse(null));
    setDescription(JsonHelper.getSimpleAttribute(jsonNode, AttributeNames.RFC7643.DESCRIPTION).orElse(null));
    List attributeList = new ArrayList<>();
    String noAttributesErrorMessage = "schema with id '" + getId().orElse(null) + "' does not have attributes";
    ArrayNode attributes = JsonHelper.getArrayAttribute(jsonNode, AttributeNames.RFC7643.ATTRIBUTES)
                                     .orElseThrow(() -> new InvalidSchemaException(noAttributesErrorMessage, null,
                                                                                   HttpStatus.INTERNAL_SERVER_ERROR,
                                                                                   null));
    Set attributeNameSet = new HashSet<>();
    for ( JsonNode node : attributes )
    {
      SchemaAttribute schemaAttribute = new SchemaAttribute(this, getNonNullId(), null, node, namePrefix);
      if (attributeNameSet.contains(schemaAttribute.getName()))
      {
        String duplicateNameMessage = "the attribute with the name '" + schemaAttribute.getName() + "' was found "
                                      + "twice within the given schema declaration";
        throw new InvalidSchemaException(duplicateNameMessage, null, null, null);
      }
      attributeNameSet.add(schemaAttribute.getName());
      attributeList.add(schemaAttribute);
    }
    setAttributes(attributeList);
    initMeta(jsonNode.get(AttributeNames.RFC7643.META));
  }

  public Schema(JsonNode jsonNode)
  {
    this(jsonNode, null);
  }

  /**
   * @param jsonNode
   */
  private void initMeta(JsonNode jsonNode)
  {
    Meta meta;
    if (jsonNode == null)
    {
      LocalDateTime now = LocalDateTime.now();
      meta = Meta.builder().created(now).lastModified(now).resourceType(ResourceTypeNames.SCHEMA).build();
    }
    else
    {
      meta = JsonHelper.copyResourceToObject(jsonNode, Meta.class);
    }
    setMeta(meta);
  }

  /**
   * used explicitly for schema validation for easier code reading
   */
  public String getNonNullId()
  {
    String errorMessage = "attribute '" + AttributeNames.RFC7643.ID + "' is missing cannot resolve schema";
    return getId().orElseThrow(() -> new InvalidSchemaException(errorMessage, null, HttpStatus.INTERNAL_SERVER_ERROR,
                                                                null));
  }

  /**
   * The schema's human-readable name. When applicable, service providers MUST specify the name, e.g., "User" or
   * "Group". OPTIONAL.
   */
  public Optional getName()
  {
    return getStringAttribute(AttributeNames.RFC7643.NAME);
  }

  /**
   * The schema's human-readable name. When applicable, service providers MUST specify the name, e.g., "User" or
   * "Group". OPTIONAL.
   */
  private void setName(String name)
  {
    setAttribute(AttributeNames.RFC7643.NAME, name);
  }

  /**
   * The schema's human-readable description. When applicable, service providers MUST specify the description.
   * OPTIONAL.
   */
  public Optional getDescription()
  {
    return getStringAttribute(AttributeNames.RFC7643.DESCRIPTION);
  }

  /**
   * The schema's human-readable description. When applicable, service providers MUST specify the description.
   * OPTIONAL.
   */
  private void setDescription(String description)
  {
    setAttribute(AttributeNames.RFC7643.DESCRIPTION, description);
  }

  /**
   * gets the schema attributes of this schema
   */
  public List getAttributes()
  {
    return super.getArrayAttribute(AttributeNames.RFC7643.ATTRIBUTES, SchemaAttribute.class);
  }

  /**
   * sets the attributes into this json object
   */
  private void setAttributes(List attributes)
  {
    setAttribute(AttributeNames.RFC7643.ATTRIBUTES, attributes);
  }

  /**
   * gets a {@link SchemaAttribute} definition by its scimNodeName e.g. "userName" or "name.givenName". 

   * This method is for resolving filter expressions and therefore the {@code scimNodeName} values are evaluated
   * as case insensitive.

   *
   *    *    Attribute names and attribute operators used in filters are case
   *    insensitive.  For example, the following two expressions will
   *    evaluate to the same logical value:
   *
   *    filter=userName Eq "john"
   *
   *    filter=Username eq "john"
   * 
   */
  public SchemaAttribute getSchemaAttribute(String scimNodeName)
  {
    return attributeRegister.get(StringUtils.stripToEmpty(scimNodeName).toLowerCase());
  }

  /**
   * allows the child {@link SchemaAttribute}s to add themselves to this schema into the
   * {@link #attributeRegister}
   */
  protected void addSchemaAttribute(SchemaAttribute schemaAttribute)
  {
    String scimNodeName = schemaAttribute.getScimNodeName().toLowerCase();
    if (attributeRegister.containsKey(scimNodeName))
    {
      throw new InvalidSchemaException("schema '" + getNonNullId() + "' has an duplicate attribute name: '"
                                       + scimNodeName + "'", null, null, null);
    }
    attributeRegister.put(scimNodeName, schemaAttribute);
  }

}