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