Java Doc for Monitor.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) 


java.lang.Object
   javax.management.NotificationBroadcasterSupport
      javax.management.monitor.Monitor

Monitor
abstract public class Monitor extends NotificationBroadcasterSupport implements MonitorMBean,MBeanRegistration,Serializable(Code)
This class is the base class for all types of monitor mbeans.Defines the common part to all monitor MBeans. Using Monitor MBeans, the observed attribute of another MBean (the observed MBean) is monitored at intervals specified by the granularity period. A gauge value (derived gauge) is derived from the values of the observed attribute.


Field Summary
protected static  intOBSERVED_ATTRIBUTE_ERROR_NOTIFIED
     Flag denoting that a notification has occurred after changing the observed attribute.
protected static  intOBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED
     Flag denoting that a notification has occurred after changing the observed object or the observed attribute.
protected static  intOBSERVED_OBJECT_ERROR_NOTIFIED
     Flag denoting that a notification has occurred after changing the observed object or the observed attribute.
protected static  intRESET_FLAGS_ALREADY_NOTIFIED
     This flag is used to reset the alreadyNotified monitor attribute.
protected static  intRUNTIME_ERROR_NOTIFIED
     Flag denoting that a notification has occurred after changing the observed object or the observed attribute.
protected  intalreadyNotified
    
 StringattributeName
     Attribute to observe.
 longderivedGaugeTimeStamp
    
protected  StringdgbTag
    
 longgranularityPeriod
     Monitor granularity period (in milliseconds).
 booleanisActive
     Monitor state.
 ObjectNameobservedObject
     Object to which the attribute to observe belongs to.
protected  MBeanServerserver
     Reference on the MBean server. This reference is null when the monitor MBean is not registered in an MBean server.

Constructor Summary
public  Monitor()
    

Method Summary
public  longgetGranularityPeriod()
     This method gets the granularity period (in milliseconds).
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  StringgetObservedAttribute()
     This method gets the name of the attribute being observed.
public  ObjectNamegetObservedObject()
     This method gets the object name of the object being observed.
public  booleanisActive()
     This method tests whether the monitor MBean is active.
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)
     This method allows the monitor MBean to perform any operations it needs before being registered in the MBean server. Initializes the reference to the MBean server.
Parameters:
  server - - The MBean server in which the monitor MBean will be registered.
Parameters:
  name - - The object name of the monitor MBean.
public  voidsetGranularityPeriod(long period)
     This method sets the granularity period (in milliseconds).
public  voidsetObservedAttribute(String attribute)
     This method sets the attribute being observed.
public  voidsetObservedObject(ObjectName object)
     This method sets the object name of the object being observed.
Parameters:
  object - The ObjectName of the object to be observed.
abstract public  voidstart()
     This method starts the monitor.
abstract public  voidstop()
     This method stops the monitor.

Field Detail
OBSERVED_ATTRIBUTE_ERROR_NOTIFIED
protected static int OBSERVED_ATTRIBUTE_ERROR_NOTIFIED(Code)
Flag denoting that a notification has occurred after changing the observed attribute. This flag is used to check that the new observed attribute belongs to the observed object at the time of the first notification.



OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED
protected static int OBSERVED_ATTRIBUTE_TYPE_ERROR_NOTIFIED(Code)
Flag denoting that a notification has occurred after changing the observed object or the observed attribute. This flag is used to check that the observed attribute type is correct (depending on the monitor in use) at the time of the first notification.



OBSERVED_OBJECT_ERROR_NOTIFIED
protected static int OBSERVED_OBJECT_ERROR_NOTIFIED(Code)
Flag denoting that a notification has occurred after changing the observed object or the observed attribute. This flag is used to notify any exception (except the cases described above) when trying to get the value of the observed attribute at the time of the first notification.



RESET_FLAGS_ALREADY_NOTIFIED
protected static int RESET_FLAGS_ALREADY_NOTIFIED(Code)
This flag is used to reset the alreadyNotified monitor attribute.



RUNTIME_ERROR_NOTIFIED
protected static int RUNTIME_ERROR_NOTIFIED(Code)
Flag denoting that a notification has occurred after changing the observed object or the observed attribute. This flag is used to notify any exception (except the cases described above) when trying to get the value of the observed attribute at the time of the first notification.



alreadyNotified
protected int alreadyNotified(Code)
Selected monitor errors that have already been notified



attributeName
String attributeName(Code)
Attribute to observe.
The default value is set to null.



derivedGaugeTimeStamp
long derivedGaugeTimeStamp(Code)



dgbTag
protected String dgbTag(Code)



granularityPeriod
long granularityPeriod(Code)
Monitor granularity period (in milliseconds).



isActive
boolean isActive(Code)
Monitor state. The default value is set to false.



observedObject
ObjectName observedObject(Code)
Object to which the attribute to observe belongs to.
The default value is set to null.



server
protected MBeanServer server(Code)
Reference on the MBean server. This reference is null when the monitor MBean is not registered in an MBean server. This reference is initialized before the monitor MBean is registered in the MBean server.
See Also:   Monitor.preRegister(MBeanServer server,ObjectName name)




Constructor Detail
Monitor
public Monitor()(Code)
Default constructor




Method Detail
getGranularityPeriod
public long getGranularityPeriod()(Code)
This method gets the granularity period (in milliseconds). long value representing the value of the granularity period(in milliseconds).



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.



getObservedAttribute
public String getObservedAttribute()(Code)
This method gets the name of the attribute being observed. String The name of the attribute that is being observed.



getObservedObject
public ObjectName getObservedObject()(Code)
This method gets the object name of the object being observed. The ObjectName of the object being observed.



isActive
public boolean isActive()(Code)
This method tests whether the monitor MBean is active. A monitor MBean is marked active when the start method is called. It becomes inactive when the stop method is called. boolean value indicating whether the MBean is active or not.



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.



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.
throws:
  This - operation throws java.lang.Exception



preRegister
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception(Code)
This method allows the monitor MBean to perform any operations it needs before being registered in the MBean server. Initializes the reference to the MBean server.
Parameters:
  server - - The MBean server in which the monitor MBean will be registered.
Parameters:
  name - - The object name of the monitor MBean. This method allows the monitor MBean to perform any operationsit needs before being registered in the MBean server. - java.lang.Exception.



setGranularityPeriod
public void setGranularityPeriod(long period) throws IllegalArgumentException(Code)
This method sets the granularity period (in milliseconds). The default value is one second.
Parameters:
  period - the granularity period value.
exception:
  java.lang.IllegalArgumentException - - The granularity periodis less than or equal to zero.



setObservedAttribute
public void setObservedAttribute(String attribute) throws IllegalArgumentException(Code)
This method sets the attribute being observed.
Parameters:
  attribute - The attribute to be observed.



setObservedObject
public void setObservedObject(ObjectName object) throws IllegalArgumentException(Code)
This method sets the object name of the object being observed.
Parameters:
  object - The ObjectName of the object to be observed. IllegalArgumentException.



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



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



Methods inherited from javax.management.NotificationBroadcasterSupport
public void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)(Code)(Java Doc)
public MBeanNotificationInfo[] getNotificationInfo()(Code)(Java Doc)
public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException(Code)(Java Doc)
public void sendNotification(Notification notif)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(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.