io.fabric8.kubernetes.internal.KubernetesDeserializer Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2015 Red Hat, 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 io.fabric8.kubernetes.internal;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.ServiceLoader;
import java.util.concurrent.ConcurrentHashMap;

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;

import io.fabric8.kubernetes.api.KubernetesResourceMappingProvider;
import io.fabric8.kubernetes.api.model.HasMetadata;
import io.fabric8.kubernetes.api.model.KubernetesListBuilder;
import io.fabric8.kubernetes.api.model.KubernetesResource;

public class KubernetesDeserializer extends JsonDeserializer {

    private static final String KIND = "kind";
    private static final String API_VERSION = "apiVersion";
    private static final String KEY_SEPARATOR = "#";

    private static final Map> MAP = new ConcurrentHashMap<>();
    private static final String[] PACKAGES = {
      "io.fabric8.kubernetes.api.model.",
      "io.fabric8.kubernetes.api.model.admissionregistration.",
      "io.fabric8.kubernetes.api.model.apiextensions.",
      "io.fabric8.kubernetes.api.model.apps.",
      "io.fabric8.kubernetes.api.model.authentication.",
      "io.fabric8.kubernetes.api.model.authorization.",
      "io.fabric8.kubernetes.api.model.batch.",
      "io.fabric8.kubernetes.api.model.certificates.",
      "io.fabric8.kubernetes.api.model.coordination.",
      "io.fabric8.kubernetes.api.model.discovery.",
      "io.fabric8.kubernetes.api.model.extensions.",
      "io.fabric8.kubernetes.api.model.events.",
      "io.fabric8.kubernetes.api.model.networking.",
      "io.fabric8.kubernetes.api.model.policy.",
      "io.fabric8.kubernetes.api.model.rbac.",
      "io.fabric8.kubernetes.api.model.storage.",
      "io.fabric8.kubernetes.api.model.scheduling.",
      "io.fabric8.kubernetes.api.model.settings.",
      "io.fabric8.openshift.api.model."
    };

    static {
        //Use service loader to load extension types.
        for (KubernetesResourceMappingProvider provider : ServiceLoader.load(KubernetesResourceMappingProvider.class)) {
            for (Map.Entry> entry : provider.getMappings().entrySet()) {
                String key = entry.getKey();
                Class value = entry.getValue();
                //If the model is shaded (which is as part of kubernetes-client uberjar) this is going to cause conflicts.
                //This is why we NEED TO filter out incompatible resources.
                if (KubernetesResource.class.isAssignableFrom(value)) {
                        MAP.put(key, value);
                }
            }
        }
    }

    @Override
    public KubernetesResource deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException, JsonProcessingException {
        JsonNode node = jp.readValueAsTree();
        if (node instanceof ObjectNode) {
          return fromObjectNode(jp, (ObjectNode) node);
        } else if (node instanceof ArrayNode) {
          ArrayNode arrayNode = (ArrayNode) node;
          Iterator iterator = arrayNode.elements();
          List list = new ArrayList();
          while (iterator.hasNext()) {
            JsonNode jsonNode = iterator.next();
            if (jsonNode instanceof ObjectNode) {
              KubernetesResource resource = fromObjectNode(jp, (ObjectNode) jsonNode);
              if (resource instanceof HasMetadata) {
                list.add((HasMetadata)resource);
              }
            }
          }
          return new KubernetesListBuilder().withItems(list).build();
        }
        return null;
    }

  private static KubernetesResource fromObjectNode(JsonParser jp, ObjectNode node) throws IOException, JsonProcessingException {
      String key = getKey(node);
      if (key != null) {
        Class resourceType = getTypeForKey(key);
        if (resourceType == null) {
          throw JsonMappingException.from(jp,"No resource type found for:" + key);
        } else {
          return jp.getCodec().treeToValue(node, resourceType);
        }
      }
    return null;
    }

    /**
     * Return a string representation of the key of the type: #.
     */
    private static String getKey(ObjectNode node) {
        JsonNode apiVersion = node.get(API_VERSION);
        JsonNode kind = node.get(KIND);

        return getKey(apiVersion != null ? apiVersion.textValue() : null,
                      kind != null ? kind.textValue() : null);
    }
    
    /**
     * Returns a composite key for apiVersion and kind.
     */
    private static String getKey(String apiVersion, String kind) {
        if (kind == null) {
            return null;
        } else if (apiVersion == null) {
            return kind;
        } else {
            return String.format("%s#%s", apiVersion, kind);
        }
    }

    /**
     * Registers a Custom Resource Definition Kind
     */
    public static void registerCustomKind(String kind, Class clazz) {
        registerCustomKind(null, kind, clazz);
    }

    /**
     * Registers a Custom Resource Definition Kind
     */
    public static void registerCustomKind(String apiVersion, String kind, Class clazz) {
        MAP.put(getKey(apiVersion, kind), clazz);
    }

    private static Class getTypeForKey(String key) {
        Class result = MAP.get(key);
        if (result == null) {
            String name = key != null && key.contains(KEY_SEPARATOR) ?
                key.substring(key.indexOf(KEY_SEPARATOR) + 1) :
                key;
            
            result = getInternalTypeForName(name);
        }

        if (result != null) {
            MAP.put(key, result);
        }
        return result;
    }

    private static Class getInternalTypeForName(String name) {

      for (String aPackage : PACKAGES) {
        Class result = loadClassIfExists(aPackage + name);
        if (result != null) {
          return result;
        }
      }

        return null;
    } 

    private static Class loadClassIfExists(String className) {
        try {
            return KubernetesDeserializer.class.getClassLoader().loadClass(className);
        } catch (Throwable t) {
            return null;
        }
    }
}