/*
 * 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.nifi.schemaregistry.services;

import org.apache.nifi.controller.ControllerService;
import org.apache.nifi.schema.access.SchemaField;
import org.apache.nifi.schema.access.SchemaNotFoundException;
import org.apache.nifi.serialization.record.SchemaIdentifier;

import java.io.IOException;
import java.io.InputStream;
import java.util.Map;
import java.util.Set;

/**
 * Service interface responsible for reading Schema Identifier reference information based on attributes or encoded content information
 */
public interface SchemaReferenceReader extends ControllerService {
    /**
     * Get Schema Identifier
     *
     * @param variables Map of variables for Schema Identifier resolution can be null or empty
     * @param contentStream Stream of FlowFile content that may contain encoded Schema Identifier references
     * @return Schema Identifier
     * @throws IOException Thrown on failure to read input content stream
     * @throws SchemaNotFoundException Thrown on failure to find expected Schema Identifier information
     */
    SchemaIdentifier getSchemaIdentifier(Map<String, String> variables, InputStream contentStream) throws IOException, SchemaNotFoundException;

    /**
     * Get supplied Record Schema Fields for validation against the set of Record Schema Fields required for writing schema information
     *
     * @return Supplied Record Schema Fields
     */
    Set<SchemaField> getSuppliedSchemaFields();
}
