|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface RemoteConfigurationCache
This interface defines methods to manage cache configuration of a server remotely.
| Method Summary | |
|---|---|
void |
appendImage(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
Appends an image to be cached, |
long |
getAnImageSize(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
Gets an image size in the memory. |
java.util.Vector |
getCachedCatalogs()
Returns the file names of the catalog to be cached. |
java.util.Vector |
getCachedImages()
Return the file names of images to be cached. |
java.util.Vector |
getCachedReports()
Returns the file names of the reports to cache. |
java.util.Vector |
getCachedReportsWithStyles()
Returns the file names and styles of the reports to cache. |
int |
getCRDMemoryUsage()
Gets the CRD memory usage. |
boolean |
getDisplayImageDetail()
Returns whether to display cached images details. |
boolean |
getEnableCacheCatelog()
Returns whether to cache catalogs. |
boolean |
getEnableCacheImage()
Returns whether to cache images. |
boolean |
getEnableCacheReport()
Returns whether to cache reports. |
int |
getEngineSortBufferSize()
Gets the size of the engine sort buffer from the configuration properties. |
long |
getExpiredTime()
Gets the expired time of the automatic cached data. |
java.lang.String |
getImageBelongedCatalog(java.lang.String fullImagePath)
Gets the catalog which the set image belongs to |
int |
getMaxCacheCatalogSize()
Returns the maximum number of catalogs to be cached. |
int |
getMaxCacheImageSize()
Returns the maximum number of images to be cached. |
int |
getMaxCacheReportSize()
Returns the maximum number of reports to be cached. |
double |
getMaxCubeMemory()
Returns Maximum Cube Memory Allowed, unit is MB. |
int |
getMaxDiskUsage()
Gets the maximum hard disk space which is used for automatic cached data. |
int |
getSecurityCacheExpireTime()
Gets the security cache item expired time. |
int |
getSecurityGroupCacheSize()
Gets the security group cache's size. |
int |
getSecurityProectionCacheSize()
Gets the security protection cache's size. |
int |
getSecurityRoleCacheSize()
Gets the security role cache's size. |
int |
getSecurityUserCacheSize()
Gets the security user cache's size. |
long |
getUsedImageCacheSize()
Gets the used image cache size. |
boolean |
isAutoCache()
Whether automatic cache is enabled |
boolean |
isCacheAllImages()
Whether all images are cached. |
boolean |
isLockedImage(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
Whether an image is locked. |
boolean |
isNeverExpire()
Whether automatic cached data never expires |
void |
loadProperties()
Sets the properties of the server. |
boolean |
lockCachedImage(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
Locks a cached image. |
void |
removeAllImages()
Removes all images. |
void |
removeImage(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
Removes an images. |
void |
saveProperties()
Saves the modified setting to the configuration file (server.properties). |
void |
setCacheAllImages(boolean isCacheAllImages)
Sets whether all images are cached. |
boolean |
setCachedCatalogs(java.lang.String user,
java.util.Vector cachedCatalogs)
Sets the file names of catalogs to be cached. |
boolean |
setCachedCatalogs(java.util.Vector cachedCatalogs)
Sets the file names of catalogs to be cached. |
boolean |
setCachedReports(java.util.Vector cachedReports)
Sets the file names of the reports to cache. |
boolean |
setCachedReportsWithStyles(java.lang.String user,
java.util.Vector cachedReportsWithStyles)
Sets the file names and styles of the reports to cache. |
boolean |
setCachedReportsWithStyles(java.util.Vector cachedReportsWithStyles)
Sets the file names and styles of the reports to cache. |
void |
setCRDMemoryUsage(int maxMemoryUsage)
Sets the CRD memory usage. |
void |
setDisplayImageDetail(boolean isDisplay)
Sets whether to display cached images details. |
void |
setEnableAutoCache(boolean isEnableAutoCache)
Enables/disables automatic cache. |
void |
setEnableCacheCatelog(boolean isEnableCacheCatelog)
Sets whether to cache catalogs. |
void |
setEnableCacheImage(boolean isEnableCacheImage)
Sets whether to cache images. |
void |
setEnableCacheReport(boolean isEnableCacheReport)
Sets whether to cache reports. |
void |
setEngineSortBufferSize(int size)
Sets the size of the engine sort buffer. |
void |
setExpiredTime(long expiredTime)
Sets the expired time of the automatic cached data. |
void |
setMaxCacheCatalogSize(int maxCacheCatalog)
Sets the maximum number of catalogs to be cached. |
void |
setMaxCacheImageSize(int maxCacheImage)
Sets the maximum number of images to be cached. |
void |
setMaxCacheReportSize(int maxCacheReport)
Sets the maximum number of reports to be cached. |
void |
setMaxCubeMemory(double memorySize)
Sets Maximum Cube Memory Allowed, unit is MB. |
void |
setMaxDiskUsage(int maxDiskUsage)
Sets the maximum hard disk space which is used for automatic cached data. |
void |
setNeverExpire(boolean isNeverExpire)
Sets whether automatic cached data never expires. |
void |
setSecurityCacheExpireTime(int size)
Sets the security cache item expired time. |
void |
setSecurityGroupCacheSize(int size)
Sets the security group cache's size. |
void |
setSecurityProtectionCacheSize(int size)
Sets the security protection cache's size. |
void |
setSecurityRoleCacheSize(int size)
Sets the security role cache's size. |
void |
setSecurityUserCacheSize(int size)
Sets the security user cache's size. |
void |
unloadCatalogs(java.lang.String user,
java.util.Vector catalogNames)
Unloads the file names of the catalogs form the cache. |
void |
unloadCatalogs(java.util.Vector catalogNames)
Unloads the file names of the catalogs form the cache. |
void |
unloadReports(java.util.Vector reportNames)
Unloads the file names of the reports to cache. |
void |
unloadReportsWithStyles(java.lang.String user,
java.util.Vector reportNamesWithStyles)
Unloads the file names and styles of the reports to cache. |
void |
unloadReportsWithStyles(java.util.Vector reportNamesWithStyles)
Unloads the file names and styles of the reports to cache. |
boolean |
unlockCachedImage(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
Unlocks a cached image. |
| Method Detail |
|---|
void setEnableCacheCatelog(boolean isEnableCacheCatelog)
throws java.rmi.RemoteException
isEnableCacheCatelog - whether to cache catalogs.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean getEnableCacheCatelog()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setMaxCacheCatalogSize(int maxCacheCatalog)
throws java.rmi.RemoteException
maxCacheCatalog - the maximum number of catalogs to be cached.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
int getMaxCacheCatalogSize()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setEnableCacheImage(boolean isEnableCacheImage)
throws java.rmi.RemoteException
isEnableCacheImage - whether to cache images.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setDisplayImageDetail(boolean isDisplay)
throws java.rmi.RemoteException
isDisplay - whether to display cached images details.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean getEnableCacheImage()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean getDisplayImageDetail()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setMaxCacheImageSize(int maxCacheImage)
throws java.rmi.RemoteException
maxCacheImage - the maximum number of images to be cached.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
int getMaxCacheImageSize()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean setCachedCatalogs(java.util.Vector cachedCatalogs)
throws java.rmi.RemoteException
cachedCatalogs - the file names of catalogs to be cached.
java.rmi.RemoteException - will be thrown if error occurs.
java.util.Vector getCachedImages()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void appendImage(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
throws java.rmi.RemoteException
catFile - the catalog file's full path nameimgFileName - the file name of the image to be appendeduser - the user ID.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void removeImage(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
throws java.rmi.RemoteException
catFile - the catalog file's full path nameimgFile - the file name of the image to be removeduser - the user ID.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void removeAllImages()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean lockCachedImage(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
throws java.rmi.RemoteException
catFile - the full path name of the catalogimgFileName - the file name of the imageuser - the user ID.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean unlockCachedImage(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
throws java.rmi.RemoteException
catFile - the full path name of the catalogimgFileName - the file name of the imageuser - the user ID.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean isLockedImage(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
throws java.rmi.RemoteException
catFile - the full path name of the catalog fileimgFileName - the image file name.user - the user ID.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
java.lang.String getImageBelongedCatalog(java.lang.String fullImagePath)
throws java.rmi.RemoteException
fullImagePath - the full path name of the image
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean isCacheAllImages()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setCacheAllImages(boolean isCacheAllImages)
throws java.rmi.RemoteException
isCacheAllImages - boolean value to set whether to cache all images.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
long getUsedImageCacheSize()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
long getAnImageSize(java.lang.String catFile,
java.lang.String imgFile,
java.lang.String user)
throws java.rmi.RemoteException
catFile - the full path name of the catalog file, for example, /SampleReports/Sample.catimgFileName - the image file name.user - the user ID.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean setCachedCatalogs(java.lang.String user,
java.util.Vector cachedCatalogs)
throws java.rmi.RemoteException
cachedCatalogs - the file names of catalogs to be cached.user - the user processing cache
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
java.util.Vector getCachedCatalogs()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setEnableCacheReport(boolean isEnableCacheReport)
throws java.rmi.RemoteException
isEnableCacheReport - whether to cache reports.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean getEnableCacheReport()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setMaxCacheReportSize(int maxCacheReport)
throws java.rmi.RemoteException
maxCacheReport - the maximum number of reports to be cached.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
int getMaxCacheReportSize()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean setCachedReports(java.util.Vector cachedReports)
throws java.rmi.RemoteException
cachedReports - the file names of the reports to cache.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean setCachedReportsWithStyles(java.util.Vector cachedReportsWithStyles)
throws java.rmi.RemoteException
cachedReportsWithStyles - the file names and styles of the reports to cache.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean setCachedReportsWithStyles(java.lang.String user,
java.util.Vector cachedReportsWithStyles)
throws java.rmi.RemoteException
cachedReportsWithStyles - the file names and styles of the reports to cache.user - the user processing cache
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
java.util.Vector getCachedReports()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
java.util.Vector getCachedReportsWithStyles()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void unloadCatalogs(java.util.Vector catalogNames)
throws java.rmi.RemoteException
catalogNames - the Vector which is the file names of the catalogs to unload.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void unloadCatalogs(java.lang.String user,
java.util.Vector catalogNames)
throws java.rmi.RemoteException
catalogNames - the Vector which is the file names of the catalogs to unload.user - the user processing cache
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void unloadReports(java.util.Vector reportNames)
throws java.rmi.RemoteException
reportNames - the Vector which is the file names of the reports to unload.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void unloadReportsWithStyles(java.util.Vector reportNamesWithStyles)
throws java.rmi.RemoteException
reportNamesWithStyles - the Vector which is the file names and styles of the reports to
unload.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void unloadReportsWithStyles(java.lang.String user,
java.util.Vector reportNamesWithStyles)
throws java.rmi.RemoteException
reportNamesWithStyles - the Vector which is the file names and styles of the reports to
unload.user - the user processing cache
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setSecurityUserCacheSize(int size)
throws java.rmi.RemoteException
size -
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
int getSecurityUserCacheSize()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setSecurityRoleCacheSize(int size)
throws java.rmi.RemoteException
size - the cache size
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
int getSecurityRoleCacheSize()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setSecurityGroupCacheSize(int size)
throws java.rmi.RemoteException
size - the cache size
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
int getSecurityGroupCacheSize()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setSecurityProtectionCacheSize(int size)
throws java.rmi.RemoteException
size - the security group cache's size
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setSecurityCacheExpireTime(int size)
throws java.rmi.RemoteException
the - expired time
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
int getSecurityCacheExpireTime()
throws java.rmi.RemoteException
the - expire time
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
int getSecurityProectionCacheSize()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void loadProperties()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void saveProperties()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
int getEngineSortBufferSize()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setEngineSortBufferSize(int size)
throws java.rmi.RemoteException
size - the engine sort buffer size
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setCRDMemoryUsage(int maxMemoryUsage)
throws java.rmi.RemoteException
maxMemoryUsage - the maximum memory which is used for caching the CRD data.
The minimum value is 4MB and can be increased up to 80% of
the total Java maximum heap size (-Xmx value in JRserver.bat).
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
int getCRDMemoryUsage()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean isAutoCache()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setEnableAutoCache(boolean isEnableAutoCache)
throws java.rmi.RemoteException
isEnableAutoCache - true if automatic cache is enabled
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setMaxDiskUsage(int maxDiskUsage)
throws java.rmi.RemoteException
maxDiskUsage - the maximum hard disk space which is used for cached CRD data.
The minimum value is 4MB.
The maximum value is 1024*1024 MB.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
int getMaxDiskUsage()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
boolean isNeverExpire()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setNeverExpire(boolean isNeverExpire)
throws java.rmi.RemoteException
isNeverExpire - true if automatic cached data never expires.
false if the expired time is customized.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
void setExpiredTime(long expiredTime)
throws java.rmi.RemoteException
expiredTime - the customized expired time of the automatic cached data,
the unit is second.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
long getExpiredTime()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution.
double getMaxCubeMemory()
throws java.rmi.RemoteException
java.rmi.RemoteException - if communication-related error occurs during RMI call execution
void setMaxCubeMemory(double memorySize)
throws java.rmi.RemoteException
memorySize - Maximum Cube Memory Allowed, unit is MB.
java.rmi.RemoteException - if communication-related error occurs during RMI call execution
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||