Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Exporting JMX mbeans made easy
tag: 1.5

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
src
.gitignore
CHANGES
README.md
pom.xml

README.md

Example

class ManagedObject
{
    @Managed
    public int getValue()
    {
       ...
    }

    @Managed
    public void setValue(int value)
    {
       ...
    }

    @Managed(description="do the operation")
    public void operation()
    {
       ...
    }
}

...
MBeanExporter exporter = new MBeanExporter(ManagementFactory.getPlatformMBeanServer());
exporter.export("test:name=X", new ManagedObject());

Guice support

Injector injector = Guice.createInjector(
    new AbstractModule() {
        @Override
        protected void configure() {
            // MBeanModules expect an MBeanServer to be bound
            binder().bind(MBeanServer.class).toInstance(ManagementFactory.getPlatformMBeanServer());
        }
    },
    new MBeanModule() {
        @Override
        protected void configureMBeans()
        {
            export(ManagedObject.class).as("test:name=X");
            export(ManagedObject.class).annotatedWith(SomeAnnotation.class).as("test:name=Y");
        }
    }, ...); 


Injector injector = Guice.createInjector(
    new MBeanModule(), // used to trigger registration of mbeans exported via ExportBuilder
    new AbstractModule() {
            @Override
            protected void configure() {
               // MBeanModule expects an MBeanServer to be bound
               binder().bind(MBeanServer.class).toInstance(ManagementFactory.getPlatformMBeanServer());

               ExportBuilder builder = MBeanModule.newExporter(binder());
               builder.export(AnotherManagedObject.class).as("test:name="Z");

               // You can use a standardized naming scheme for singletons if you wish.
               // See ObjectNames.generatedNameOf(Class<?>) for the naming scheme.
               builder.export(ManagedSingleton.class).withGeneratedName();
            }
    }, ...);

Custom annotations

You can use your own annotations instead of @Managed to tag methods. To do so, you need to tag the annotation with the org.jmx.weakreaf.ManagedAnnotation meta annotation.

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD })
@ManagedAnnotation
public @interface CustomAnnotation
{
    String description() default "";
    String type() default "";
}

class ManagedObject
{
    @CustomAnnotation(description="foo", type="counter")
    public int getValue()
    {
       ...
    }
}

If the custom annotation has an attribute "description" of type String, it will be used as the description of the jmx method or attribute.

Maven dependency

To use jmxutils in maven projects:

<dependency>
    <groupId>org.weakref</groupId>
    <artifactId>jmxutils</artifactId>
    <version>1.5</version>
</dependency>

License

Licensed under the Apache License, Version 2.0 (the "License")

You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Something went wrong with that request. Please try again.