omero.grid.monitors

Class _FileServerTie

java.lang.Object

Ice.ObjectImpl

omero.grid.monitors._FileServerDisp

omero.grid.monitors._FileServerTie

All Implemented Interfaces:

Ice.Object, Ice.TieBase, java.io.Serializable, java.lang.Cloneable, _FileServerOperations, _FileServerOperationsNC, FileServer

public class _FileServerTie
extends _FileServerDisp
implements Ice.TieBase

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class omero.grid.monitors._FileServerDisp

__ids

Fields inherited from interface omero.grid.monitors.FileServer

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_FileServerTie(_FileServerOperations delegate)
_FileServerTie()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object rhs)
boolean	fileExists(java.lang.String fileId, Ice.Current __current) Query the existence of a file An exception will be raised if the method fails to determine the existence.
float	getATime(java.lang.String fileId, Ice.Current __current) Get atime of a file An exception will be raised if the file no longer exists or is inaccessible.
java.lang.String	getBaseName(java.lang.String fileId, Ice.Current __current) Get base name of a file, this is the name stripped of any path, e.g.
FileStats[]	getBulkDirectory(java.lang.String absPath, java.lang.String filter, Ice.Current __current) Get an absolute directory from an OMERO.fs server.
float	getCTime(java.lang.String fileId, Ice.Current __current) Get ctime of a file An exception will be raised if the file no longer exists or is inaccessible.
java.lang.String[]	getDirectory(java.lang.String absPath, java.lang.String filter, Ice.Current __current) Get an absolute directory from an OMERO.fs server.
float	getMTime(java.lang.String fileId, Ice.Current __current) Get mtime of a file An exception will be raised if the file no longer exists or is inaccessible.
java.lang.String	getOwner(java.lang.String fileId, Ice.Current __current) Get owner of a file An exception will be raised if the file no longer exists or is inaccessible.
java.lang.String	getSHA1(java.lang.String fileId, Ice.Current __current) Get SHA1 of a file An exception will be raised if the file no longer exists or is inaccessible.
long	getSize(java.lang.String fileId, Ice.Current __current) Get size of a file in bytes An exception will be raised if the file no longer exists or is inaccessible.
FileStats	getStats(java.lang.String fileId, Ice.Current __current) Get all FileStats of a file An exception will be raised if the file no longer exists or is inaccessible.
int	hashCode()
java.lang.Object	ice_delegate()
void	ice_delegate(java.lang.Object delegate)
boolean	isDir(java.lang.String fileId, Ice.Current __current) Query whether file is a directory An exception will be raised if the file no longer exists or is inaccessible.
boolean	isFile(java.lang.String fileId, Ice.Current __current) Query whether file is a file An exception will be raised if the file no longer exists or is inaccessible.
byte[]	readBlock(java.lang.String fileId, long offset, int size, Ice.Current __current) readBlock should open, read size bytes from offset and then close the file.

Methods inherited from class omero.grid.monitors._FileServerDisp

___fileExists, ___getATime, ___getBaseName, ___getBulkDirectory, ___getCTime, ___getDirectory, ___getMTime, ___getOwner, ___getSHA1, ___getSize, ___getStats, ___isDir, ___isFile, ___readBlock, __dispatch, __readImpl, __writeImpl, fileExists, getATime, getBaseName, getBulkDirectory, getCTime, getDirectory, getMTime, getOwner, getSHA1, getSize, getStats, ice_copyStateFrom, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, isDir, isFile, readBlock

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

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_FileServerTie

public _FileServerTie()

_FileServerTie

public _FileServerTie(_FileServerOperations delegate)

Method Detail

ice_delegate

public java.lang.Object ice_delegate()

Specified by:

ice_delegate in interface Ice.TieBase

ice_delegate

public void ice_delegate(java.lang.Object delegate)

Specified by:

ice_delegate in interface Ice.TieBase

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

fileExists

public boolean fileExists(java.lang.String fileId,
                          Ice.Current __current)
                   throws OmeroFSError

Description copied from interface: _FileServerOperations

Query the existence of a file An exception will be raised if the method fails to determine the existence.

Specified by:

fileExists in interface _FileServerOperations

Parameters:

fileId - see above.

__current - The Current object for the invocation.

Returns:

existence of file.

Throws:

OmeroFSError

getATime

public float getATime(java.lang.String fileId,
                      Ice.Current __current)
               throws OmeroFSError

Description copied from interface: _FileServerOperations

Get atime of a file An exception will be raised if the file no longer exists or is inaccessible.

Specified by:

getATime in interface _FileServerOperations

Parameters:

fileId - see above.

__current - The Current object for the invocation.

Returns:

atime of file (float).

Throws:

OmeroFSError

getBaseName

public java.lang.String getBaseName(java.lang.String fileId,
                                    Ice.Current __current)
                             throws OmeroFSError

Description copied from interface: _FileServerOperations

Get base name of a file, this is the name stripped of any path, e.g. file.ext An exception will be raised if the file no longer exists or is inaccessible.

Specified by:

getBaseName in interface _FileServerOperations

Parameters:

fileId - see above.

__current - The Current object for the invocation.

Returns:

base name.

Throws:

OmeroFSError

getBulkDirectory

public FileStats[] getBulkDirectory(java.lang.String absPath,
                                    java.lang.String filter,
                                    Ice.Current __current)
                             throws OmeroFSError

Description copied from interface: _FileServerOperations

