org.esigate.extension.Extension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of esigate-core Show documentation

There is a newer version: 5.3

/* 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package org.esigate.extension;

import java.util.Properties;

import org.esigate.Driver;

/**
 * Interface for extensions.
 * 
 * 
 * Extensions are classes which are loaded through the generic ExtensionFactory.getExtension().
 * 
 * 
 * @author Nicolas Richeton
 * 
 */
public interface Extension {

    /**
     * Initialize the extension using the given properties.
     * 
     * Extensions may register to events during the init phase.
     * 
     * @param driver
     * 
     * @param properties
     */
    void init(Driver driver, Properties properties);
}