/****************************************************************
 * 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.james.mailbox.backup;

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

import org.apache.james.core.Username;
import org.apache.james.mailbox.exception.MailboxException;
import org.reactivestreams.Publisher;

public interface MailboxBackup {

    enum BackupStatus {
        NON_EMPTY_RECEIVER_ACCOUNT,
        FAILED,
        DONE
    }

    /**
     * @param username the user account to export
     */
    void backupAccount(Username username, OutputStream destination) throws IOException, MailboxException;

    /**
     * @param username   the user in which account the restored elements will be stored.
     * @param source the input stream to the archive containing the account elements.
     * @return a Publisher indicating when the action is completed
     */
    Publisher<BackupStatus> restore(Username username, InputStream source) throws IOException, MailboxException;

}
