001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.camel.spi;
018    
019    import javax.management.JMException;
020    import javax.management.MBeanServer;
021    import javax.management.ObjectName;
022    import javax.management.modelmbean.ModelMBean;
023    
024    /**
025     * An assembler to assemble a {@link javax.management.modelmbean.RequiredModelMBean} which can be used
026     * to register the object in JMX.
027     */
028    public interface ManagementMBeanAssembler {
029    
030        /**
031         * Assemble the {@link javax.management.modelmbean.ModelMBean}.
032         *
033         * @param mBeanServer the mbean server
034         * @param obj         the object
035         * @param name        the object name to use in JMX
036         * @return the assembled {@link javax.management.modelmbean.ModelMBean}, or <tt>null</tt> if not possible to assemble an MBean
037         * @throws JMException is thrown if error assembling the mbean
038         */
039        ModelMBean assemble(MBeanServer mBeanServer, Object obj, ObjectName name) throws JMException;
040    
041    }