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;
018    
019    import javax.management.JMException;
020    import javax.management.MBeanServer;
021    import javax.management.ObjectName;
022    
023    public interface InstrumentationAgent {
024    
025        /**
026         * Registers object with management infrastructure with a specific name. Object must be annotated or 
027         * implement standard MBean interface.
028         * @param obj
029         * @param name
030         * @throws JMException
031         */
032        void register(Object obj, ObjectName name) throws JMException;
033        
034        /**
035         * Registers object with management infrastructure with a specific name. Object must be annotated or 
036         * implement standard MBean interface.
037         * @param obj
038         * @param name
039         * @param forceRegistration if set to true, then component will be registered despite existing component.
040         * @throws JMException
041         */
042        void register(Object obj, ObjectName name, boolean forceRegistration) throws JMException;
043        
044        /**
045         * Unregisters component based upon registered name
046         * @param name
047         * @throws JMException
048         */
049        void unregister(ObjectName name) throws JMException;
050    
051        /**
052         * Get the MBeanServer which hosts managed components
053         * NOTE: if the configuration is not set the JMXEnabled to be true, this method
054         * will return null
055         * @return the MBeanServer 
056         */
057        MBeanServer getMBeanServer();
058    
059    }