org.broadleafcommerce.common.util.BroadleafMergeResourceBundleMessageSource Maven / Gradle / Ivy
Show all versions of broadleaf-common Show documentation
/*
* #%L
* BroadleafCommerce Common Libraries
* %%
* Copyright (C) 2009 - 2013 Broadleaf Commerce
* %%
* Licensed 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.
* #L%
*/
package org.broadleafcommerce.common.util;
import org.apache.commons.collections.CollectionUtils;
import org.springframework.context.support.ReloadableResourceBundleMessageSource;
import org.springframework.context.support.ResourceBundleMessageSource;
import org.springframework.core.io.ResourceLoader;
/**
* Replaces the deprecated {@link BLResourceBundleMessageSource} by using a {@link ReloadableResourceBundleMessageSource}
* instead. The main advantage of using this is the out-of-the-box ability to merge multiple property files together. There
* is one important difference: When there is a conflict for a property (declared in multiple files) this implementation
* assumes that the later one in the list takes precedence. This follows with normal Broadleaf assumptions that bean
* definitions declared later in the merge process win.
*
* While this theoretically supports caching via the features provided in ReloadableResourceBundleMessageSource, this should
* not be used and instead should have cacheMillis always set to -1 (which is the default implementation). This ensures
* that codes are always obtained from a merged property list.
*
* The basenames in this implementation are Spring path resources so if you need to refer to a resource on the classpath,
* these should be prefixed with classpath:. This is slightly different from the {@link ResourceBundleMessageSource}; see
* {@link ReloadableResourceBundleMessageSource#setBasenames(String...)} for more information.
*
* @author Phillip Verheyden
* @see {@link ReloadableResourceBundleMessageSource}
* @see {@link ResourceLoader#getResource(String)}
* @see {@link #setBasenames(String...)}
*/
public class BroadleafMergeResourceBundleMessageSource extends ReloadableResourceBundleMessageSource {
/**
* The super implementation ensures the basenames defined at the beginning take precedence. We require the opposite in
* order to be in line with previous assumptions about the applicationContext merge process (meaning, beans defined in
* later applicationContexts take precedence). Thus, this reverses basenames before passing it up to the super
* implementation.
*
* @param basenames
* @param resourceBundleExtensionPoint
* @see {@link ReloadableResourceBundleMessageSource#setBasenames(String...)}
*/
@Override
public void setBasenames(String... basenames) {
CollectionUtils.reverseArray(basenames);
super.setBasenames(basenames);
}
}