com.strategicgains.hyperexpress.serialization.jackson.HalResourceDeserializer.java Source code

Introduction

Here is the source code for com.strategicgains.hyperexpress.serialization.jackson.HalResourceDeserializer.java

Source

/*
Copyright 2014, Strategic Gains, Inc.
    
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
    
  http://www.apache.org/licenses/LICENSE-2.0
    
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 */
package com.strategicgains.hyperexpress.serialization.jackson;

import java.io.IOException;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.ObjectCodec;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonNode;
import com.strategicgains.hyperexpress.builder.LinkBuilder;
import com.strategicgains.hyperexpress.domain.Namespace;
import com.strategicgains.hyperexpress.domain.hal.HalResource;

/**
 * @author toddf
 * @since May 21, 2014
 */
public class HalResourceDeserializer extends JsonDeserializer<HalResource> {
    private static final String LINKS = "_links";
    private static final String CURIES = "curies";
    private static final String EMBEDDED = "_embedded";
    private static final Set<String> RESERVED_PROPERTIES = new HashSet<>(Arrays.asList(LINKS, EMBEDDED));

    @Override
    public HalResource deserialize(JsonParser jp, DeserializationContext context)
            throws IOException, JsonProcessingException {
        ObjectCodec oc = jp.getCodec();
        return deserializeResource((JsonNode) jp.readValueAsTree(), oc);
    }

    private HalResource deserializeResource(JsonNode root, ObjectCodec oc)
            throws JsonProcessingException, IOException {
        HalResource resource = new HalResource();
        processLinks(root.get(LINKS), resource, oc);
        processEmbedded(root.get(EMBEDDED), resource, oc);
        processProperties(root, resource);
        return resource;
    }

    /**
     * @param links
     * @param resource
     * @param oc 
     * @throws IOException
     * @throws JsonProcessingException
     */
    private void processLinks(JsonNode links, HalResource resource, ObjectCodec oc)
            throws JsonProcessingException, IOException {
        if (links == null)
            return;

        processCuries(links.get(CURIES), resource, oc);
        Iterator<Entry<String, JsonNode>> fields = links.fields();

        while (fields.hasNext()) {
            Entry<String, JsonNode> field = fields.next();

            if (CURIES.equals(field.getKey()))
                continue;

            if (field.getValue().isArray()) {
                addAllLinks(resource, field);
            } else {
                addLink(resource, field);
            }
        }
    }

    /**
     * @param curies
     * @param resource
     * @param oc 
     * @throws IOException
     * @throws JsonProcessingException
     */
    private void processCuries(JsonNode curies, HalResource resource, ObjectCodec oc)
            throws JsonProcessingException, IOException {
        if (curies == null)
            return;

        if (curies.isArray()) {
            resource.addNamespaces(Arrays.asList(curies.traverse(oc).readValueAs(Namespace[].class)));
        } else {
            resource.addNamespace(curies.traverse(oc).readValueAs(Namespace.class));
        }
    }

    /**
     * @param resource
     * @param field
     */
    private void addAllLinks(HalResource resource, Entry<String, JsonNode> field) {
        LinkBuilder lb = new LinkBuilder();
        lb.rel(field.getKey());
        Iterator<JsonNode> values = field.getValue().elements();

        while (values.hasNext()) {
            JsonNode value = values.next();
            Iterator<JsonNode> elements = value.elements();

            while (elements.hasNext()) {
                JsonNode element = elements.next();
                lb.set(element.asText(), element.textValue());
            }

            resource.addLink(lb.build());
            lb.clearAttributes();
        }
    }

    /**
     * @param resource
     * @param field
     */
    private void addLink(HalResource resource, Entry<String, JsonNode> field) {
        LinkBuilder lb = new LinkBuilder();
        lb.rel(field.getKey());
        Iterator<Entry<String, JsonNode>> elements = field.getValue().fields();

        while (elements.hasNext()) {
            Entry<String, JsonNode> element = elements.next();

            if ("href".equals(element.getKey())) {
                lb.urlPattern(element.getValue().asText());
            } else {
                lb.set(element.getKey(), element.getValue().asText());
            }
        }

        resource.addLink(lb.build());

    }

    private void processEmbedded(JsonNode embedded, HalResource resource, ObjectCodec oc)
            throws JsonProcessingException, IOException {
        if (embedded == null)
            return;

        Iterator<Map.Entry<String, JsonNode>> fields = embedded.fields();

        while (fields.hasNext()) {
            Map.Entry<String, JsonNode> fieldEntry = fields.next();

            if (fieldEntry.getValue().isArray()) {
                Iterator<JsonNode> values = fieldEntry.getValue().elements();

                while (values.hasNext()) {
                    JsonNode value = values.next();
                    resource.addResource(fieldEntry.getKey(), deserializeResource(value, oc));
                }
            } else {
                resource.addResource(fieldEntry.getKey(), deserializeResource(fieldEntry.getValue(), oc));
            }
        }
    }

    private void processProperties(JsonNode root, HalResource resource) {
        Iterator<Entry<String, JsonNode>> fields = root.fields();

        while (fields.hasNext()) {
            Entry<String, JsonNode> fieldEntry = fields.next();

            if (!RESERVED_PROPERTIES.contains(fieldEntry.getKey())) {
                resource.setProperty(fieldEntry.getKey(), fieldEntry.getValue().asText());
            }
        }
    }
}