omero.api

Interface _IRepositoryInfoOperationsNC

All Superinterfaces:

_ServiceInterfaceOperationsNC

All Known Subinterfaces:

IRepositoryInfo

All Known Implementing Classes:

_IRepositoryInfoDisp, _IRepositoryInfoTie

public interface _IRepositoryInfoOperationsNC
extends _ServiceInterfaceOperationsNC

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.

Method Summary

Modifier and Type	Method and Description
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.
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.

Method Detail

getUsedSpaceInKilobytes_async

void getUsedSpaceInKilobytes_async(AMD_IRepositoryInfo_getUsedSpaceInKilobytes __cb)
                            throws ServerError

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

Parameters:

__cb - The callback object for the operation.

Throws:

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

ServerError

getFreeSpaceInKilobytes_async

void getFreeSpaceInKilobytes_async(AMD_IRepositoryInfo_getFreeSpaceInKilobytes __cb)
                            throws ServerError

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

Parameters:

__cb - The callback object for the operation.

Throws:

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

ServerError

getUsageFraction_async

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.

Parameters:

__cb - The callback object for the operation.

Throws:

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

ServerError

sanityCheckRepository_async

void sanityCheckRepository_async(AMD_IRepositoryInfo_sanityCheckRepository __cb)
                          throws ServerError

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

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

removeUnusedFiles_async

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.

Parameters:

__cb - The callback object for the operation.

Throws:

ResourceError - If deletion fails.

ServerError