org.apache.pulsar.common.protocol.schema.SchemaStorage Maven / Gradle / Ivy

Go to download
/*
 * 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.pulsar.common.protocol.schema;

import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.function.Function;
import org.apache.pulsar.shade.org.apache.commons.lang3.tuple.Pair;

/**
 * Schema storage.
 */
public interface SchemaStorage {

    CompletableFuture put(String key, byte[] value, byte[] hash);

    /**
     * Put the schema to the schema storage.
     *
     * @param key The schema ID
     * @param fn The function to calculate the value and hash that need to put to the schema storage
     *           The input of the function is all the existing schemas that used to do the schemas compatibility check
     * @return The schema version of the stored schema
     */
    default CompletableFuture put(String key,
             Function>>,
                     CompletableFuture>> fn) {
        return fn.apply(getAll(key)).thenCompose(pair -> put(key, pair.getLeft(), pair.getRight()));
    }

    CompletableFuture get(String key, SchemaVersion version);

    CompletableFuture>> getAll(String key);

    CompletableFuture delete(String key, boolean forcefully);

    CompletableFuture delete(String key);

    SchemaVersion versionFromBytes(byte[] version);

    void start() throws Exception;

    void close() throws Exception;

}