/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.configuration.reloading;
import org.apache.commons.configuration.FileConfiguration;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
A strategy to reload configuration based on management requests. Designed for
JMX management.
Author: Nicolas De loof Version: $Id: ManagedReloadingStrategy.java 1210646 2011-12-05 21:25:01Z oheger $
/**
* A strategy to reload configuration based on management requests. Designed for
* JMX management.
*
* @author Nicolas De loof
* @version $Id: ManagedReloadingStrategy.java 1210646 2011-12-05 21:25:01Z oheger $
*/
public class ManagedReloadingStrategy implements ReloadingStrategy,
ManagedReloadingStrategyMBean
{
The logger. /** The logger. */
private Log log = LogFactory.getLog(ManagedReloadingStrategy.class);
Stores a reference to the associated configuration. /** Stores a reference to the associated configuration. */
private FileConfiguration configuration;
A flag whether a reload is required. /** A flag whether a reload is required. */
private boolean reloadingRequired;
See Also: - init.init()
/**
* @see org.apache.commons.configuration.reloading.ReloadingStrategy#init()
*/
public void init()
{
}
See Also: - reloadingPerformed.reloadingPerformed()
/**
* @see org.apache.commons.configuration.reloading.ReloadingStrategy#reloadingPerformed()
*/
public void reloadingPerformed()
{
reloadingRequired = false;
}
Checks whether reloading is required. This implementation checks whether the refresh()
method has been invoked. See Also: Returns: a flag whether reloading is required
/**
* Checks whether reloading is required. This implementation checks whether
* the {@code refresh()} method has been invoked.
*
* @return a flag whether reloading is required
* @see org.apache.commons.configuration.reloading.ReloadingStrategy#reloadingRequired()
*/
public boolean reloadingRequired()
{
return reloadingRequired;
}
Sets the associated configuration.
Params: - configuration – the associated configuration
/**
* Sets the associated configuration.
*
* @param configuration the associated configuration
*/
public void setConfiguration(FileConfiguration configuration)
{
this.configuration = configuration;
}
Tells this strategy that the monitored configuration file should be
refreshed. This method will typically be called from outside (through an
exposed MBean) on behalf of an administrator.
See Also: - refresh.refresh()
/**
* Tells this strategy that the monitored configuration file should be
* refreshed. This method will typically be called from outside (through an
* exposed MBean) on behalf of an administrator.
*
* @see org.apache.commons.configuration.reloading.ManagedReloadingStrategyMBean#refresh()
*/
public void refresh()
{
log.info("Reloading configuration.");
this.reloadingRequired = true;
// force reloading
configuration.isEmpty();
}
}