View Javadoc
1   /* 
2    * Licensed under the Apache License, Version 2.0 (the "License");
3    * you may not use this file except in compliance with the License.
4    * You may obtain a copy of the License at
5    *
6    * http://www.apache.org/licenses/LICENSE-2.0
7    *
8    * Unless required by applicable law or agreed to in writing, software
9    * distributed under the License is distributed on an "AS IS" BASIS,
10   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11   * See the License for the specific language governing permissions and
12   * limitations under the License.
13   *
14   */
15  package org.esigate.extension;
16  
17  import java.util.Properties;
18  
19  import org.esigate.Driver;
20  
21  /**
22   * Interface for extensions.
23   * 
24   * <p>
25   * Extensions are classes which are loaded through the generic ExtensionFactory.getExtension().
26   * 
27   * 
28   * @author Nicolas Richeton
29   * 
30   */
31  public interface Extension {
32  
33      /**
34       * Initialize the extension using the given properties.
35       * <p>
36       * Extensions may register to events during the init phase.
37       * 
38       * @param driver
39       * 
40       * @param properties
41       */
42      void init(Driver driver, Properties properties);
43  }