SwapContents.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.controller.repository;

import java.util.List;

/**
 * When FlowFiles are constructed from a Swap File, there is information in addition to
 * the FlowFiles themselves that get stored and recovered. SwapContents provides a
 * mechanism to encapsulate all of the information contained within a Swap File in a
 * single object
 */
public interface SwapContents {

    /**
     * @return a summary of information included in a Swap File
     */
    SwapSummary getSummary();

    /**
     * @return the FlowFiles that are contained within a Swap File
     */
    List<FlowFileRecord> getFlowFiles();

}