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 */
019package org.apache.wiki.api.engine;
020
021import org.apache.wiki.api.core.Engine;
022import org.apache.wiki.api.exceptions.WikiException;
023
024import java.util.Properties;
025
026
027/**
028 * Marker interface for Engine's components that can be initialized.
029 */
030public interface Initializable {
031
032    /**
033     * <p>Initializes this Engine component. Note that the engine is not fully initialized at this
034     * point, so don't do anything fancy here - use lazy init, if you have to.<br/>&nbsp;</p>
035     *
036     * @param engine Engine performing the initialization.
037     * @param props Properties for setup.
038     * @throws WikiException if an exception occurs while initializing the component.
039     */
040    void initialize( Engine engine, Properties props ) throws WikiException;
041
042}