com.datastrato.gravitino.EntitySerDeFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Gravitino is a high-performance, geo-distributed and federated metadata lake.

There is a newer version: 0.5.1

/*
 * Copyright 2023 Datastrato Pvt Ltd.
 * This software is licensed under the Apache License version 2.
 */
package com.datastrato.gravitino;

import com.datastrato.gravitino.proto.ProtoEntitySerDe;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class is responsible for creating instances of EntitySerDe implementations. EntitySerDe
 * (Entity Serialization/Deserialization) implementations are used to serialize and deserialize
 * entities within the Gravitino framework.
 */
public class EntitySerDeFactory {

  private static final Logger LOG = LoggerFactory.getLogger(EntitySerDeFactory.class);

  // Register EntitySerDe's short name to its full qualified class name in the map. So that user
  // don't need to specify the full qualified class name when creating an EntitySerDe.
  private static final Map ENTITY_SERDES =
      ImmutableMap.of("proto", ProtoEntitySerDe.class.getCanonicalName());

  private EntitySerDeFactory() {}

  /**
   * Creates an instance of EntitySerDe.
   *
   * @param config The configuration object containing settings for EntitySerDe.
   * @return An instance of EntitySerDe.
   */
  public static EntitySerDe createEntitySerDe(Config config) {
    String name = config.get(Configs.ENTITY_SERDE);
    return createEntitySerDe(name);
  }

  /**
   * Creates an instance of EntitySerDe.
   *
   * @param name The short name identifying the EntitySerDe implementation.
   * @return An instance of EntitySerDe.
   * @throws RuntimeException If the EntitySerDe creation fails.
   */
  public static EntitySerDe createEntitySerDe(String name) {
    String className = ENTITY_SERDES.getOrDefault(name, name);

    try {
      return (EntitySerDe) Class.forName(className).newInstance();
    } catch (Exception e) {
      LOG.error("Failed to create EntitySerDe by name {}.", name, e);
      throw new RuntimeException("Failed to create EntitySerDe: " + name, e);
    }
  }
}