/*
 * 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.minifi.commons.service;

import org.apache.nifi.controller.flow.VersionedDataflow;

/**
 * Defines interface methods used to implement a FlowPropertyEncryptor.
 * The purpose of a flow property encryptor is to encrypt sensitive properties in the flow using a particular strategy.
 */
public interface FlowPropertyEncryptor {

    /**
     * Responsible for encrypting sensitive properties in a VersionedDataflow instance
     *
     * @param flow a VersionedDataflow instance to encrypt its sensitive properties
     * @return VersionedDataflow the flow instance with encrypted sensitive properties
     */
    VersionedDataflow encryptSensitiveProperties(VersionedDataflow flow);
}
