JmxReporter (Java Simon 4.2.0 API)

java.lang.Object
- org.javasimon.jmx.JmxReporter

```
public final class JmxReporter
extends Object
```
Utility class for registering JMX beans that can be used to access Simon manager and Simons. JmxReporter is created by either forManager(org.javasimon.Manager) or forDefaultManager(). Additional configuration methods can be called using fluent API (). Finally start() will set up all expected MX beans and system is ready for monitoring through JMX. Method stop() unregisters all related MX beans when monitoring is no longer required.

Author:

Ivan Mushketyk, Richard "Virgo" Richter

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_BEAN_NAME

static String DEFAULT_SIMON_DOMAIN

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_BEAN_NAME`
`static String`	`DEFAULT_SIMON_DOMAIN`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JmxReporter`	`beanName(String beanName)` Bean name that will be used to register JMX bean for Simon manager.
`static JmxReporter`	`forDefaultManager()` Creates new JmxReporter for the default manager with default values.
`static JmxReporter`	`forManager(Manager manager)` Creates new JmxReporter for the specified manager with default values.
`String`	`getBeanName()`
`MBeanServer`	`getBeanServer()`
`Manager`	`getManager()`
`String`	`getSimonDomain()`
`boolean`	`isRegisterExistingSimons()`
`boolean`	`isRegisterSimons()`
`boolean`	`isReplaceExistingMxBeans()`
`JmxReporter`	`registerExistingSimons()`
`JmxReporter`	`registerSimons()` Specifies that separate JMX beans should be registered for each Simon in current manager.
`JmxReporter`	`replaceExisting()` Specifies that previously registered bean with the same name should be replaced.
`void`	`setBeanServer(MBeanServer beanServer)`
`void`	`setRegisterExistingSimons(boolean registerExistingSimons)`
`void`	`setRegisterSimons(boolean registerSimons)`
`void`	`setReplaceExistingMxBeans(boolean replaceExistingMxBeans)`
`void`	`setSimonDomain(String simonDomain)`
`JmxReporter`	`simonDomain(String simonDomain)` Specify domain for registered JMX for separate Simons.
`JmxReporter`	`start()` Starts JmxReporter - registers all required beans in JMX bean server.
`void`	`stop()` Stop JMX reporter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_BEAN_NAME
```
public static final String DEFAULT_BEAN_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SIMON_DOMAIN
```
public static final String DEFAULT_SIMON_DOMAIN
```
    See Also:
    
    Constant Field Values
- Method Detail
  - forManager
```
public static JmxReporter forManager(Manager manager)
```
    Creates new JmxReporter for the specified manager with default values.
    
    Parameters:
    
    manager - manager that will be used by JmxReporter
    
    Returns:
    
    new JmxReporter
  - forDefaultManager
```
public static JmxReporter forDefaultManager()
```
    Creates new JmxReporter for the default manager with default values.
    
    Returns:
    
    new JmxReporter
  - simonDomain
```
public JmxReporter simonDomain(String simonDomain)
```
    Specify domain for registered JMX for separate Simons. Is used only if registerSimons set to true.
    
    Parameters:
    
    simonDomain - domain for separate JMX beans for separate Simons
    
    Returns:
    
    this
  - replaceExisting
```
public JmxReporter replaceExisting()
```
    Specifies that previously registered bean with the same name should be replaced.
    
    Returns:
    
    this
  - registerSimons
```
public JmxReporter registerSimons()
```
    Specifies that separate JMX beans should be registered for each Simon in current manager.
    
    Returns:
    
    this
  - registerExistingSimons
```
public JmxReporter registerExistingSimons()
```
  - beanName
```
public JmxReporter beanName(String beanName)
```
    Bean name that will be used to register JMX bean for Simon manager.
    
    Parameters:
    
    beanName - bean name that will be used to register JMX bean for Simon manager
    
    Returns:
    
    this
  - getManager
```
public Manager getManager()
```
  - getBeanServer
```
public MBeanServer getBeanServer()
```
  - setBeanServer
```
public void setBeanServer(MBeanServer beanServer)
```
  - getBeanName
```
public String getBeanName()
```
  - getSimonDomain
```
public String getSimonDomain()
```
  - setSimonDomain
```
public void setSimonDomain(String simonDomain)
```
  - isReplaceExistingMxBeans
```
public boolean isReplaceExistingMxBeans()
```
  - setReplaceExistingMxBeans
```
public void setReplaceExistingMxBeans(boolean replaceExistingMxBeans)
```
  - isRegisterSimons
```
public boolean isRegisterSimons()
```
  - setRegisterSimons
```
public void setRegisterSimons(boolean registerSimons)
```
  - isRegisterExistingSimons
```
public boolean isRegisterExistingSimons()
```
  - setRegisterExistingSimons
```
public void setRegisterExistingSimons(boolean registerExistingSimons)
```
  - start
```
public JmxReporter start()
```
    Starts JmxReporter - registers all required beans in JMX bean server.
  - stop
```
public void stop()
```
    Stop JMX reporter. Unregister all previously registered beans.

Class JmxReporter

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BEAN_NAME

DEFAULT_SIMON_DOMAIN

Method Detail

forManager

forDefaultManager

simonDomain

replaceExisting

registerSimons

registerExistingSimons

beanName

getManager

getBeanServer

setBeanServer

getBeanName

getSimonDomain

setSimonDomain

isReplaceExistingMxBeans

setReplaceExistingMxBeans

isRegisterSimons

setRegisterSimons

isRegisterExistingSimons

setRegisterExistingSimons

start

stop