asterixdb/asterix-cloud/src/main/java/org/apache/asterix/cloud/clients/ICloudBufferedWriter.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.asterix.cloud.clients;

import java.io.InputStream;
import java.nio.ByteBuffer;

import org.apache.hyracks.api.exceptions.HyracksDataException;

public interface ICloudBufferedWriter {

    /**
     * Uploads input stream content
     *
     * @param stream stream
     * @param length length
     */
    void upload(InputStream stream, int length) throws HyracksDataException;

    /**
     * Upload the last content of the stream or buffer depending on whether a previous part was uploaded
     *
     * @param stream stream
     * @param buffer buffer (should be used instead of stream if no previous bytes were written)
     */
    void uploadLast(InputStream stream, ByteBuffer buffer) throws HyracksDataException;

    /**
     * Checks whether the writer has not written anything
     *
     * @return true if nothing was written, false otherwise
     */
    boolean isEmpty();

    /**
     * Finishes the upload
     *
     * @throws HyracksDataException HyracksDataException
     */
    void finish() throws HyracksDataException;

    /**
     * Aborts the upload
     *
     * @throws HyracksDataException HyracksDataException
     */
    void abort() throws HyracksDataException;
}