Java Doc for CounterMonitor.java in  » JMX » XMOJO » javax » management » monitor » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » JMX » XMOJO » javax.management.monitor 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.management.monitor.Monitor
   javax.management.monitor.CounterMonitor

CounterMonitor
public class CounterMonitor extends Monitor implements CounterMonitorMBean(Code)
This class defines a monitor MBean designed to observe the values of a counter attribute. Counter attributes are those types whose value is always positive or null and they can only be incremented. The counter monitor is used to observe values of attribute whose type should be of integer i.e. (Byte, Integer, Short, Long).

A counter monitor sends a MonitorNotification.THRESHOLD_VALUE_EXCEEDEDthreshold notification when the value of the counter reaches or exceeds a threshold known as the comparison level. The notify flag must be set to true.
In addition, an offset mechanism enables particular counting intervals to be detected.

If the offset value is not zero, whenever the threshold is triggered by the counter value reaching a comparison level, that comparison level is incremented by the offset value. This is regarded as taking place instantaneously, that is before the count is incremented. Thus, for each level, the threshold triggers an event notification every time the count increases by an interval equal to the offset value.

If the counter can wrap around its maximum value, the modulus needs to be specified. The modulus is the value at which the counter is reset to zero.

If the counter difference mode is used, the value of the derived gauge is calculated as the difference between the observed counter values for two successive observations. If this difference is negative, the value of the derived gauge is incremented by the value of the modulus.
The derived gauge value (V[t]) is calculated using the following method:

  • if (counter[t] - counter[t-GP]) is positive then V[t] = counter[t] - counter[t-GP]
  • if (counter[t] - counter[t-GP]) is negative then V[t] = counter[t] - counter[t-GP] + MODULUS

Inner Class :class CounterThread implements Runnable


Constructor Summary
public  CounterMonitor()
     Default Constructor.

Method Summary
public  java.lang.NumbergetDerivedGauge()
     This method gets the value of the derived gauge.
public  longgetDerivedGaugeTimeStamp()
     This method gets the value of the derived gauge time stamp.The derived gauge time stamp is the value(in the nearest miliseconds) when the notification was triggered.
public  booleangetDifferenceMode()
     This method gets the value of the difference mode.
public  java.lang.NumbergetModulus()
     This method gets the modulus value of monitor.
public  MBeanNotificationInfo[]getNotificationInfo()
     This method returns a NotificationInfo object containing the name of the Java class of the notification and the notification types sent by the counter monitor.
public  booleangetNotify()
     This method gets the notification's on/off switch value.
public  NumbergetOffset()
     This method gets the offset value.
public  java.lang.NumbergetThreshold()
     This method gets the value of the threshold.
public  voidpostDeregister()
     This method allows the monitor MBean to perform any operations needed after having been de-registered by the MBean server.
public  voidpostRegister(Boolean registrationDone)
     This method allows the monitor MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.
public  voidpreDeregister()
     This method allows the monitor MBean to perform any operations it needs before being de-registered by the MBean server.
public  ObjectNamepreRegister(MBeanServer server, ObjectName name)
     Overriding the preRegister() of MBeanRegistration interface to store the ObjectName locally.
public  voidsetDifferenceMode(boolean value)
     This method sets the state of the difference mode.
public  voidsetModulus(java.lang.Number value)
     This method sets the modulus value of the monitor.
public  voidsetNotify(boolean value)
     This method sets the notification's on/off switch value.
public  voidsetOffset(java.lang.Number value)
     This method sets the value of the offset.
public  voidsetThreshold(java.lang.Number value)
     This method sets the value of the threshold.Threshold is the maximum value of that the attribute can reach.
public  voidstart()
     This method starts the counter monitor.
public  voidstop()
     This method stops the counter monitor.


Constructor Detail
CounterMonitor
public CounterMonitor()(Code)
Default Constructor.




Method Detail
getDerivedGauge
public java.lang.Number getDerivedGauge()(Code)
This method gets the value of the derived gauge. The derived gauge is either the exact value of the observed attribute , or the difference between the two consecutive observed values of the attribute. An instance of java.lang.Number giving the value of the derived gauge.



getDerivedGaugeTimeStamp
public long getDerivedGaugeTimeStamp()(Code)
This method gets the value of the derived gauge time stamp.The derived gauge time stamp is the value(in the nearest miliseconds) when the notification was triggered. long value representing the time the notification was triggered.



getDifferenceMode
public boolean getDifferenceMode()(Code)
This method gets the value of the difference mode. If the difference mode is true, the difference mode option is set to calculate the value of the derived gauge. boolean value indicating whether the difference mode option is set.



getModulus
public java.lang.Number getModulus()(Code)
This method gets the modulus value of monitor. Modulus is the value at which the counter is reset to zero. An instance of java.lang.Number giving the modulus value.



getNotificationInfo
public MBeanNotificationInfo[] getNotificationInfo()(Code)
This method returns a NotificationInfo object containing the name of the Java class of the notification and the notification types sent by the counter monitor. An Array of MBeanNotificationInfo objects.



