001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.protocol.http;
018
019/**
020 * A factory interface used by wicket filter to create application objects. Configure your
021 * webapplication to use this factory in web.xml like:
022 * 
023 * <pre>
024 * &lt;filter&gt;
025 *   &lt;filter-name&gt;MyApplication&lt;/filter-name&gt;
026 *   &lt;filter-class&gt;org.apache.wicket.protocol.http.WicketFilter&lt;/filter-class&gt;
027 *   &lt;init-param&gt;
028 *     &lt;param-name&gt;applicationFactoryClassName&lt;/param-name&gt;
029 *     &lt;param-value&gt;org.mycompany.MyWebApplicationFactory&lt;/param-value&gt;
030 *   &lt;/init-param&gt;
031 * &lt;/filter&gt;
032 * </pre>
033 * 
034 * @author Igor Vaynberg (ivaynberg)
035 */
036public interface IWebApplicationFactory
037{
038        /**
039         * Create application object
040         * 
041         * @param filter
042         *            the wicket filter
043         * @return application object instance
044         */
045        WebApplication createApplication(WicketFilter filter);
046
047        /**
048         * Called when the filter instance that used this factory is destroyed
049         * 
050         * @param filter
051         *            the wicket filter
052         */
053        void destroy(WicketFilter filter);
054
055}