stack/core/src/main/java/org/apache/usergrid/corepersistence/export/ExportService.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.usergrid.corepersistence.export;


import java.io.IOException;
import java.io.OutputStream;

/**
 * An interface for exporting all entities within an application
 */
public interface ExportService {


    /**
     * Perform an application export into the provided OutputStream
     *
     * @param exportRequestBuilder The builder to build the request
     */
    void export(final ExportRequestBuilder exportRequestBuilder, OutputStream stream) throws RuntimeException;


    /**
     * Generate a builder for the export request
     */
    ExportRequestBuilder getBuilder();


    enum Status{
        STARTED, INPROGRESS, COMPLETE, UNKNOWN;
    }
}