001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    
021    package org.apache.directory.shared.ldap.message.spi;
022    
023    
024    import java.util.Properties;
025    
026    
027    /**
028     * A Provider monitor's callback interface.
029     * 
030     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031     * @version $Rev: 437007 $
032     */
033    public interface ProviderMonitor
034    {
035        /** A do nothing monitor to use if none is provided */
036        public static ProviderMonitor NOOP_MONITOR = new ProviderMonitor()
037        {
038            public final void propsFound( final String msg, final Properties props )
039            {
040            }
041    
042    
043            public final void usingDefaults( final String msg, final Properties props )
044            {
045            }
046        };
047    
048    
049        /**
050         * Callback used to monitor the discovered properties for the provider.
051         * 
052         * @param msg
053         *            a message about where the properties were found or null
054         * @param props
055         *            the properties discovered
056         */
057        void propsFound( String msg, Properties props );
058    
059    
060        /**
061         * Callback used to monitor if and what set of defaults are being used.
062         * 
063         * @param msg
064         *            a descriptive message about this event or null
065         * @param props
066         *            the properties that constitute the defaults
067         */
068        void usingDefaults( String msg, Properties props );
069    }