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.jmx;
018
019import org.apache.wicket.markup.html.PackageResourceGuard;
020
021/**
022 * Resource settings.
023 * 
024 * @author eelcohillenius
025 */
026public interface ResourceSettingsMBean
027{
028        /**
029         * Get the application's localizer.
030         * 
031         * @return The application wide localizer instance
032         */
033        String getLocalizer();
034
035        /**
036         * Gets the {@link PackageResourceGuard package resource guard}.
037         * 
038         * @return The package resource guard
039         */
040        String getPackageResourceGuard();
041
042        /**
043         * Get the property factory which will be used to load property files
044         * 
045         * @return PropertiesFactory
046         */
047        String getPropertiesFactory();
048
049        /**
050         * Gets the resource finder to use when searching for resources.
051         * 
052         * @return Returns the resourceFinder.
053         * @see org.apache.wicket.settings.ResourceSettings#getResourceFinders()
054         */
055        String getResourceFinders();
056
057        /**
058         * @return Returns the resourcePollFrequency.
059         * @see org.apache.wicket.settings.ResourceSettings#setResourcePollFrequency(Duration)
060         */
061        String getResourcePollFrequency();
062
063        /**
064         * @return Resource locator for this application
065         */
066        String getResourceStreamLocator();
067
068        /**
069         * @return an unmodifiable list of all available string resource loaders
070         */
071        String[] getStringResourceLoaders();
072
073        /**
074         * @see org.apache.wicket.settings.ResourceSettings#getThrowExceptionOnMissingResource()
075         * 
076         * @return boolean
077         */
078        boolean getThrowExceptionOnMissingResource();
079
080        /**
081         * @return Whether to use a default value (if available) when a missing resource is requested
082         */
083        boolean getUseDefaultOnMissingResource();
084
085        /**
086         * @see org.apache.wicket.settings.ResourceSettings#setThrowExceptionOnMissingResource(boolean)
087         * 
088         * @param throwExceptionOnMissingResource
089         */
090        void setThrowExceptionOnMissingResource(final boolean throwExceptionOnMissingResource);
091
092        /**
093         * @param useDefaultOnMissingResource
094         *            Whether to use a default value (if available) when a missing resource is requested
095         */
096        void setUseDefaultOnMissingResource(final boolean useDefaultOnMissingResource);
097}