iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/pipe/plugin/meta/PipePluginMeta.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.iotdb.commons.pipe.plugin.meta;

import org.apache.iotdb.tsfile.utils.PublicBAOS;
import org.apache.iotdb.tsfile.utils.ReadWriteIOUtils;

import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.ByteBuffer;
import java.util.Objects;

public class PipePluginMeta {

  private final String pluginName;
  private final String className;

  // jarName and jarMD5 are used to identify the jar file.
  // they could be null if the plugin is built-in. they should be both null or both not null.
  private final boolean isBuiltin;
  private final String jarName;
  private final String jarMD5;

  public PipePluginMeta(
      String pluginName, String className, boolean isBuiltin, String jarName, String jarMD5) {
    this.pluginName = Objects.requireNonNull(pluginName).toUpperCase();
    this.className = Objects.requireNonNull(className);

    this.isBuiltin = isBuiltin;
    if (isBuiltin) {
      this.jarName = jarName;
      this.jarMD5 = jarMD5;
    } else {
      this.jarName = Objects.requireNonNull(jarName);
      this.jarMD5 = Objects.requireNonNull(jarMD5);
    }
  }

  public PipePluginMeta(String pluginName, String className) {
    this.pluginName = Objects.requireNonNull(pluginName).toUpperCase();
    this.className = Objects.requireNonNull(className);

    this.isBuiltin = true;
    this.jarName = null;
    this.jarMD5 = null;
  }

  public boolean isBuiltin() {
    return isBuiltin;
  }

  public String getPluginName() {
    return pluginName;
  }

  public String getClassName() {
    return className;
  }

  public String getJarName() {
    return jarName;
  }

  public String getJarMD5() {
    return jarMD5;
  }

  public ByteBuffer serialize() throws IOException {
    PublicBAOS byteArrayOutputStream = new PublicBAOS();
    DataOutputStream outputStream = new DataOutputStream(byteArrayOutputStream);
    serialize(outputStream);
    return ByteBuffer.wrap(byteArrayOutputStream.getBuf(), 0, byteArrayOutputStream.size());
  }

  public void serialize(DataOutputStream outputStream) throws IOException {
    ReadWriteIOUtils.write(pluginName, outputStream);
    ReadWriteIOUtils.write(className, outputStream);
    ReadWriteIOUtils.write(isBuiltin, outputStream);
    ReadWriteIOUtils.write(jarName, outputStream);
    ReadWriteIOUtils.write(jarMD5, outputStream);
  }

  public static PipePluginMeta deserialize(ByteBuffer byteBuffer) {
    final String pluginName = ReadWriteIOUtils.readString(byteBuffer);
    final String className = ReadWriteIOUtils.readString(byteBuffer);
    final boolean isBuiltin = ReadWriteIOUtils.readBool(byteBuffer);
    final String jarName = ReadWriteIOUtils.readString(byteBuffer);
    final String jarMD5 = ReadWriteIOUtils.readString(byteBuffer);
    return new PipePluginMeta(pluginName, className, isBuiltin, jarName, jarMD5);
  }

  public static PipePluginMeta deserialize(InputStream inputStream) throws IOException {
    return deserialize(
        ByteBuffer.wrap(ReadWriteIOUtils.readBytesWithSelfDescriptionLength(inputStream)));
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null || getClass() != obj.getClass()) {
      return false;
    }
    PipePluginMeta that = (PipePluginMeta) obj;
    return pluginName.equals(that.pluginName)
        && className.equals(that.className)
        && isBuiltin == that.isBuiltin
        && Objects.equals(jarName, that.jarName)
        && Objects.equals(jarMD5, that.jarMD5);
  }

  @Override
  public int hashCode() {
    return pluginName.hashCode();
  }

  @Override
  public String toString() {
    return "PipePluginMeta{"
        + "pluginName='"
        + pluginName
        + '\''
        + ", className='"
        + className
        + '\''
        + ", isBuiltin="
        + isBuiltin
        + ", jarName='"
        + jarName
        + '\''
        + ", jarMD5='"
        + jarMD5
        + '\''
        + '}';
  }
}