org.objectweb.fractal.jmx.agent
Interface AdminAttributes

All Superinterfaces:

AttributeController

All Known Implementing Classes:

Agent

public interface AdminAttributes

extends AttributeController

Attribute controller of the agent component. This interface provides attributes for filtering MBeans in the scope of the agent. Only the MBeans, whose ObjectName matches a pattern defined by these attributes, are registered in the agent.

Available filters:

• ItfPatterns: for filtering component interface MBeans.
• MonitorStringPatterns: for filtering string monitor MBeans.
• MonitorCounterPatterns: for filtering counter monitor MBeans.
• MonitorGaugePatterns: for filtering gauge monitor MBeans.
• MonitorPeriodicPatterns: for filtering periodic monitor MBeans.

The syntax of these filters relies on the naming convention defined in Admin for component interfaces, except for some additional property-value pairs reserved for the configuration of JMX monitors.

Version:

0.1

Method Summary

String	getItfPatterns() Returns the patterns for filtering components interface MBeans.
String	getMonitorCounterPatterns() Returns the patterns for filtering counter monitor MBeans.
String	getMonitorGaugePatterns() Returns the patterns for filtering gauge monitor MBeans.
String	getMonitorPeriodicPatterns() Returns the patterns for filtering periodic monitor MBeans.
String	getMonitorStringPatterns() Returns the patterns for filtering string monitor MBeans.
MBeanServer	getRawMBeanServer() Returns the underlying MBeanServer used by the agent.
void	setItfPatterns(String str) Sets the patterns for filtering components interface MBeans.
void	setMonitorCounterPatterns(String str) Sets the patterns for filtering counter monitor MBeans.
void	setMonitorGaugePatterns(String str) Sets the patterns for filtering gauge monitor MBeans.
void	setMonitorPeriodicPatterns(String str) Sets the patterns for filtering periodic monitor MBeans.
void	setMonitorStringPatterns(String str) Sets the patterns for filtering string monitor MBeans.
void	setRawMBeanServer(MBeanServer srv) Sets the underlying MBeanServer used by the agent.

Method Detail

getItfPatterns

public String getItfPatterns()

Returns the patterns for filtering components interface MBeans.

Returns:

the patterns for filtering components interface MBeans.

See Also:

setItfPatterns(java.lang.String)

setItfPatterns

public void setItfPatterns(String str)

Sets the patterns for filtering components interface MBeans. Any component interface, whose ObjectName matches one of these patterns, can be registered in the agent.

