ome.services

Class RawFileBean

java.lang.Object

ome.services.AbstractStatefulBean

ome.services.RawFileBean

All Implemented Interfaces:

Serializable, RawFileStore, ServiceInterface, StatefulServiceInterface, SelfConfigurableService

@Transactional(readOnly=true)
public class RawFileBean
extends AbstractStatefulBean
implements RawFileStore

Raw file gateway which provides access to the OMERO file repository.

Since:

OMERO3.0

Author:

Chris Allan callan@blackcat.ca

See Also:

Serialized Form

Field Summary

Fields inherited from class ome.services.AbstractStatefulBean

iQuery, iUpdate, modified, sec

Constructor Summary

Constructors

Constructor and Description
RawFileBean() default constructor
RawFileBean(boolean checking) overridden to allow Spring to set boolean

Method Summary

Modifier and Type	Method and Description
void	activate() Completely restore this service for active use from whatever passivation it has implemented.
void	clean()
void	close() signals the end of the service lifecycle.
boolean	exists() Checks to see if a raw file exists with the file ID that the service was initialized with.
Long	getFileId() Returns the current file id or null if none has been set.
Class<? extends ServiceInterface>	getServiceInterface()
boolean	isDiskSpaceChecking() getter disk overflow checking
protected boolean	isModified() Extends the check of the AbstractStatefulBean.modified flag performed by super with an additional check of the actual file size against the value stored in the database
void	passivate() Perform whatever passivation is possible or throw an exception.
byte[]	read(long position, int length) Reads length bytes of data at the position from the raw file into an array of bytes
OriginalFile	save() Saves the OriginalFile associated with the service if it has been modified.
void	setAdminService(IAdmin admin)
void	setChecksumProviderFactory(ChecksumProviderFactory checksumProviderFactory) ChecksumProviderFactory Bean injector
void	setDiskSpaceChecking(boolean diskSpaceChecking) setter disk overflow checking
void	setFileId(long fileId) This method manages the state of the service.
void	setFileIdWithBuffer(long fileId, FileBuffer buffer)
void	setIRepositoryInfo(IRepositoryInfo iRepositoryInfo) Disk Space Usage service Bean injector
void	setOriginalFilesService(OriginalFilesService ioService) I/O service (OriginalFilesService) Bean injector.
long	size() Returns the size of the file on disk (not as stored in the database since that value will only be updated on RawFileStore.save().
boolean	truncate(long length) Limits the size of a file to the given length.
void	write(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 class ome.services.AbstractStatefulBean

getBeanHelper, getCurrentEventContext, modified, selfConfigure, setQueryService, setSecuritySystem, setUpdateService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ome.api.StatefulServiceInterface

getCurrentEventContext

Constructor Detail

RawFileBean

public RawFileBean()

default constructor

RawFileBean

public RawFileBean(boolean checking)

overridden to allow Spring to set boolean

Parameters:

checking -

Method Detail

getServiceInterface

public Class<? extends ServiceInterface> getServiceInterface()

Specified by:

getServiceInterface in interface SelfConfigurableService

setOriginalFilesService

public final void setOriginalFilesService(OriginalFilesService ioService)

I/O service (OriginalFilesService) Bean injector.

Parameters:

ioService - an OriginalFileService.

setIRepositoryInfo

public final void setIRepositoryInfo(IRepositoryInfo iRepositoryInfo)

Disk Space Usage service Bean injector

Parameters:

iRepositoryInfo - an IRepositoryInfo

setAdminService

public final void setAdminService(IAdmin admin)

setChecksumProviderFactory

public final void setChecksumProviderFactory(ChecksumProviderFactory checksumProviderFactory)

ChecksumProviderFactory Bean injector

Parameters:

checksumProviderFactory - a ChecksumProviderFactory

passivate

@Transactional(readOnly=true)
public void passivate()

Description copied from interface: StatefulServiceInterface

Perform whatever passivation is possible or throw an exception. A good passivation method will free up as much memory as possible, most likely by storing it to disk. A call to passivate should be safe even if the service is already passivated.

Specified by:

passivate in interface StatefulServiceInterface

activate

@Transactional(readOnly=true)
public void activate()

Description copied from interface: StatefulServiceInterface

Completely restore this service for active use from whatever passivation it has implemented. A call to activate should be safe even if the service is already activated.

Specified by:

activate in interface StatefulServiceInterface

isModified

protected boolean isModified()

Extends the check of the AbstractStatefulBean.modified flag performed by super with an additional check of the actual file size against the value stored in the database

Overrides:

isModified in class AbstractStatefulBean

save

@Transactional(readOnly=false)
public OriginalFile save()

Description copied from interface: RawFileStore

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 StatefulServiceInterface.close().

Specified by:

save in interface RawFileStore

See Also:

2161

close

@Transactional(readOnly=false)
public void close()

Description copied from interface: StatefulServiceInterface

signals the end of the service lifecycle. Resources such as Sessions can be released. All further calls will throw an exception.

Specified by:

close in interface StatefulServiceInterface

clean

public void clean()

getFileId

@Transactional(readOnly=true)
public Long getFileId()

Description copied from interface: RawFileStore

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

Specified by:

getFileId in interface RawFileStore

setFileId

@Transactional(readOnly=true)
public void setFileId(long fileId)

Description copied from interface: RawFileStore

This method manages the state of the service. If the given file is not considered DOWNLOADABLE, this method will throw a SecurityViolation.

Specified by:

setFileId in interface RawFileStore

Parameters:

fileId - an OriginalFile id.

setFileIdWithBuffer

public void setFileIdWithBuffer(long fileId,
                                FileBuffer buffer)

exists

public boolean exists()

Description copied from interface: RawFileStore

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

Specified by:

exists in interface RawFileStore

Returns:

true if there is an accessible file within the original file repository with the correct ID. Otherwise false.

read

public byte[] read(long position,
                   int length)

Description copied from interface: RawFileStore

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

Specified by:

read in interface RawFileStore

truncate

public boolean truncate(long length)

Description copied from interface: RawFileStore

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.

Specified by:

truncate in interface RawFileStore

size

public long size()

Description copied from interface: RawFileStore

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

Specified by:

size in interface RawFileStore

write

public void write(byte[] buf,
                  long position,
                  int length)

Description copied from interface: RawFileStore

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

Specified by:

write in interface RawFileStore

isDiskSpaceChecking

public boolean isDiskSpaceChecking()

getter disk overflow checking

Returns:

See above.

setDiskSpaceChecking

public void setDiskSpaceChecking(boolean diskSpaceChecking)

setter disk overflow checking

Parameters:

diskSpaceChecking - a boolean