nl.tweeenveertig.openstack.instructions.UploadPayload Maven / Gradle / Ivy

Go to download

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

Java Client library for OpenStack Storage (Swift)

There is a newer version: 0.7.0

package nl.tweeenveertig.openstack.instructions;

import nl.tweeenveertig.openstack.headers.object.Etag;
import org.apache.http.HttpEntity;

import java.io.IOException;

/**
* Encapsulates the payload that must be uploaded to the ObjectStore. The reason this class exists
* is that it can support in giving information on the payload.
* @author Robert Bor
*/
public abstract class UploadPayload {

    /**
    * Returns the payload as an HttpEntity, so it can be uploaded to the ObjectStore
    * @return HttpEntity of the payload
    */
    public abstract HttpEntity getEntity();

    /**
    * Checks whether the payload must be segmented into two or more separate objects to circumvent
    * the max object size
    * @param segmentationSize size to check the current payload size against
    * @return true if the payload must be segmented
    */
    public abstract boolean mustBeSegmented(Long segmentationSize);

    /**
    * Returns the MD5 hash value in an Etag header
    * @return Etag header with MD5 hash
    */
    public abstract Etag getEtag() throws IOException;

    /**
    * Sets up the plan to upload the payload in segments
    * @param segmentationSize the size of an individual segment
    * @return the segmentation plan
    */
    public abstract SegmentationPlan getSegmentationPlan(Long segmentationSize) throws IOException;

}