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