org.apache.wicket.IInitializer.java Source code

Introduction

Here is the source code for org.apache.wicket.IInitializer.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.wicket;

import java.util.ServiceLoader;

import org.apache.wicket.request.resource.PackageResource;

/**
 * Initializes something when application loads.
 * <p>
 * Initializer can be used for clustering. Lets say you access a page that has a link to a resource on
 * node A now the url for the resource gets forwarded to node B, but node B doesn't have the
 * resource registered yet because maybe the page class hasn't been loaded and so its static block
 * hasn't run yet. So the initializer is a place for you to register all those resources and do all
 * the stuff you used to do in the static blocks.
 * <p>
 * You don't have to pre-register {@link PackageResource package resources}, as they can be
 * initialized lazily.
 * <p>
 * Initializers can be configured via {@link ServiceLoader}, i.e. by having a file
 * /META-INF/services/org.apache.wicket.IInitializer in the class path root, with each line containing the
 * full class name of an {@link IInitializer}.
 * </p>
 * 
 * @author Jonathan Locke
 */
public interface IInitializer {
    /**
     * @param application
     *            The application loading the component
     */
    void init(Application application);

    /**
     * @param application
     *            The application loading the component
     */
    void destroy(Application application);

}