RawFileStore.java

/*
 *   Copyright 2006 University of Dundee. All rights reserved.
 *   Use is subject to license terms supplied in LICENSE.txt
 */

package ome.api;

import ome.conditions.ResourceError;
import ome.model.core.OriginalFile;

/**
 * Raw file gateway which provides access to the OMERO file repository.
 * 
 * @author Chris Allan     
 *         <a href="mailto:callan@blackcat.ca">callan@blackcat.ca</a>
 * @version 3.0
 * @since OMERO3.0
 */
public interface RawFileStore extends StatefulServiceInterface {

    /**
     * Returns the current file id or null if none has been set.
     */
    public Long getFileId();

    /**
     * This method manages the state of the service. If the given file
     * is not considered DOWNLOADABLE, this method will throw a
     * {@link ome.conditions.SecurityViolation}.
     * 
     * @param fileId
     *            an {@link ome.model.core.OriginalFile} id.
     */
    public void setFileId(long fileId);
    
    /**
     * Checks to see if a raw file exists with the file ID that the service was
     * initialized with.
     * @return <code>true</code> if there is an accessible file within the
     * original file repository with the correct ID. Otherwise
     * <code>false</code>.
     * @throws ResourceError if there is a problem accessing the file due to
     * permissions errors within the repository or any other I/O error.
     */
    public boolean exists();

    /**
     * Reads {@code length} bytes of data at the {@code position} from the raw
     * file into an array of bytes
     */
    public byte[] read(long position, int length);

    /**
     * Returns the size of the file on disk (not as stored in the database since
     * that value will only be updated on {@link #save()}. If the file has not
     * yet been written to, and therefore does not exist, a
     * {@link ome.conditions.ResourceError} will be thrown.
     */
    public long size();

    /**
     * Limits the size of a file to the given length. If the file is already
     * shorter than length, no action is taken in which case false is returned.
     */
    public boolean truncate(long length);

    /**
     * Writes {@code length} bytes of data from the specified {@code buf} byte
     * array starting at at {@code position} to the raw file
     */
    public void write(byte[] buf, long position, int length);

    /**
     * Saves the {@link OriginalFile} associated with the service if it has
     * been modified. The returned valued should replace all instances of the
     * {@link OriginalFile} in the client.
     *
     * If save has not been called, {@link RawFileStore} instances will save the
     * {@link OriginalFile} object associated with it on {@link #close()}.
     *
     * @see <a href="https://trac.openmicroscopy.org/ome/ticket/1651>1651</a>
     * @see <a href="https://trac.openmicroscopy.org/ome/ticket/2161>2161</a>
     */
    public OriginalFile save();
}