org.spf4j.jmx

Class DynamicMBeanBuilder

java.lang.Object

org.spf4j.jmx.DynamicMBeanBuilder

@ParametersAreNonnullByDefault
public final class DynamicMBeanBuilder
extends Object

A JMX managed bean Builder.

Author:

Zoltan Farkas

Constructor Summary

Constructors

Constructor and Description
DynamicMBeanBuilder()

Method Summary

Modifier and Type	Method and Description
org.spf4j.jmx.ExportedValuesMBean	build(String packageName, String mbeanName) Build the dynamic mbean.
org.spf4j.jmx.ExportedValuesMBean	extend(org.spf4j.jmx.ExportedValuesMBean toExtend) Create a dynamic bean with extends the toExtend mbean with the attributes and operations from thsi builder.
org.spf4j.jmx.ExportedValuesMBean	extend(String packageName, String mbeanName) extend existing Mbean registered with provided packageName and mbeanName
boolean	isEmpty()
static DynamicMBeanBuilder	newBuilder()
org.spf4j.jmx.ExportedValuesMBean	register(String packageName, String mbeanName) register a mbean.
org.spf4j.jmx.ExportedValuesMBean	registerIfExports(String packageName, String mbeanName)
org.spf4j.jmx.ExportedValuesMBean	replace(String packageName, String mbeanName) Replace mbean registered with packageName and mbeanName with a mbean constructed by this builder.
org.spf4j.jmx.ExportedValuesMBean	replaceIfExports(String packageName, String mbeanName)
String	toString()
DynamicMBeanBuilder	withAttribute(ExportedValue<?> val)
DynamicMBeanBuilder	withAttributes(ExportedValue<?>... vals)
DynamicMBeanBuilder	withAttributes(Map<String,Object> mapAttributes)
DynamicMBeanBuilder	withJmxExportObject(Object object) add all exported (with @JmxExport) attributes and operations of the object.
DynamicMBeanBuilder	withJmxExportObjects(Object... objects) add all exported (with @JmxExport) attributes and operations of the objects.
DynamicMBeanBuilder	withOperation(ExportedOperation operation)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DynamicMBeanBuilder

public DynamicMBeanBuilder()

Method Detail

newBuilder

public static DynamicMBeanBuilder newBuilder()

withOperation

public DynamicMBeanBuilder withOperation(ExportedOperation operation)

withAttribute

public DynamicMBeanBuilder withAttribute(ExportedValue<?> val)

withAttributes

public DynamicMBeanBuilder withAttributes(ExportedValue<?>... vals)

withAttributes

public DynamicMBeanBuilder withAttributes(Map<String,Object> mapAttributes)

withJmxExportObject

public DynamicMBeanBuilder withJmxExportObject(Object object)

add all exported (with @JmxExport) attributes and operations of the object.

Parameters:

object -

Returns:

withJmxExportObjects

public DynamicMBeanBuilder withJmxExportObjects(Object... objects)

add all exported (with @JmxExport) attributes and operations of the objects.

Parameters:

objects -

Returns:

build

@Nullable
public org.spf4j.jmx.ExportedValuesMBean build(String packageName,
                                                         String mbeanName)

Build the dynamic mbean.

Parameters:

packageName -

mbeanName -

Returns:

dynamic mbean or null if no exportable attributes or operations are present.

extend

@Nonnull
public org.spf4j.jmx.ExportedValuesMBean extend(@Nonnull
                                                         org.spf4j.jmx.ExportedValuesMBean toExtend)

Create a dynamic bean with extends the toExtend mbean with the attributes and operations from thsi builder.

Parameters:

toExtend -

Returns:

extend

@Nullable
public org.spf4j.jmx.ExportedValuesMBean extend(String packageName,
                                                          String mbeanName)

extend existing Mbean registered with provided packageName and mbeanName

Parameters:

packageName -

mbeanName -

Returns:

null is nothing was registered.

isEmpty

public boolean isEmpty()

replace

@Nonnull
public org.spf4j.jmx.ExportedValuesMBean replace(String packageName,
                                                          String mbeanName)

Replace mbean registered with packageName and mbeanName with a mbean constructed by this builder.

Parameters:

packageName -

mbeanName -

Returns:

the MBean that was registered.

replaceIfExports

@Nullable
public org.spf4j.jmx.ExportedValuesMBean replaceIfExports(String packageName,
                                                                    String mbeanName)

register

@Nonnull
public org.spf4j.jmx.ExportedValuesMBean register(String packageName,
                                                           String mbeanName)

register a mbean.

Parameters:

packageName -

mbeanName -

Returns:

and a dinamic bean instance that was registered otherwise.

Throws:

InstanceAlreadyExistsException - is a instance already exists.

registerIfExports

@Nullable
public org.spf4j.jmx.ExportedValuesMBean registerIfExports(String packageName,
                                                                     String mbeanName)

toString

public String toString()

Overrides:

toString in class Object