omero.api

Class _IRepositoryInfoDisp

java.lang.Object

Ice.ObjectImpl

omero.api._IRepositoryInfoDisp

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, _IRepositoryInfoOperations, _IRepositoryInfoOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, IRepositoryInfo, ServiceInterface

Direct Known Subclasses:

_IRepositoryInfoTie

public abstract class _IRepositoryInfoDisp
extends Ice.ObjectImpl
implements IRepositoryInfo

Provides methods for obtaining information for server repository disk space allocation. Could be used generically to obtain usage information for any mount point, however, this interface is prepared for the API to provide methods to obtain usage info for the server filesystem containing the image uploads. For the OMERO server base this is /OMERO. For this implementation it could be anything e.g. /Data1. Methods that fail or cannot execute on the server will throw an InternalException. This would not be normal and would indicate some server or disk failure.

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.IRepositoryInfo

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_IRepositoryInfoDisp()

Method Summary

Modifier and Type	Method and Description
static Ice.DispatchStatus	___getFreeSpaceInKilobytes(IRepositoryInfo __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getUsageFraction(IRepositoryInfo __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getUsedSpaceInKilobytes(IRepositoryInfo __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___removeUnusedFiles(IRepositoryInfo __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___sanityCheckRepository(IRepositoryInfo __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	getFreeSpaceInKilobytes_async(AMD_IRepositoryInfo_getFreeSpaceInKilobytes __cb) Returns the free or available space on this file system including nested subdirectories.
void	getUsageFraction_async(AMD_IRepositoryInfo_getUsageFraction __cb) Returns a double of the used space divided by the free space.
void	getUsedSpaceInKilobytes_async(AMD_IRepositoryInfo_getUsedSpaceInKilobytes __cb) Returns the total space in bytes for this file system including nested subdirectories.
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	removeUnusedFiles_async(AMD_IRepositoryInfo_removeUnusedFiles __cb) Removes all files from the server that do not have an OriginalFile complement in the database, all the Pixels that do not have a complement in the database and all the Thumbnail's that do not have a complement in the database.
void	sanityCheckRepository_async(AMD_IRepositoryInfo_sanityCheckRepository __cb) Checks that image data repository has not exceeded 95% disk space use level.

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._IRepositoryInfoOperations

getFreeSpaceInKilobytes_async, getUsageFraction_async, getUsedSpaceInKilobytes_async, removeUnusedFiles_async, sanityCheckRepository_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

_IRepositoryInfoDisp

public _IRepositoryInfoDisp()

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()

getFreeSpaceInKilobytes_async

public final void getFreeSpaceInKilobytes_async(AMD_IRepositoryInfo_getFreeSpaceInKilobytes __cb)
                                         throws ServerError

Returns the free or available space on this file system including nested subdirectories.

Specified by:

getFreeSpaceInKilobytes_async in interface _IRepositoryInfoOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ResourceError - If there is a problem retrieving disk space free.

ServerError

getUsageFraction_async

public final void getUsageFraction_async(AMD_IRepositoryInfo_getUsageFraction __cb)
                                  throws ServerError

Returns a double of the used space divided by the free space. This method will be called by a client to watch the repository filesystem so that it doesn't exceed 95% full.

Specified by:

getUsageFraction_async in interface _IRepositoryInfoOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ResourceError - If there is a problem calculating the usage fraction.

ServerError

getUsedSpaceInKilobytes_async

public final void getUsedSpaceInKilobytes_async(AMD_IRepositoryInfo_getUsedSpaceInKilobytes __cb)
                                         throws ServerError

Returns the total space in bytes for this file system including nested subdirectories.

Specified by:

getUsedSpaceInKilobytes_async in interface _IRepositoryInfoOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ResourceError - If there is a problem retrieving disk space used.

ServerError

removeUnusedFiles_async

public final void removeUnusedFiles_async(AMD_IRepositoryInfo_removeUnusedFiles __cb)
                                   throws ServerError

Removes all files from the server that do not have an OriginalFile complement in the database, all the Pixels that do not have a complement in the database and all the Thumbnail's that do not have a complement in the database.

Specified by:

removeUnusedFiles_async in interface _IRepositoryInfoOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ResourceError - If deletion fails.

ServerError

sanityCheckRepository_async

public final void sanityCheckRepository_async(AMD_IRepositoryInfo_sanityCheckRepository __cb)
                                       throws ServerError

Checks that image data repository has not exceeded 95% disk space use level.

Specified by:

sanityCheckRepository_async in interface _IRepositoryInfoOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ResourceError - If the repository usage has exceeded 95%.

InternalException - If there is a critical failure while sanity checking the repository.

ServerError

___getUsedSpaceInKilobytes

public static Ice.DispatchStatus ___getUsedSpaceInKilobytes(IRepositoryInfo __obj,
                                                            IceInternal.Incoming __inS,
                                                            Ice.Current __current)

___getFreeSpaceInKilobytes

public static Ice.DispatchStatus ___getFreeSpaceInKilobytes(IRepositoryInfo __obj,
                                                            IceInternal.Incoming __inS,
                                                            Ice.Current __current)

___getUsageFraction

public static Ice.DispatchStatus ___getUsageFraction(IRepositoryInfo __obj,
                                                     IceInternal.Incoming __inS,
                                                     Ice.Current __current)

___sanityCheckRepository

public static Ice.DispatchStatus ___sanityCheckRepository(IRepositoryInfo __obj,
                                                          IceInternal.Incoming __inS,
                                                          Ice.Current __current)

___removeUnusedFiles

public static Ice.DispatchStatus ___removeUnusedFiles(IRepositoryInfo __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