Get an absolute directory from an OMERO.fs server. The returned list will contain the file stats for each directory entry. An exception will be raised if the path does not exist or is inaccessible to the OMERO.fs server. An exception will be raised if directory list cannot be returned for any other reason.

Specified by:

getBulkDirectory in interface _FileServerOperations

Parameters:

absPath - an absolute path on the monitor's watch path (string).

filter - a filter to apply to the listing, cf. ls (string).

__current - The Current object for the invocation.

Returns:

a directory listing (FileStatsList).

Throws:

OmeroFSError

getCTime

public float getCTime(java.lang.String fileId,
                      Ice.Current __current)
               throws OmeroFSError

Description copied from interface: _FileServerOperations

Get ctime of a file An exception will be raised if the file no longer exists or is inaccessible.

Specified by:

getCTime in interface _FileServerOperations

Parameters:

fileId - see above.

__current - The Current object for the invocation.

Returns:

ctime of file (float).

Throws:

OmeroFSError

getDirectory

public java.lang.String[] getDirectory(java.lang.String absPath,
                                       java.lang.String filter,
                                       Ice.Current __current)
                                throws OmeroFSError

Description copied from interface: _FileServerOperations

Get an absolute directory from an OMERO.fs server. The returned list will contain just the file names for each directory entry. An exception will be raised if the path does not exist or is inaccessible to the OMERO.fs server. An exception will be raised if directory list cannot be returned for any other reason.

Specified by:

getDirectory in interface _FileServerOperations

Parameters:

absPath - an absolute path on the monitor's watch path (string).

filter - a filter to apply to the listing, cf. ls (string).

__current - The Current object for the invocation.

Returns:

a directory listing (Ice::StringSeq).

Throws:

OmeroFSError

getMTime

public float getMTime(java.lang.String fileId,
                      Ice.Current __current)
               throws OmeroFSError

Description copied from interface: _FileServerOperations

Get mtime of a file An exception will be raised if the file no longer exists or is inaccessible.

Specified by:

getMTime in interface _FileServerOperations

Parameters:

fileId - see above.

__current - The Current object for the invocation.

Returns:

mtime of file (float).

Throws:

OmeroFSError

getOwner

public java.lang.String getOwner(java.lang.String fileId,
                                 Ice.Current __current)
                          throws OmeroFSError

Description copied from interface: _FileServerOperations

Get owner of a file An exception will be raised if the file no longer exists or is inaccessible.

Specified by:

getOwner in interface _FileServerOperations

Parameters:

fileId - see above.

__current - The Current object for the invocation.

Returns:

owner of file (string).

Throws:

OmeroFSError

getSHA1

public java.lang.String getSHA1(java.lang.String fileId,
                                Ice.Current __current)
                         throws OmeroFSError

Description copied from interface: _FileServerOperations

Get SHA1 of a file An exception will be raised if the file no longer exists or is inaccessible. An exception will be raised if the SHA1 cannot be generated for any reason.

Specified by:

getSHA1 in interface _FileServerOperations

Parameters:

fileId - see above.

__current - The Current object for the invocation.

Returns:

SHA1 hex hash digest of file (string).

Throws:

OmeroFSError

getSize

public long getSize(java.lang.String fileId,
                    Ice.Current __current)
             throws OmeroFSError

Description copied from interface: _FileServerOperations

Get size of a file in bytes An exception will be raised if the file no longer exists or is inaccessible.

Specified by:

getSize in interface _FileServerOperations

Parameters:

fileId - see above.

__current - The Current object for the invocation.

Returns:

byte size of file (long).

Throws:

OmeroFSError

getStats

public FileStats getStats(java.lang.String fileId,
                          Ice.Current __current)
                   throws OmeroFSError

Description copied from interface: _FileServerOperations

Get all FileStats of a file An exception will be raised if the file no longer exists or is inaccessible.

Specified by:

getStats in interface _FileServerOperations

Parameters:

fileId - see above.

__current - The Current object for the invocation.

Returns:

file stats (FileStats).

Throws:

OmeroFSError

isDir

public boolean isDir(java.lang.String fileId,
                     Ice.Current __current)
              throws OmeroFSError

Description copied from interface: _FileServerOperations

Query whether file is a directory An exception will be raised if the file no longer exists or is inaccessible.

Specified by:

isDir in interface _FileServerOperations

Parameters:

fileId - see above.

__current - The Current object for the invocation.

Returns:

true is directory (bool).

Throws:

OmeroFSError

isFile

public boolean isFile(java.lang.String fileId,
                      Ice.Current __current)
               throws OmeroFSError

Description copied from interface: _FileServerOperations

Query whether file is a file An exception will be raised if the file no longer exists or is inaccessible.

Specified by:

isFile in interface _FileServerOperations

Parameters:

fileId - see above.

__current - The Current object for the invocation.

Returns:

true if file (bool).

Throws:

OmeroFSError

readBlock

public byte[] readBlock(java.lang.String fileId,
                        long offset,
                        int size,
                        Ice.Current __current)
                 throws OmeroFSError

Description copied from interface: _FileServerOperations

readBlock should open, read size bytes from offset and then close the file. An exception will be raised if the file no longer exists or is inaccessible. An exception will be raised if the file read fails for any other reason.

Specified by:

readBlock in interface _FileServerOperations

Parameters:

fileId - see above.

offset - byte offset into file from where read should begin (long).

size - number of bytes that should be read (int).

__current - The Current object for the invocation.

Returns:

byte sequence of upto size bytes.

Throws:

OmeroFSError