i_adminmap.java

java开源的企业总线.xmlBlaster

/*------------------------------------------------------------------------------
Name:      I_AdminMap.java
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
Comment:   Interface to access information about a client instance
------------------------------------------------------------------------------*/
package org.xmlBlaster.util.admin;


/**
 * Declares available methods of a map implementation for administration. 
 * <p />
 * SNMP or telnet tools can access only the here declared properties.<br />
 * This interface is implemented by I_Map.java implementations delivering the meat.
 * @author [e-mail]
 * <p />
 * Don't invoke any operations on this interface, it will certainly destroy
 * your running application!
 *
 * @author [e-mail]
 * @since 1.0.5
 * @see org.xmlBlaster.engine.msgstore.I_Map
 */
public interface I_AdminMap extends I_AdminPlugin {
   /**
    * Access the current queue configuration. 
    */
   public String getPropertyStr();
   /**
    * Returns the unique ID of this queue as found in the database XB_ENTRIES.queueName column. 
    * @return For example "topicStore_heron"
    */
   public String getQueueName();
   /**
    * Remove the specified storage entry. 
    * @param uniqueId The entry identifier
    * @return the number of elements erased.
    */
   public int removeById(long uniqueId) throws Exception;
   /**
    * Remove the oldest storage entry from cache. 
    * @return The entry removed
    */
   public String removeOldestEntry() throws Exception;
   /**
    * Returns the number of elements in this 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 temporary not available) it will return -1.
    * @return int the number of elements
    */
   public long getNumOfEntries();
   /**
    * Returns the number of elements in the RAM part of this storage.
    * If no cache map is used and there is no RAM storage beneath we return -1
    * @return int the number of elements or -1 if not applicable
    */
   public long getNumOfCachedEntries();
   /**
    * Returns the number of elements having the persistent flag set in this 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.
    * @return int the number of elements currently in the store
    */
   public long getNumOfPersistentEntries();
   /**
    * returns the maximum number of elements for this store
    * @return int the maximum number of elements in the storage
    */
   public long getMaxNumOfEntries();
   /**
    * returns the maximum number of cached elements for this store
    * @return int the maximum number of elements in the storage
    */
   public long getMaxNumOfEntriesCache();
   /**
    * Increase the max number of entries persistently. 
    * @param max
    * @return
    */
   public String setMaxNumOfEntries(long max);
   /**
    * Increase the max number of entries of the cached part persistently. 
    * @param max
    * @return
    */
   public String setMaxNumOfEntriesCache(long max);
   /**
    * 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.
    * @return The number of elements currently in the storage
    */
   public long getNumOfBytes();
   /**
    * Returns the amount of bytes currently in the RAM part of the storage
    * @return The number of elements currently in the storage or -1
    */
   public long getNumOfCachedBytes();
   /**
    * 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.
    * @return int the number of elements currently in the storage
    */
   public long getNumOfPersistentBytes();
   /**
    * returns the capacity (maximum bytes) for this storage
    * @return int the maximum number of elements in the storage
    */
   public long getMaxNumOfBytes();
   /**
    * returns the cache capacity (maximum bytes) for this storage
    * @return int the maximum number of elements in the storage
    */
   public long getMaxNumOfBytesCache();
   /**
    * Increase the max number of bytes persistently. 
    * @param max
    * @return
    */
   public String setMaxNumOfBytes(long max);
   /**
    * Increase the max number of bytes of the cached part persistently. 
    * @param max
    * @return
    */
   public String setMaxNumOfBytesCache(long max);
   /**
    * Removes all the transient entries (the ones which have the flag 'persistent'
    * set to false.
    * @return Number of entries erased
    */
   public int removeTransientEntries() throws Exception;
   /**
    * Delete all entries
    * @return Number of entries removed
    */
   public long clear();
   /**
    * Performs what has to be done when the Map Plugin shuts down.
    */
   public void shutdown();
   /**
    * Is the storage available? 
    * @return true if shutdown
    */
   public boolean isShutdown();

   /**
    * Dump all entries of this map to a file. 
    * The messages are XML formatted.
    * @param fileName The file name to dump, may contain a path.
    * @return Status string
    */
   public String dumpEmbeddedObjectsToFile(String fileName) throws Exception;
   
   /**
    * Check if all messages in the storage are referenced by queue entries (history and callback queue).
    * <br />
    * Caution: The check does not check queues from plugins which may reference the messageUnit,
    * please set fixIt=true only if you know what you are doing! 
    * @param fixIt "true": Unreferenced entries are deleted (ignoring case); else check is readonly,
    * @param reportFileName The file name to dump the details 
    * @return The status report
    */
   public String checkConsistency(String fixIt, String reportFileName);

   /**
    * @return a human readable usage help string
    */
   public java.lang.String usage();
}