nifi-commons/nifi-repository-encryption/src/main/java/org/apache/nifi/repository/encryption/metadata/RecordMetadataSerializer.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.nifi.repository.encryption.metadata;

import org.apache.nifi.repository.encryption.configuration.RepositoryEncryptionMethod;

/**
 * Serializer for Record Metadata
 */
public interface RecordMetadataSerializer {
    /**
     * Write Metadata to byte array
     *
     * @param keyId Key Identifier used for encryption
     * @param initializationVector Initialization Vector
     * @param length Length of encrypted binary
     * @param repositoryEncryptionMethod Repository Encryption Method
     * @return Serialized byte array
     */
    byte[] writeMetadata(String keyId, byte[] initializationVector, int length, RepositoryEncryptionMethod repositoryEncryptionMethod);
}