omero.api

Class _RawFileStoreDisp

java.lang.Object

Ice.ObjectImpl

omero.api._RawFileStoreDisp

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, _RawFileStoreOperations, _RawFileStoreOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperations, _StatefulServiceInterfaceOperationsNC, RawFileStore, ServiceInterface, StatefulServiceInterface

Direct Known Subclasses:

_RawFileStoreTie

public abstract class _RawFileStoreDisp
extends Ice.ObjectImpl
implements RawFileStore

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	__ids
static long	serialVersionUID

Fields inherited from interface omero.api.RawFileStore

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_RawFileStoreDisp()

Method Summary

Modifier and Type	Method and Description
static Ice.DispatchStatus	___exists(RawFileStore __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getFileId(RawFileStore __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___read(RawFileStore __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___save(RawFileStore __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setFileId(RawFileStore __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___size(RawFileStore __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___truncate(RawFileStore __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___write(RawFileStore __obj, IceInternal.Incoming __inS, Ice.Current __current)
Ice.DispatchStatus	__dispatch(IceInternal.Incoming in, Ice.Current __current)
protected void	__readImpl(IceInternal.BasicStream __is)
protected void	__writeImpl(IceInternal.BasicStream __os)
void	activate_async(AMD_StatefulServiceInterface_activate __cb) Load a service implementation from disk if it was previously passivated.
void	close_async(AMD_StatefulServiceInterface_close __cb) Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter.
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	getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb) To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.
void	getFileId_async(AMD_RawFileStore_getFileId __cb) Returns the current file id or null if none has been set.
protected void	ice_copyStateFrom(Ice.Object __obj)
java.lang.String	ice_id()
java.lang.String	ice_id(Ice.Current __current)
java.lang.String[]	ice_ids()
java.lang.String[]	ice_ids(Ice.Current __current)
boolean	ice_isA(java.lang.String s)
boolean	ice_isA(java.lang.String s, Ice.Current __current)
static java.lang.String	ice_staticId()
void	passivate_async(AMD_StatefulServiceInterface_passivate __cb) Causes the blitz server to store the service implementation to disk to free memory.
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 class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

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

Methods inherited from interface omero.api._RawFileStoreOperations

exists_async, getFileId_async, read_async, save_async, setFileId_async, size_async, truncate_async, write_async

Methods inherited from interface omero.api._StatefulServiceInterfaceOperations

activate_async, close_async, getCurrentEventContext_async, passivate_async

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

__ids

public static final java.lang.String[] __ids

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_RawFileStoreDisp

public _RawFileStoreDisp()

Method Detail

ice_copyStateFrom

protected void ice_copyStateFrom(Ice.Object __obj)
                          throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

ice_isA

public boolean ice_isA(java.lang.String s)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids()

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids(Ice.Current __current)

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id()

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id(Ice.Current __current)

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

exists_async

public final 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.

Specified by:

exists_async in interface _RawFileStoreOperationsNC

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

getFileId_async

public final void getFileId_async(AMD_RawFileStore_getFileId __cb)
                           throws ServerError

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

Specified by:

getFileId_async in interface _RawFileStoreOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

read_async

public final 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.

Specified by:

read_async in interface _RawFileStoreOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

save_async

public final 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.

Specified by:

save_async in interface _RawFileStoreOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

setFileId_async

public final 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.

Specified by:

setFileId_async in interface _RawFileStoreOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

size_async

public final 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.

Specified by:

size_async in interface _RawFileStoreOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

truncate_async

public final 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.

Specified by:

truncate_async in interface _RawFileStoreOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

write_async

public final 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.

Specified by:

write_async in interface _RawFileStoreOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

activate_async

public final void activate_async(AMD_StatefulServiceInterface_activate __cb)
                          throws ServerError

Load a service implementation from disk if it was previously passivated. It is unnecessary to call this method since activation happens automatically, but calling this may prevent a short lapse when the service is first accessed after passivation. It is safe to call this method at any time, even when the service is not passivated.

Specified by:

activate_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

close_async

public final void close_async(AMD_StatefulServiceInterface_close __cb)
                       throws ServerError

Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter. Any further method calls will fail with a Ice::NoSuchObjectException. Note: with JavaEE, the close method was called publicly, and internally this called destroy(). As of the OmeroBlitz migration, this functionality has been combined.

Specified by:

close_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getCurrentEventContext_async

public final void getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb)
                                        throws ServerError

To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.

Specified by:

getCurrentEventContext_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

passivate_async

public final void passivate_async(AMD_StatefulServiceInterface_passivate __cb)
                           throws ServerError

Causes the blitz server to store the service implementation to disk to free memory. This is typically done automatically by the server when a pre-defined memory limit is reached, but can be used by the client if it clear that a stateful service will not be used for some time. Activation will happen automatically whether passivation was done manually or automatically.

Specified by:

passivate_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

___setFileId

public static Ice.DispatchStatus ___setFileId(RawFileStore __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___getFileId

public static Ice.DispatchStatus ___getFileId(RawFileStore __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___read

public static Ice.DispatchStatus ___read(RawFileStore __obj,
                                         IceInternal.Incoming __inS,
                                         Ice.Current __current)

___size

public static Ice.DispatchStatus ___size(RawFileStore __obj,
                                         IceInternal.Incoming __inS,
                                         Ice.Current __current)

___truncate

public static Ice.DispatchStatus ___truncate(RawFileStore __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___write

public static Ice.DispatchStatus ___write(RawFileStore __obj,
                                          IceInternal.Incoming __inS,
                                          Ice.Current __current)

___exists

public static Ice.DispatchStatus ___exists(RawFileStore __obj,
                                           IceInternal.Incoming __inS,
                                           Ice.Current __current)

___save

public static Ice.DispatchStatus ___save(RawFileStore __obj,
                                         IceInternal.Incoming __inS,
                                         Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:

__dispatch in interface Ice.Object

Overrides:

__dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:

__writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:

__readImpl in class Ice.ObjectImpl