|
xmlBlaster 2.2.0 client API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface I_AdminMap
Declares available methods of a map implementation for administration.
SNMP or telnet tools can access only the here declared properties.
I_Map
Method Summary | |
---|---|
java.lang.String |
checkConsistency(java.lang.String fixIt,
java.lang.String reportFileName)
Check if all messages in the storage are referenced by queue entries (history and callback queue). |
long |
clear()
Delete all entries |
java.lang.String |
dumpEmbeddedObjectsToFile(java.lang.String fileName)
Dump all entries of this map to a file. |
long |
getMaxNumOfBytes()
returns the capacity (maximum bytes) for this storage |
long |
getMaxNumOfBytesCache()
returns the cache capacity (maximum bytes) for this storage |
long |
getMaxNumOfEntries()
returns the maximum number of elements for this store |
long |
getMaxNumOfEntriesCache()
returns the maximum number of cached elements for this store |
long |
getNumOfBytes()
Returns the amount of bytes currently in the storage If the implementation of this interface is not able to return the correct number of entries (for example if the implementation must make a remote call to a DB which is temporarly not available) it will return -1. |
long |
getNumOfCachedBytes()
Returns the amount of bytes currently in the RAM part of the storage |
long |
getNumOfCachedEntries()
Returns the number of elements in the RAM part of this storage. |
long |
getNumOfEntries()
Returns the number of elements in this storage. |
long |
getNumOfPersistentBytes()
Returns the amount of bytes used by the persistent entries in the storage If the implementation of this interface is not able to return the correct number of entries (for example if the implementation must make a remote call to a DB which is temporarly not available) it will return -1. |
long |
getNumOfPersistentEntries()
Returns the number of elements having the persistent flag set in this storage. |
java.lang.String |
getPropertyStr()
Access the current queue configuration. |
java.lang.String |
getQueueName()
Returns the unique ID of this queue as found in the database XB_ENTRIES.queueName column. |
boolean |
isShutdown()
Is the storage available? |
int |
removeById(long uniqueId)
Remove the specified storage entry. |
java.lang.String |
removeOldestEntry()
Remove the oldest storage entry from cache. |
int |
removeTransientEntries()
Removes all the transient entries (the ones which have the flag 'persistent' set to false. |
java.lang.String |
setMaxNumOfBytes(long max)
Increase the max number of bytes persistently. |
java.lang.String |
setMaxNumOfBytesCache(long max)
Increase the max number of bytes of the cached part persistently. |
java.lang.String |
setMaxNumOfEntries(long max)
Increase the max number of entries persistently. |
java.lang.String |
setMaxNumOfEntriesCache(long max)
Increase the max number of entries of the cached part persistently. |
void |
shutdown()
Performs what has to be done when the Map Plugin shuts down. |
java.lang.String |
usage()
|
Methods inherited from interface org.xmlBlaster.util.admin.I_AdminPlugin |
---|
getType, getVersion |
Methods inherited from interface org.xmlBlaster.util.admin.I_AdminUsage |
---|
getUsageUrl, setUsageUrl |
Method Detail |
---|
java.lang.String getPropertyStr()
java.lang.String getQueueName()
int removeById(long uniqueId) throws java.lang.Exception
uniqueId
- The entry identifier
java.lang.Exception
java.lang.String removeOldestEntry() throws java.lang.Exception
java.lang.Exception
long getNumOfEntries()
long getNumOfCachedEntries()
long getNumOfPersistentEntries()
long getMaxNumOfEntries()
long getMaxNumOfEntriesCache()
java.lang.String setMaxNumOfEntries(long max)
max
-
java.lang.String setMaxNumOfEntriesCache(long max)
max
-
long getNumOfBytes()
long getNumOfCachedBytes()
long getNumOfPersistentBytes()
long getMaxNumOfBytes()
long getMaxNumOfBytesCache()
java.lang.String setMaxNumOfBytes(long max)
max
-
java.lang.String setMaxNumOfBytesCache(long max)
max
-
int removeTransientEntries() throws java.lang.Exception
java.lang.Exception
long clear()
void shutdown()
shutdown
in interface I_AdminPlugin
boolean isShutdown()
isShutdown
in interface I_AdminPlugin
java.lang.String dumpEmbeddedObjectsToFile(java.lang.String fileName) throws java.lang.Exception
fileName
- The file name to dump, may contain a path.
java.lang.Exception
java.lang.String checkConsistency(java.lang.String fixIt, java.lang.String reportFileName)
fixIt
- "true": Unreferenced entries are deleted (ignoring case); else check is readonly,reportFileName
- The file name to dump the details
java.lang.String usage()
usage
in interface I_AdminUsage
|
xmlBlaster 2.2.0 client API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |