Package com.tibco.tibjms.admin
Class FileStoreInfo
- java.lang.Object
- 
- com.tibco.tibjms.admin.StoreInfo
- 
- com.tibco.tibjms.admin.FileStoreInfo
 
 
- 
 public class FileStoreInfo extends StoreInfo Class representing information about a server's file-based store.
- 
- 
Constructor SummaryConstructors Constructor Description FileStoreInfo(java.lang.Object json)For Internal use only, may be removed or deprecated in future.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FileStoreInfofrom(javax.management.openmbean.CompositeData cd)For Internal use only, may be removed or deprecated in future.longgetDestinationDefrag()Get the maximum batch size for destination defragmentation of queues in this store.longgetFileMinimum()Get the minimum size of the file (the file will pre-allocated at least to that size, if necessary).java.lang.StringgetFileName()Get the file name.intgetFragmentation()Get the percentage fragmentation of the store file.longgetInUseSpace()Get the amount of space in the store file that is in use.longgetNotInUseSpace()Get the amount of space in the store file that is not in use.longgetSize()Get the total size of the store file.intgetSyncProgress()Get the current progress of the synchronization of this store file when the server is running in the EMS Appliance.longgetWriteRate()Get the number of bytes written per second.booleanisCRCEnabled()Indicates whether or not CRC checks are performed for stored data.booleanisSynchronousWriteEnabled()Indicates whether or not the file is opened in synchronous write mode.booleanisTruncationEnabled()Indicates whether or not the server will periodically check if there is unused space at the end of the file and, if so, truncate the file.java.lang.StringtoString()- 
Methods inherited from class com.tibco.tibjms.admin.StoreInfogetAverageWriteTime, getFileSize, getFreeSpace, getMsgBytes, getMsgCount, getName, getSwappedBytes, getSwappedCount, getType, getUsedSpace, getWriteUsage
 
- 
 
- 
- 
- 
Constructor Detail- 
FileStoreInfopublic FileStoreInfo(java.lang.Object json) throws JMSExceptionFor Internal use only, may be removed or deprecated in future.- Throws:
- JMSException
 
 
- 
 - 
Method Detail- 
getDestinationDefragpublic long getDestinationDefrag() Get the maximum batch size for destination defragmentation of queues in this store.- Returns:
- the maximum batch size for destination defrag.
- Since:
- EMS 6.1
 
 - 
getNotInUseSpacepublic long getNotInUseSpace() Get the amount of space in the store file that is not in use.- Returns:
- the number of bytes that are free
 
 - 
getInUseSpacepublic long getInUseSpace() Get the amount of space in the store file that is in use.- Returns:
- the number of bytes that are in use
 
 - 
getSizepublic long getSize() Get the total size of the store file.- Returns:
- the size in bytes
 
 - 
getFragmentationpublic int getFragmentation() Get the percentage fragmentation of the store file.- Returns:
- the percentage (0 - 100) (-1 indicates not available)
- Since:
- EMS 6.0
 
 - 
getFileNamepublic java.lang.String getFileName() Get the file name.- Returns:
- file name
 
 - 
getFileMinimumpublic long getFileMinimum() Get the minimum size of the file (the file will pre-allocated at least to that size, if necessary).- Returns:
- the size in bytes
 
 - 
getWriteRatepublic long getWriteRate() Get the number of bytes written per second.- Returns:
- the byte rate.
- Since:
- EMS 6.1
 
 - 
getSyncProgresspublic int getSyncProgress() Get the current progress of the synchronization of this store file when the server is running in the EMS Appliance.- Returns:
- the synchronization progress percentage as an integer between 0 and 100 or -1 either if no synchronization is ongoing or if requested from a server that is running outside the EMS Appliance
- Since:
- EMS 8.1.0
- See Also:
- State.SERVER_COMPSTATE_SYNCHRONIZING
 
 - 
isCRCEnabledpublic boolean isCRCEnabled() Indicates whether or not CRC checks are performed for stored data.- Returns:
- true if CRC is enabled, false otherwise
 
 - 
isTruncationEnabledpublic boolean isTruncationEnabled() Indicates whether or not the server will periodically check if there is unused space at the end of the file and, if so, truncate the file.- Returns:
- true if truncation is enabled, false otherwise
 
 - 
isSynchronousWriteEnabledpublic boolean isSynchronousWriteEnabled() Indicates whether or not the file is opened in synchronous write mode.- Returns:
- true if synchronous mode is enabled, false otherwise
 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- java.lang.Object
 
 - 
frompublic static FileStoreInfo from(javax.management.openmbean.CompositeData cd) throws java.lang.Exception For Internal use only, may be removed or deprecated in future.- Returns:
- a FileStoreInfo object from CompositeData
- Throws:
- java.lang.IllegalArgumentException- if CompositeType does not match or if a null CompositeData is passed.
- java.lang.Exception
 
 
- 
 
-