io.fabric8.kubernetes.internal.KubernetesDeserializer Maven / Gradle / Ivy
/**
* 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.Objects;
import java.util.ServiceLoader;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonNode;
import io.fabric8.kubernetes.api.KubernetesResourceMappingProvider;
import io.fabric8.kubernetes.api.model.GenericKubernetesResource;
import io.fabric8.kubernetes.api.model.HasMetadata;
import io.fabric8.kubernetes.api.model.KubernetesListBuilder;
import io.fabric8.kubernetes.api.model.KubernetesResource;
import io.fabric8.kubernetes.model.annotation.Group;
import io.fabric8.kubernetes.model.annotation.Version;
import io.fabric8.kubernetes.model.util.Helper;
public class KubernetesDeserializer extends JsonDeserializer {
static class TypeKey {
final String kind;
final String apiGroup;
final String version;
TypeKey(String kind, String apiGroup, String version) {
this.kind = kind;
this.apiGroup = apiGroup;
this.version = version;
}
@Override
public int hashCode() {
return Objects.hash(kind, apiGroup, version);
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof TypeKey)) {
return false;
}
TypeKey o = (TypeKey) obj;
return Objects.equals(kind, o.kind) && Objects.equals(apiGroup, o.apiGroup)
&& Objects.equals(version, o.version);
}
}
private static final String TEMPLATE_CLASS_NAME = "io.fabric8.openshift.api.model.Template";
private static final String KIND = "kind";
private static final String API_VERSION = "apiVersion";
private static final Mapping mapping = new Mapping();
private static final ThreadLocal IN_TEMPLATE = ThreadLocal.withInitial(() -> false);
public static boolean isInTemplate() {
return IN_TEMPLATE.get();
}
@Override
public KubernetesResource deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException {
JsonNode node = jp.readValueAsTree();
if (node.isObject()) {
return fromObjectNode(jp, node);
} else if (node.isArray()) {
return fromArrayNode(jp, node);
} else {
return null;
}
}
private KubernetesResource fromArrayNode(JsonParser jp, JsonNode node) throws IOException {
Iterator iterator = node.elements();
List list = new ArrayList<>();
while (iterator.hasNext()) {
JsonNode jsonNode = iterator.next();
if (jsonNode.isObject()) {
KubernetesResource resource = fromObjectNode(jp, jsonNode);
if (resource instanceof HasMetadata) {
list.add((HasMetadata)resource);
}
}
}
return new KubernetesListBuilder().withItems(list).build();
}
private static KubernetesResource fromObjectNode(JsonParser jp, JsonNode node) throws IOException {
TypeKey key = getKey(node);
if (key != null) {
Class resourceType = mapping.getForKey(key);
if (resourceType == null) {
return jp.getCodec().treeToValue(node, GenericKubernetesResource.class);
} else if (KubernetesResource.class.isAssignableFrom(resourceType)){
boolean inTemplate = false;
if (TEMPLATE_CLASS_NAME.equals(resourceType.getName())) {
inTemplate = true;
IN_TEMPLATE.set(true);
}
try {
return jp.getCodec().treeToValue(node, resourceType);
} finally {
if (inTemplate) {
IN_TEMPLATE.remove();
}
}
}
}
return null;
}
/**
* Return a string representation of the key of the type: #.
*/
private static TypeKey getKey(JsonNode node) {
JsonNode apiVersion = node.get(API_VERSION);
JsonNode kind = node.get(KIND);
return mapping.createKey(
apiVersion != null ? apiVersion.textValue() : null,
kind != null ? kind.textValue() : null);
}
/**
* 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) {
mapping.registerKind(apiVersion, kind, clazz);
}
/**
* Registers a Custom Resource Mapping Provider
*/
public static void registerProvider(KubernetesResourceMappingProvider provider) {
mapping.registerProvider(provider);
}
static class Mapping {
private static final String KEY_SEPARATOR = "#";
// n.b. Packages sorted in order of precedence, deserialization of resources with no
// specific version will default to first available Class in one of these packages:
private static final String[] PACKAGES = {
"io.fabric8.kubernetes.api.model.",
"io.fabric8.kubernetes.api.model.admission.v1.",
"io.fabric8.kubernetes.api.model.admission.v1beta1.",
"io.fabric8.kubernetes.api.model.admissionregistration.v1.",
"io.fabric8.kubernetes.api.model.admissionregistration.v1beta1.",
"io.fabric8.kubernetes.api.model.authentication.",
"io.fabric8.kubernetes.api.model.authorization.v1.",
"io.fabric8.kubernetes.api.model.authorization.v1beta1.",
"io.fabric8.kubernetes.api.model.apiextensions.v1.",
"io.fabric8.kubernetes.api.model.apiextensions.v1beta1.",
"io.fabric8.kubernetes.api.model.apps.",
"io.fabric8.kubernetes.api.model.autoscaling.v1.",
"io.fabric8.kubernetes.api.model.autoscaling.",
"io.fabric8.kubernetes.api.model.autoscaling.v2beta1.",
"io.fabric8.kubernetes.api.model.autoscaling.v2beta2.",
"io.fabric8.kubernetes.api.model.batch.v1.",
"io.fabric8.kubernetes.api.model.batch.v1beta1.",
"io.fabric8.kubernetes.api.model.certificates.v1.",
"io.fabric8.kubernetes.api.model.certificates.v1beta1.",
"io.fabric8.kubernetes.api.model.coordination.v1.",
"io.fabric8.kubernetes.api.model.coordination.",
"io.fabric8.kubernetes.api.model.discovery.v1.",
"io.fabric8.kubernetes.api.model.events.v1.",
"io.fabric8.kubernetes.api.model.events.v1beta1.",
"io.fabric8.kubernetes.api.model.flowcontrol.v1beta1.",
"io.fabric8.kubernetes.api.model.discovery.v1beta1.",
"io.fabric8.kubernetes.api.model.metrics.v1beta1.",
"io.fabric8.kubernetes.api.model.networking.v1.",
"io.fabric8.kubernetes.api.model.networking.v1beta1.",
"io.fabric8.kubernetes.api.model.policy.v1.",
"io.fabric8.kubernetes.api.model.policy.v1beta1.",
"io.fabric8.kubernetes.api.model.rbac.",
"io.fabric8.kubernetes.api.model.storage.",
"io.fabric8.kubernetes.api.model.scheduling.v1.",
"io.fabric8.kubernetes.api.model.scheduling.v1beta1.",
"io.fabric8.kubernetes.api.model.storage.",
"io.fabric8.kubernetes.api.model.storage.v1beta1.",
"io.fabric8.kubernetes.api.model.node.v1alpha1.",
"io.fabric8.kubernetes.api.model.node.v1beta1.",
"io.fabric8.openshift.api.model.",
"io.fabric8.openshift.api.model.clusterautoscaling.v1.",
"io.fabric8.openshift.api.model.clusterautoscaling.v1beta1.",
"io.fabric8.openshift.api.model.runtime.",
"io.fabric8.openshift.api.model.console.v1.",
"io.fabric8.openshift.api.model.console.v1alpha1.",
"io.fabric8.openshift.api.model.hive.v1.",
"io.fabric8.openshift.api.model.installer.v1.",
"io.fabric8.openshift.api.model.monitoring.v1.",
"io.fabric8.openshift.api.model.machine.v1beta1.",
"io.fabric8.openshift.api.model.operator.",
"io.fabric8.openshift.api.model.operator.v1.",
"io.fabric8.openshift.api.model.operator.v1alpha1.",
"io.fabric8.openshift.api.model.imageregistry.v1.",
"io.fabric8.openshift.api.model.operatorhub.manifests.",
"io.fabric8.openshift.api.model.operatorhub.v1.",
"io.fabric8.openshift.api.model.operatorhub.v1alpha1.",
"io.fabric8.openshift.api.model.operatorhub.lifecyclemanager.v1.",
"io.fabric8.openshift.api.model.machineconfig.v1.",
"io.fabric8.openshift.api.model.tuned.v1.",
"io.fabric8.openshift.api.model.whereabouts.v1alpha1.",
"io.fabric8.openshift.api.model.storageversionmigrator.v1alpha1.",
"io.fabric8.openshift.api.model.miscellaneous.cloudcredential.v1.",
"io.fabric8.openshift.api.model.miscellaneous.cncf.cni.v1.",
"io.fabric8.openshift.api.model.miscellaneous.metal3.v1alpha1.",
"io.fabric8.openshift.api.model.miscellaneous.network.operator.v1.",
"io.fabric8.openshift.api.model.miscellaneous.imageregistry.operator.v1.",
"io.fabric8.kubernetes.api.model.extensions."
};
private Map> mappings = new ConcurrentHashMap<>();
private Map> internalMappings = new ConcurrentHashMap<>();
Mapping() {
registerAllProviders();
}
public Class getForKey(TypeKey key) {
if (key == null) {
return null;
}
// check for an exact match
Class clazz = mappings.get(key);
if (clazz != null) {
return clazz;
}
// check if it's a lazily-loaded internal type
List defaults = internalMappings.get(key.kind);
if (defaults == null) {
defaults = loadInternalTypes(key.kind);
clazz = mappings.get(key); // check again after load for an exact match
if (clazz != null) {
return clazz;
}
}
// if there are internal types matching kind, look for matching groups and versions
// but use first version seen (in PACKAGES order)
TypeKey bestMatch = null;
for (TypeKey typeKey : defaults) {
if (key.apiGroup != null) {
if (!key.apiGroup.equals(typeKey.apiGroup)) {
continue;
}
bestMatch = typeKey;
break;
}
if (key.version != null && key.version.equals(typeKey.apiGroup)) {
bestMatch = typeKey;
break;
}
if (bestMatch == null) {
bestMatch = typeKey;
}
}
if (bestMatch != null) {
return mappings.get(bestMatch);
}
return null;
}
public void registerKind(String apiVersion, String kind, Class clazz) {
mappings.put(createKey(apiVersion, kind), clazz);
}
public void registerProvider(KubernetesResourceMappingProvider provider) {
if (provider == null) {
return;
}
provider.getMappings().entrySet().stream()
//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.
.filter(entry -> KubernetesResource.class.isAssignableFrom(entry.getValue()))
.forEach(e -> mappings.put(createKey(e.getKey()), e.getValue()));
}
/**
* Returns a composite key for apiVersion and kind.
*/
TypeKey createKey(String apiVersion, String kind) {
if (kind == null) {
return null;
} else if (apiVersion == null) {
return new TypeKey(kind, null, null);
} else {
String[] versionParts = new String[] {null, apiVersion};
if (apiVersion.contains("/")) {
versionParts = apiVersion.split("/", 2);
}
return new TypeKey(kind, versionParts[0], versionParts[1]);
}
}
TypeKey createKey(String key) {
// null is not allowed
if (key.contains(KEY_SEPARATOR)) {
String[] parts = key.split(KEY_SEPARATOR, 2);
return createKey(parts[0], parts[1]);
}
return createKey(null, key);
}
private void registerAllProviders() {
getAllMappingProviders().forEach(this::registerProvider);
}
Stream getAllMappingProviders() {
//Use service loader to load extension types.
Iterable currentThreadClassLoader =
() -> ServiceLoader.load(KubernetesResourceMappingProvider.class, Thread.currentThread().getContextClassLoader())
.iterator();
Iterable classClassLoader =
() -> ServiceLoader.load(KubernetesResourceMappingProvider.class, KubernetesDeserializer.class.getClassLoader())
.iterator();
return Stream.concat(
StreamSupport.stream(currentThreadClassLoader.spliterator(), false),
StreamSupport.stream(classClassLoader.spliterator(), false))
.filter(distinctByClassName(KubernetesResourceMappingProvider::getClass));
}
private List loadInternalTypes(String kind) {
List ordering = new ArrayList<>();
for (int i = 0; i < PACKAGES.length; i++) {
Class result = loadClassIfExists(PACKAGES[i] + kind);
if (result == null) {
continue;
}
TypeKey defaultKeyFromClass = getKeyFromClass(result);
mappings.put(defaultKeyFromClass, result);
ordering.add(defaultKeyFromClass);
}
internalMappings.put(kind, ordering);
return ordering;
}
private TypeKey getKeyFromClass(Class clazz) {
String apiGroup = Helper.getAnnotationValue(clazz, Group.class);
String apiVersion = Helper.getAnnotationValue(clazz, Version.class);
if (apiGroup != null && !apiGroup.isEmpty() && apiVersion != null && !apiVersion.isEmpty()) {
return new TypeKey(clazz.getSimpleName(), apiGroup, apiVersion);
} else if (apiVersion != null && !apiVersion.isEmpty()) {
return createKey(apiVersion, clazz.getSimpleName());
}
return new TypeKey(clazz.getSimpleName(), null, null);
}
private Class loadClassIfExists(String className) {
try {
Class clazz = KubernetesDeserializer.class.getClassLoader().loadClass(className);
if (!KubernetesResource.class.isAssignableFrom(clazz)) {
return null;
}
return (Class) clazz;
} catch (Exception t) {
return null;
}
}
private Predicate distinctByClassName(
Function> mapperProvider) {
Set existing = ConcurrentHashMap.newKeySet();
return provider -> existing.add(mapperProvider.apply(provider).getName());
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy