omero.api

Interface _RawFileStoreOperationsNC

All Superinterfaces:

_ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperationsNC

All Known Subinterfaces:

RawFileStore

All Known Implementing Classes:

_RawFileStoreDisp, _RawFileStoreTie

public interface _RawFileStoreOperationsNC
extends _StatefulServiceInterfaceOperationsNC

Raw file gateway which provides access to the OMERO file repository. Note: methods on this service are protected by a DOWNLOAD restriction.

Method Summary

Modifier and Type	Method and Description
void	exists_async(AMD_RawFileStore_exists __cb) Checks to see if a raw file exists with the file ID that the service was initialized with.
void	getFileId_async(AMD_RawFileStore_getFileId __cb) Returns the current file id or null if none has been set.
void	read_async(AMD_RawFileStore_read __cb, long position, int length) Reads length bytes of data at the position from the raw file into an array of bytes.
void	save_async(AMD_RawFileStore_save __cb) Saves the OriginalFile associated with the service if it has been modified.
void	setFileId_async(AMD_RawFileStore_setFileId __cb, long fileId) This method manages the state of the service.
void	size_async(AMD_RawFileStore_size __cb) Returns the size of the file on disk (not as stored in the database since that value will only be updated on save.
void	truncate_async(AMD_RawFileStore_truncate __cb, long length) Limits the size of a file to the given length.
void	write_async(AMD_RawFileStore_write __cb, byte[] buf, long position, int length) Writes length bytes of data from the specified buf byte array starting at at position to the raw file.

Methods inherited from interface omero.api._StatefulServiceInterfaceOperationsNC

activate_async, close_async, getCurrentEventContext_async, passivate_async

Method Detail

setFileId_async

void setFileId_async(AMD_RawFileStore_setFileId __cb,
                     long fileId)
              throws ServerError

This method manages the state of the service. This method will throw a SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions.BINARYACCESS restriction is in place.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getFileId_async

void getFileId_async(AMD_RawFileStore_getFileId __cb)
              throws ServerError

Returns the current file id or null if none has been set.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

read_async

void read_async(AMD_RawFileStore_read __cb,
                long position,
                int length)
         throws ServerError

Reads length bytes of data at the position from the raw file into an array of bytes.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

size_async

void size_async(AMD_RawFileStore_size __cb)
         throws ServerError

Returns the size of the file on disk (not as stored in the database since that value will only be updated on save. If the file has not yet been written to, and therefore does not exist, a ResourceError will be thrown.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

truncate_async

void truncate_async(AMD_RawFileStore_truncate __cb,
                    long length)
             throws ServerError

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.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

write_async

void write_async(AMD_RawFileStore_write __cb,
                 byte[] buf,
                 long position,
                 int length)
          throws ServerError

Writes length bytes of data from the specified buf byte array starting at at position to the raw file.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

exists_async

void exists_async(AMD_RawFileStore_exists __cb)
           throws ServerError

Checks to see if a raw file exists with the file ID that the service was initialized with.

Parameters:

__cb - The callback object for the operation.

Throws:

ResourceError - if there is a problem accessing the file due to permissions errors within the repository or any other I/O error.

ServerError

save_async

void save_async(AMD_RawFileStore_save __cb)
         throws ServerError

Saves the OriginalFile associated with the service if it has been modified. The returned valued should replace all instances of the OriginalFile in the client. If save has not been called, RawFileStore instances will save the OriginalFile object associated with it on close. See also ticket 1651 and ticket 2161.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError