org.opensearch.common.StreamContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation
OpenSearch subproject :server
There is a newer version: 2.18.0
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

package org.opensearch.common;

import org.opensearch.common.io.InputStreamContainer;

import java.io.IOException;

/**
 * StreamContext is used to supply streams to vendor plugins using {@link StreamContext#provideStream}
 *
 * @opensearch.internal
 */
public class StreamContext {

    private final CheckedTriFunction streamSupplier;
    private final long partSize;
    private final long lastPartSize;
    private final int numberOfParts;

    /**
     * Construct a new StreamProvider object
     *
     * @param streamSupplier A {@link CheckedTriFunction} that will be called with the partNumber, partSize and position in the stream
     * @param partSize Size of all parts apart from the last one
     * @param lastPartSize Size of the last part
     * @param numberOfParts Total number of parts
     */
    public StreamContext(
        CheckedTriFunction streamSupplier,
        long partSize,
        long lastPartSize,
        int numberOfParts
    ) {
        this.streamSupplier = streamSupplier;
        this.partSize = partSize;
        this.lastPartSize = lastPartSize;
        this.numberOfParts = numberOfParts;
    }

    /**
     * Copy constructor for overriding class
     */
    protected StreamContext(StreamContext streamContext) {
        this.streamSupplier = streamContext.streamSupplier;
        this.partSize = streamContext.partSize;
        this.numberOfParts = streamContext.numberOfParts;
        this.lastPartSize = streamContext.lastPartSize;
    }

    /**
     * Vendor plugins can use this method to create new streams only when they are required for processing
     * New streams won't be created till this method is called with the specific partNumber
     * It is the responsibility of caller to ensure that stream is properly closed after consumption
     * otherwise it can leak resources.
     *
     * @param partNumber The index of the part
     * @return A stream reference to the part requested
     */
    public InputStreamContainer provideStream(int partNumber) throws IOException {
        long position = partSize * partNumber;
        long size = (partNumber == numberOfParts - 1) ? lastPartSize : partSize;
        return streamSupplier.apply(partNumber, size, position);
    }

    /**
     * @return The number of parts in which this file is supposed to be uploaded
     */
    public int getNumberOfParts() {
        return numberOfParts;
    }
}