The syntax of this filter is defined to equal a sequence of (";" separated) string representations of ObjectName patterns. For example:

    *:itf=attribute-controller,*;*/Foo/*:*
 

represents two patterns that can match respectively:

• the attribute controller interface of any component.
• any server interface of any component, if a super-component (in the content hierarchy) of this component is named "Foo".

Parameters:

str - the patterns for filtering components interface MBeans.

getMonitorStringPatterns

public String getMonitorStringPatterns()

Returns the patterns for filtering string monitor MBeans.

Returns:

the patterns for filtering string monitor MBeans.

See Also:

setMonitorStringPatterns(java.lang.String)

setMonitorStringPatterns

public void setMonitorStringPatterns(String str)

Sets the patterns for filtering string monitor MBeans. Any getter of type string, specified in a component interface whose ObjectName matches one of these patterns, can be observed by a string monitor.

The syntax of this filter is defined to equal a sequence of (";" separated) string representations of ObjectName patterns. Where the following properties are reserved for the configuration of a string monitor (as defined in the JMX specification):

• observedAttribute: the attribute being observed.
• granularityPeriod: the granularity period (in milliseconds).
• stringToCompare: the string to compare with the observed attribute.
• notifyDiffer: the differing notification's on/off switch value.
• notifyMatch: the matching notification's on/off switch value.

For example:

    *:itf=attribute-controller,observedAttribute=Foo,granularityPeriod=5000,
      stringToCompare=fooval,notifyDiffer=true,notifyMatch=true,*
 

represents a pattern that can match the attribute controller interface of any component, if this interface specifies a string attribute "Foo". This attribute will be monitored every 5000 ms and compared with the value "fooval". As defined in the JMX specification:

• A match notification is sent when the value of the attribute "Foo" first matches the value "fooval". Subsequent matchings of "fooval" do not cause further notifications unless the attribute value differs from "fooval".
• A differ notification is sent when the value of the attribute "Foo" first differs from the value "fooval". Subsequent differences from "fooval" do not cause further notifications unless the attribute value matches "fooval".

Parameters:

str - the patterns for filtering string monitor MBeans.

getMonitorCounterPatterns

public String getMonitorCounterPatterns()

Returns the patterns for filtering counter monitor MBeans.

Returns:

the patterns for filtering counter monitor MBeans.

See Also:

setMonitorCounterPatterns(java.lang.String)

setMonitorCounterPatterns

public void setMonitorCounterPatterns(String str)

Sets the patterns for filtering counter monitor MBeans. Any getter of type integer (Byte, Integer, Short, Long), specified in a component interface whose ObjectName matches one of these patterns, can be observed by a counter monitor.

The syntax of this filter is defined to equal a sequence of (";" separated) string representations of ObjectName patterns. Where the following properties are reserved for the configuration of a counter monitor (as defined in the JMX specification):

• observedAttribute: the attribute being observed.
• granularityPeriod: the granularity period (in milliseconds).
• initThreshold: the initial threshold value.
• modulus: the modulus value.
• offset: the offset value.
• differenceMode: the difference mode flag value.

For example:

    *:itf=stat-controller,observedAttribute=NumberOfMethodCall,granularityPeriod=5000,
      initThreshold=2,modulus=0,offset=10,differenceMode=false,*
 

represents a pattern that can match the interface "stat-controller" of any component, if this interface specifies an integer attribute named "NumberOfMethodCall". This attribute will be monitored every 5000 ms. Threshold notifications are sent, as defined in the JMX specification for a counter monitor configured with: InitThreshold=2, Modulus=0, Offset=10 and DifferenceMode=false (by default Notify=true).

Parameters:

str - the patterns for filtering counter monitor MBeans.

getMonitorGaugePatterns

public String getMonitorGaugePatterns()

Returns the patterns for filtering gauge monitor MBeans.

Returns:

the patterns for filtering gauge monitor MBeans.

See Also:

setMonitorGaugePatterns(java.lang.String)

setMonitorGaugePatterns

public void setMonitorGaugePatterns(String str)

Sets the patterns for filtering gauge monitor MBeans. Any getter of type integer or floating-point (Byte, Integer, Short, Long, Float, Double), specified in a component interface whose ObjectName matches one of these patterns, can be observed by a gauge monitor.

The syntax of this filter is defined to equal a sequence of (";" separated) string representations of ObjectName patterns. Where the following properties are reserved for the configuration of a gauge monitor (as defined in the JMX specification):

• observedAttribute: the attribute being observed.
• granularityPeriod: the granularity period (in milliseconds).
• lowThreshold: the low threshold value.
• highThreshold: the low threshold value.
• differenceMode: the difference mode flag value.

For example:

    *:itf=stat-controller,observedAttribute=RateOfMethodCall,granularityPeriod=5000,
      lowThreshold=0.05,highThreshold=0.15,differenceMode=false,*
 

represents a pattern that can match the interface "stat-controller" of any component, if this interface specifies an integer or floating-point attribute named "RateOfMethodCall". This attribute will be monitored every 5000 ms. Threshold high notifications and Threshold low notifications are sent, as defined in the JMX specification for a gauge monitor configured with: LowThreshold=0.05, HighThreshold=0.15 and DifferenceMode=false (by default NotifyHigh=true and NotifyLow=true).

Parameters:

str - the patterns for filtering gauge monitor MBeans.

getMonitorPeriodicPatterns

public String getMonitorPeriodicPatterns()

Returns the patterns for filtering periodic monitor MBeans.

Returns:

the patterns for filtering periodic monitor MBeans.

See Also:

setMonitorPeriodicPatterns(java.lang.String)

setMonitorPeriodicPatterns

public void setMonitorPeriodicPatterns(String str)

Sets the patterns for filtering periodic monitor MBeans. Any getter, specified in a component interface whose ObjectName matches one of these patterns, can be observed by a periodic monitor.

The syntax of this filter is defined to equal a sequence of (";" separated) string representations of ObjectName patterns. Where the following properties are reserved for the configuration of a periodic monitor:

• observedAttribute: the attribute being observed.
• granularityPeriod: the granularity period (in milliseconds).

For example:

    *:itf=attribute-controller,observedAttribute=Foo,granularityPeriod=5000
 

represents a pattern that can match the attribute controller interface of any component, if this interface specifies a string attribute "Foo". Every 5000 ms, this attribute will be monitored and a notification will be sent.

Parameters:

str - the patterns for filtering periodic monitor MBeans.

getRawMBeanServer

public MBeanServer getRawMBeanServer()

Returns the underlying MBeanServer used by the agent. This method allows raw MBean manipulation on the Fractal JMX agent side.

Returns:

the underlying MBeanServer used by the agent.

setRawMBeanServer

public void setRawMBeanServer(MBeanServer srv)
                       throws UnsupportedOperationException

Sets the underlying MBeanServer used by the agent.

This method is unsupported, but specified since the Fractal attribute controller API requires getter and setter methods for each attribute.

Parameters:

srv - the underlying MBeanServer used by the agent.

Throws:

UnsupportedOperationException - if this operation is not supported.