Search code examples
javaspringjmxspring-3

Change @ManagedResource objectName dynamically


I am creating prototype beans programatically/dynamically. I want those beans after initiation to be in the jmx console. How I can distinguish between them? I am using anotations in order to add my beans to the jmx and I have

@ManagedResource(objectName="bean:name=MybBean")

I need to inject the objectName dynamically. Any idea how could I do it?

Here's my jmx configuration:

<context:mbean-export server="mbeanServer" />

<bean id="mbeanServer" class="org.springframework.jmx.support.MBeanServerFactoryBean" />

<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter"
        lazy-init="false">

        <property name="beans">
            <map>
                <entry key="Server:name=HttpAdaptor">
                    <bean class="mx4j.tools.adaptor.http.HttpAdaptor">
                        <property name="port" value="8000" />
                        <property name="host" value="0.0.0.0" />
                        <property name="processor">
                            <bean class="mx4j.tools.adaptor.http.XSLTProcessor" />
                        </property>

                    </bean>
                </entry>                
            </map>
        </property>
        <property name="listeners">
            <list>
                <!--

                -->
                <bean class="com.fixgw.jmx.HttpAdaptorMgr">
                    <property name="mbeanServer" ref="mbeanServer" />
                </bean>
            </list>
        </property>
    </bean>

   <bean id="sessionMDB" class="com.fixgw.mdb.SessionMDB"
        scope="prototype" lazy-init="true">
        <constructor-arg ref="0" />
        <constructor-arg ref="0" />
    </bean>

Solution

  • You can use a a JMX naming strategy to do this. At work we use an interface:

    public interface RuntimeJmxNames {
        /** this is the name= part of the object name */
        public String getJmxName();
        /** this sets the folders as 00=FirstFolder,01=Second */
        public String[] getJmxPath();
    }
    

    I've posted the code to implement the RuntimeMetadataNamingStrategy naming strategy.

    And then something like the following Spring beans:

    <bean id="jmxAttributeSource"
     class="org.springframework.jmx.export.annotation.AnnotationJmxAttributeSource" />
    
    <bean id="jmxAssembler"
        class="org.springframework.jmx.export.assembler.MetadataMBeanInfoAssembler">
        <property name="attributeSource" ref="jmxAttributeSource" />
    </bean>
    
    <bean id="jmxNamingStrategy" class="com.j256.jmx.RuntimeMetadataNamingStrategy">
        <property name="attributeSource" ref="jmxAttributeSource" />
    </bean>
    
    <bean id="mbeanExporter" class="org.springframework.jmx.export.MBeanExporter">
        <property name="autodetect" value="true" />
        <property name="assembler" ref="jmxAssembler" />
        <property name="namingStrategy" ref="jmxNamingStrategy" />
        <property name="ensureUniqueRuntimeObjectNames" value="false" />
        <property name="excludedBeans" ref="excludedJmxBeans" />
    </bean>
    

    In your code you do something like:

    @ManagedResource(objectName = "foo.com:name=replaced", description = "...")
    public class Foo implements RuntimeJmxNames {
        ...
        public String getJmxName() {
            // here's where you can make the name be dynamic
            return toString();
        }
        @Override
        public String[] getJmxPath() {
            return new String[] { "folder" };
        }
    }
    

    Here's the Spring documentation on JMX naming although I'm not 100% sure it covers the custom naming stuff.

    Also, my SimpleJMX package does a this as well. It uses a JmxSelfNaming interface which allows each instance of an object to define it's own bean-name to make them unique and works well with Spring.