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.resource;
018
019import org.apache.wicket.Localizer;
020import org.apache.wicket.core.util.resource.locator.IResourceStreamLocator;
021import org.apache.wicket.util.watch.IModificationWatcher;
022
023/**
024 * environment required for properties factory
025 *
026 * @author Peter Ertl
027 *
028 * @since 1.5
029 */
030public interface IPropertiesFactoryContext
031{
032        /**
033         * Get the application's localizer.
034         *
035         * to modify the way Wicket resolves keys to localized messages you can 
036         * add custom resource loaders to the list returned by 
037         * {@link org.apache.wicket.settings.ResourceSettings#getStringResourceLoaders()}.
038         *
039         * @return The application wide localizer instance
040         */
041        Localizer getLocalizer();
042
043        /**
044         * @return Resource locator for this application
045         */
046        IResourceStreamLocator getResourceStreamLocator();
047
048        /**
049         * @param start
050         *            boolean if the resource watcher should be started if not already started.
051         *
052         * @return Resource watcher with polling frequency determined by setting, or null if no polling
053         *         frequency has been set.
054         */
055        IModificationWatcher getResourceWatcher(boolean start);
056}