i_adminnode.java

java开源的企业总线.xmlBlaster

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

import org.xmlBlaster.util.XmlBlasterException;
import org.xmlBlaster.util.admin.I_AdminUsage;

/**
 * Declares available methods of an xmlBlaster server instance for administration. 
 * <p />
 * SNMP or telnet tools can access only the here declared properties.<br />
 * This interface is implemented by RequestBroker.java, delivering the meat.
 * @author [e-mail]
 * @since 0.79f
 */
public interface I_AdminNode extends I_AdminUsage {
   //@ManagedAttribute( description = "Marcel RequestBroker Size in bytes")
   // JMX annotation JSR 255 since JDK 1.6
   //@javax.management.DescriptorKey
   // see http://java.sun.com/javase/6/docs/technotes/guides/jmx/tutorial/essential.html
   /**
    * Get the number of known cluster nodes. 
    * @return The number of xmlBlaster cluster nodes
    */
   public int getNumNodes();
   /**
    * Get the names of all known xmlBlaster cluster nodes. 
    * @return A comma separated list of cluster node names
    * @deprecated Please use getNodes() instead
    */
   public String getNodeList();

   /**
    * Get the names of all known xmlBlaster cluster nodes. 
    * @return A comma separated list of cluster node names
    */
   public String[] getNodes();

   /**
    * Get my cluster node name. 
    * @return My cluster wide unique name
    */
   public String getNodeId();
   /**
    * Unique id of the xmlBlaster server, changes on each restart. 
    * If 'node/heron' is restarted, the instanceId changes.
    * @return nodeId + timestamp, '/node/heron/instanceId/33470080380'
    */
   public String getInstanceId();
   /**
    * Get the xmlBlaster version number. 
    * @return For example "1.0.4"
    */
   public String getVersion();
   /**
    * Returns the xmlBlaster SVN version control revision number. 
    * @return The subversion revision number of the monitored instance,
    *         for example "13593"
    */
   public String getRevisionNumber();
   /**
    * Returns the date when xmlBlaster was compiled. 
    * @return For example "07/28/2005 03:47 PM"
    */
   public String getBuildTimestamp();
   /**
    * The java vendor of the compiler. 
    * @return For example "Sun Microsystems Inc."
    */
   public String getBuildJavaVendor();
   /**
    * The compiler java version. 
    * @return For example "1.5.0"
    */
   public String getBuildJavaVersion();
   /**
    * Dump the complete internal state of xmlBlaster. 
    * Is an operation to not do it automatically on JMX load
    */
   public String dump() throws XmlBlasterException;
   /**
    * Dump the internal xmlBlaster state to the given file. 
    * @param fn The complete path and file name
    */
   public void setDump(String fn) throws XmlBlasterException;

   /**
    * Access the current run level of xmlBlaster. 
    * @return 0 is halted and 9 is fully operational
    */
   public String getRunlevel();

   /**
    * Change the run level of xmlBlaster. 
    * @param 0 is halted and 9 is fully operational
    */
   public void setRunlevel(String level) throws XmlBlasterException;

   /**
    * Returns the current server time in milliseconds. 
    * For an accuracy discussion please consult {@link System.currentTimeMillis}
    * @return For example 1111400317333
    */
   public long getServerTimestampMillis();
   
   /**
    * Access the current server time as a java.sql.Timestamp string. 
    * @return For example "2005-03-21 11:18:12.622"
    */
   public String getServerTimestamp();
   
   /**
    * Get date when xmlBlaster was started.
    * @return "2005-03-20 11:19:12.322"
    */
   public String getStartupDate();

   /**
    * Get elapsed seconds since xmlBlaster started
    */
   public long getUptime();

   /**
    * Access the last logged error.
    * @return The complete information about the last error logged, never null
    */
   public String getLastError();

   /**
    * Clear the last exception text. 
    */
   public void clearLastError();

   /**
    * Access the last logged warning.
    * @return The complete information about the last warning logged, never null
    */
   public String getLastWarning();

   /**
    * Clear the last warning text. 
    */
   public void clearLastWarning();

   /**
    * Returns the max. amount of free memory, including what the Java Virtual Machine
    * could additionally allocate. 
    * Calling the 
    * <code>gc</code> method may result in increasing the value returned 
    * by <code>freeMemory.</code>
    *
    * @return  an approximation to the total amount of memory
    *          available for future allocated objects, measured in bytes.
    */
  public long getMaxFreeMem();

  /**
   * Nicer to read for humans. 
   * @see #getMaxFreeMem
   */
  public String getMaxFreeMemStr();

  /**
     * Returns the current amount of free memory in the Java Virtual Machine.
     * Calling the 
     * <code>gc</code> method may result in increasing the value returned 
     * by <code>freeMemory.</code>
     *
     * @return  an approximation to the total amount of memory currently
     *          available for future allocated objects, measured in bytes.
     *          Note that the JVM may allocate more memory and the free memory
     *          will grow.
     */
   public long getFreeMem();