getNotify
public boolean getNotify()(Code)
This method gets the notification's on/off switch value. a boolean value indicating the state of notification's On/Off switch.



getOffset
public Number getOffset()(Code)
This method gets the offset value. Offset enables particular counting intervals to be detected. An instance of java.lang.Number giving the value of the offset.



getThreshold
public java.lang.Number getThreshold()(Code)
This method gets the value of the threshold. Threshold is the maximum value of that the attribute can reach. If the attribute reaches this comparison level or is greater than this level , notification is triggered. An instance of java.lang.Number giving the value of the threshold.



postDeregister
public void postDeregister()(Code)
This method allows the monitor MBean to perform any operations needed after having been de-registered by the MBean server. Not used in this context.



postRegister
public void postRegister(Boolean registrationDone)(Code)
This method allows the monitor MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed. Not used in this context.
Parameters:
  registrationDone - If registration is done it is true otherwise false



preDeregister
public void preDeregister() throws Exception(Code)
This method allows the monitor MBean to perform any operations it needs before being de-registered by the MBean server. Stops the monitor.



preRegister
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception(Code)
Overriding the preRegister() of MBeanRegistration interface to store the ObjectName locally.



setDifferenceMode
public void setDifferenceMode(boolean value)(Code)
This method sets the state of the difference mode.
Parameters:
  value - boolean value representing the state of the difference mode.



setModulus
public void setModulus(java.lang.Number value) throws IllegalArgumentException(Code)
This method sets the modulus value of the monitor. Modulus is the value at which the counter is reset to zero.
Parameters:
  value - An instance of java.lang.Number representing the modulusvalue for the derived gauge .
exception:
  java.lang.IllegalArgumentException - - The specified modulus isnull or the modulus value is less than zero.



setNotify
public void setNotify(boolean value)(Code)
This method sets the notification's on/off switch value.
Parameters:
  value - boolean value to set the sate of the notifications On/Off Switch.



setOffset
public void setOffset(java.lang.Number value) throws IllegalArgumentException(Code)
This method sets the value of the offset.
Parameters:
  value - An instance of java.lang.Number giving the value offset.
exception:
  java.lang - ,IllegalArgumentException - The specified offset isnull or the offset value is less than zero.



setThreshold
public void setThreshold(java.lang.Number value) throws IllegalArgumentException(Code)
This method sets the value of the threshold.Threshold is the maximum value of that the attribute can reach. If the attribute reaches this comparison level or is greater than this level , notification is triggered.
Parameters:
  value - An instance of java.lang.Number which is the value of the threshold.



start
public void start()(Code)
This method starts the counter monitor.



stop
public void stop()(Code)
This method stops the counter monitor.



Fields inherited from javax.management.monitor.Monitor
final protected static int OBSERVED_ATTRIBUTE_ERROR_NOTIFIED(Code)(Java Doc)
final protected static int OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED(Code)(Java Doc)
final protected static int OBSERVED_OBJECT_ERROR_NOTIFIED(Code)(Java Doc)
final protected static int RESET_FLAGS_ALREADY_NOTIFIED(Code)(Java Doc)
final protected static int RUNTIME_ERROR_NOTIFIED(Code)(Java Doc)
protected int alreadyNotified(Code)(Java Doc)
protected int alreadyNotifieds(Code)(Java Doc)
final protected static int capacityIncrement(Code)(Java Doc)
protected String dbgTag(Code)(Java Doc)
protected int elementCount(Code)(Java Doc)
protected MBeanServer server(Code)(Java Doc)

Methods inherited from javax.management.monitor.Monitor
public void addObservedObject(ObjectName objectName) throws IllegalArgumentException(Code)(Java Doc)
public boolean containsObservedObject(ObjectName objectName)(Code)(Java Doc)
abstract MX4JMonitor createMX4JMonitor()(Code)(Java Doc)
public long getGranularityPeriod()(Code)(Java Doc)
synchronized MX4JMonitor getMX4JMonitor()(Code)(Java Doc)
public String getObservedAttribute()(Code)(Java Doc)
public ObjectName getObservedObject()(Code)(Java Doc)
public ObjectName[] getObservedObjects()(Code)(Java Doc)
public boolean isActive()(Code)(Java Doc)
public void postDeregister()(Code)(Java Doc)
public void postRegister(Boolean registrationDone)(Code)(Java Doc)
public void preDeregister() throws Exception(Code)(Java Doc)
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception(Code)(Java Doc)
public void removeObservedObject(ObjectName objectName)(Code)(Java Doc)
public void setGranularityPeriod(long period) throws java.lang.IllegalArgumentException(Code)(Java Doc)
public void setObservedAttribute(String attribute) throws java.lang.IllegalArgumentException(Code)(Java Doc)
public void setObservedObject(ObjectName objectName) throws java.lang.IllegalArgumentException(Code)(Java Doc)
abstract public void start()(Code)(Java Doc)
abstract public void stop()(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.