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 */
017
018package org.apache.commons.configuration2.reloading;
019
020import org.apache.commons.logging.Log;
021import org.apache.commons.logging.LogFactory;
022
023/**
024 * A strategy to reload configuration based on management requests. Designed for
025 * JMX management.
026 *
027 * @author Nicolas De loof
028 */
029public class ManagedReloadingDetector implements ReloadingDetector,
030        ManagedReloadingDetectorMBean
031{
032    /** The logger. */
033    private final Log log = LogFactory.getLog(ManagedReloadingDetector.class);
034
035    /** A flag whether a reload is required. */
036    private volatile boolean reloadingRequired;
037
038    /**
039     * {@inheritDoc} This implementation resets the internal flag indicating
040     * that a reload should be performed.
041     */
042    @Override
043    public void reloadingPerformed()
044    {
045        reloadingRequired = false;
046    }
047
048    /**
049     * Checks whether reloading is required. This implementation checks whether
050     * the {@code refresh()} method has been invoked.
051     *
052     * @return a flag whether reloading is required
053     */
054    @Override
055    public boolean isReloadingRequired()
056    {
057        return reloadingRequired;
058    }
059
060    /**
061     * Tells this strategy that the monitored configuration file should be
062     * refreshed. This method will typically be called from outside (through an
063     * exposed MBean) on behalf of an administrator.
064     *
065     * @see org.apache.commons.configuration2.reloading.ManagedReloadingDetectorMBean#refresh()
066     */
067    @Override
068    public void refresh()
069    {
070        log.info("Reloading configuration.");
071        reloadingRequired = true;
072    }
073}