   /**
    * Nicer to read for humans. 
    * @see #getFreeMem
    */
   public String getFreeMemStr();

   /**
     * Returns the current amount of memory in the Java virtual machine.
     * The value returned by this method may vary over time, depending on 
     * the host environment.
     * <p>
     * Note that the amount of memory required to hold an object of any 
     * given type may be implementation-dependent.
     * <p>
     * 
     * @return  the total amount of memory currently available for current 
     *          and future objects, measured in bytes.
     */
   public long getTotalMem();

   /**
    * Nicer to read for humans. 
    * @see #getTotalMem
    */
   public String getTotalMemStr();

   /**
    * Returns the total amount of memory including what the Java virtual machine
    * could additionally allocate.
    * The value returned by this method does not change (see java -Xmx...).
    * <p>
    * Increase with for example <tt>java -Xmx512M</tt> on startup.
    * 
    * @return  the total amount of memory currently available for current 
    *          and future objects, measured in bytes.
    */
  public long getMaxMem();

  /**
   * Nicer to read for humans. 
   * @see #getMaxMem
   */
  public String getMaxMemStr();

  /**
    * @return getTotalMem() - getFreeMem()
    */ 
   public long getUsedMem();

   /**
    * Nicer to read for humans. 
    * @see #getUsedMem
    */
   public String getUsedMemStr();

   /* TODO: rename to gc(); as it is an operation */
   public String getGc();
   public void setGc(String dummy);

   /**
    * Shutdown xmlBlaster, exit value is '0'
    */
   public void exit() throws XmlBlasterException;
   public void setExit(String exitValue) throws XmlBlasterException;

   /**
    * Access the bootstrap host name. 
    * This IP or DNS hostname is used for IOR download (CORBA) and for our
    * internal tiny http server. 
    * @return The hostname where xmlBlaster listens on
    */
   public String getHostname();

   /**
    * Access the bootstrap port number. 
    * This port is used for IOR download (CORBA) and for our
    * internal tiny http server. 
    * @return The port number, for example 3412
    */
   public int getPort();

   /**
    * How many clients instances are allocated. 
    */
   public int getNumClients();

   /**
    * Get the maximum allowed number of clients. 
    */
   public int getMaxClients();

   /**
    * Get the client names. 
    * @return A comma separated list
    * @deprecated Please use getClients() instead
    */
   public String getClientList();

   /**
    * Get the client names. 
    * @return An array with all client names
    */
   public String[] getClients();

   /**
    * Shows the clients which have a alive callback connection. 
    * @return The client session names
    */
   public String[] getAliveCallbackClients();

   /**
    * Get the number of system properties. 
    */
   public int getNumSysprop();

   /**
    * Get the system properties. 
    * @return A comma separated list
    * @deprecated Will be removed
    */
   public String getSyspropList();

   /**
    * Get the number of topics. 
    */
   public int getNumTopics();

   /**
    * Get the topics. 
    * @return A comma separated list
    * @deprecated Please use getTopics() instead
    */
   public String getTopicList();

   /**
    * Get the topics. 
    * @return An array of all topic names
    */
   public String[] getTopics();

   /**
    * Get the number of subscriptions. 
    * @return A comma separated list
    */
   public int getNumSubscriptions();

   /**
    * Get the subscriptions. 
    * @return A comma separated list
    * @deprecated Please use getSubscriptions() instead
    */
   public String getSubscriptionList();

   /**
    * Get the subscriptions ids. 
    * @return An array of all subscription ids
    */
   public String[] getSubscriptions();

   /**
    * Check if the given java class is known and wherefrom it was loaded. 
    * @param className for example "com.microsoft.sqlserver.jdbc.SQLServerDriver"
    * @return The info
    */
   public String displayClassInfo(String clazzName);

   //public void setMaxClients(int maxClients);
   
   /**
    * @return Returns the number of get() invocations
    */
   public long getNumGet();
   
   /**
    * @return Returns the number if publish() invocations
    */
   public long getNumPublish();

   /**
    * The overall sent updates (callback to client)
    */
   public long getNumUpdate();
   
   /**
    * Do consistency check. 
    * @param fixIt If "true" (ignoring case) there will be attempts to fix problems, defaults to "false"
    * @param reportFileName The file to dump the report
    * @return A short status report
    */
   String checkConsistency(String fixIt, String reportFileName);
   
   String dumpAllStacks();
   String dumpAllStacksToFile(String file);
   
   String reportMemoryOverview();
   String reportMemoryOverviewToFile(String file);
   
   /**
    * Configure server with '-xmlBlaster/acceptWrongSenderAddress true' or "-xmlBlaster/acceptWrongSenderAddress/joe true".
    * @return true: We accept wrong sender address in PublishQos.getSender() (not myself)
    */
   public boolean isAcceptWrongSenderAddress();

   /**
    * @param acceptWrongSenderAddress the acceptWrongSenderAddress to set
    */
   public void setAcceptWrongSenderAddress(boolean acceptWrongSenderAddress);
}