SiteModule.java

/**
 * Copyright 2013 Tommi S.E. Laukkanen
 *
 * 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.bubblecloud.ilves.site;

/**
 * Interface for site extension modules.
 *
 * @author Tommi S.E. Laukkanen
 */
public interface SiteModule {
    /**
     * Initializes extension module.
     */
    void initialize();

    /**
     * Injects dynamic content to the site descriptor for the period of one page load.
     * @param dynamicSiteDescriptor the dynamic site descriptor
     */
    void injectDynamicContent(final SiteDescriptor dynamicSiteDescriptor);
}