org.javaswift.joss.headers.object.range.AbstractRange Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of joss Show documentation

OpenCADC Java Openstack Swift Storage JOSS (temporary fork)

The newest version!

package org.javaswift.joss.headers.object.range;

import java.util.Arrays;

import org.javaswift.joss.headers.Header;

/**
 * Offers the option to return not the entire object, but only a designated part. The various options are
 * 
 *     {@link ExcludeStartRange} - take the object starting from position x until the end
 *     {@link FirstPartRange} - take the first x bytes of the object, starting at position 0
 *     {@link MidPartRange} - take the object from offset for a certain length
 *     {@link LastPartRange} - take the last x bytes, starting at the end minus x until the end
 * 
 * Also see: http://docs.openstack.org/api/openstack-object-storage/1.0/content/retrieve-object.html
 */
public abstract class AbstractRange extends Header {

    public String RANGE_HEADER_NAME = "Range";
    public String RANGE_HEADER_VALUE_PREFIX = "bytes=";

    protected long offset;

    protected long length;

    protected AbstractRange(long offset, long length) {
        this.offset = offset;
        this.length = length;
    }

    public String getHeaderValue() {
        return
            RANGE_HEADER_VALUE_PREFIX+
                (offset >= 0 ? Long.toString(offset) : "") +
                "-" +
                (length >= 0 ? Long.toString(length) : "");
    }

    public String getHeaderName() {
        return RANGE_HEADER_NAME;
    }

    public abstract long getFrom(int byteArrayLength);

    public abstract long getTo(int byteArrayLength);

    // Only used by mock Swift
    public byte[] copy(byte[] original) {
        return Arrays.copyOfRange(original, (int)getFrom(original.length), (int)getTo(original.length));
    }
}