net.fckeditor.handlers.PropertiesLoader Maven / Gradle / Ivy
Show all versions of java-core Show documentation
/*
* FCKeditor - The text editor for Internet - http://www.fckeditor.net
* Copyright (C) 2004-2010 Frederico Caldeira Knabben
*
* == BEGIN LICENSE ==
*
* Licensed under the terms of any of the following licenses at your
* choice:
*
* - GNU General Public License Version 2 or later (the "GPL")
* http://www.gnu.org/licenses/gpl.html
*
* - GNU Lesser General Public License Version 2.1 or later (the "LGPL")
* http://www.gnu.org/licenses/lgpl.html
*
* - Mozilla Public License Version 1.1 or later (the "MPL")
* http://www.mozilla.org/MPL/MPL-1.1.html
*
* == END LICENSE ==
*/
package net.fckeditor.handlers;
import java.io.BufferedInputStream;
import java.io.InputStream;
import java.util.Properties;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Manages FCKeditor.Java properties files.
*
* It manages/loads the properties files in the following order:
*
* - the default properties as defined here,
*
- the user-defined properties (
fckeditor.properties) if
* present.
*
* This means that user-defined properties override default ones. In
* the backend it utilizes the regular {@link Properties} class.
*
*
* Moreover, you can set properties programmatically too but make sure to
* override them before the first call of that specific property.
*
* @version $Id: PropertiesLoader.java 4785 2009-12-21 20:10:28Z mosipov $
*/
public class PropertiesLoader {
private static final Logger logger = LoggerFactory
.getLogger(PropertiesLoader.class);
private static final String DEFAULT_FILENAME = "default.properties";
private static final String LOCAL_PROPERTIES = "/fckeditor.properties";
private static Properties properties = new Properties();
static {
// 1. load library defaults
InputStream in = PropertiesLoader.class
.getResourceAsStream(DEFAULT_FILENAME);
if (in == null) {
logger.error("{} not found", DEFAULT_FILENAME);
throw new RuntimeException(DEFAULT_FILENAME + " not found");
} else {
if (!(in instanceof BufferedInputStream))
in = new BufferedInputStream(in);
try {
properties.load(in);
in.close();
logger.debug("{} loaded", DEFAULT_FILENAME);
} catch (Exception e) {
logger.error("Error while processing {}", DEFAULT_FILENAME);
throw new RuntimeException("Error while processing "
+ DEFAULT_FILENAME, e);
}
}
// 2. load user defaults if present
InputStream in2 = PropertiesLoader.class
.getResourceAsStream(LOCAL_PROPERTIES);
if (in2 == null) {
logger.info("{} not found", LOCAL_PROPERTIES);
} else {
if (!(in2 instanceof BufferedInputStream))
in2 = new BufferedInputStream(in2);
try {
properties.load(in2);
in2.close();
logger.debug("{} loaded", LOCAL_PROPERTIES);
} catch (Exception e) {
logger.error("Error while processing {}", LOCAL_PROPERTIES);
throw new RuntimeException("Error while processing "
+ LOCAL_PROPERTIES, e);
}
}
}
/**
* Searches for the property with the specified key in this property list.
*
* @see Properties#getProperty(String)
*/
public static String getProperty(final String key) {
return properties.getProperty(key);
}
/**
* Sets the property with the specified key in this property list.
*
* @see Properties#setProperty(String, String)
*/
public static void setProperty(final String key, final String value) {
properties.setProperty(key, value);
}
/**
* Returns fckeditor.toolbarSet property
*/
public static String getEditorToolbarSet() {
return properties.getProperty("fckeditor.toolbarSet");
}
/**
* Returns fckeditor.width property
*/
public static String getEditorWidth() {
return properties.getProperty("fckeditor.width");
}
/**
* Returns fckeditor.height property
*/
public static String getEditorHeight() {
return properties.getProperty("fckeditor.height");
}
/**
* Returns fckeditor.basePath property
*/
public static String getEditorBasePath() {
return properties.getProperty("fckeditor.basePath");
}
/**
* Returns connector.resourceType.file.path property
*/
public static String getFileResourceTypePath() {
return properties.getProperty("connector.resourceType.file.path");
}
/**
* Returns connector.resourceType.flash.path property
*/
public static String getFlashResourceTypePath() {
return properties.getProperty("connector.resourceType.flash.path");
}
/**
* Returns connector.resourceType.image.path property
*/
public static String getImageResourceTypePath() {
return properties.getProperty("connector.resourceType.image.path");
}
/**
* Returns connector.resourceType.media.path property
*/
public static String getMediaResourceTypePath() {
return properties.getProperty("connector.resourceType.media.path");
}
/**
* Returns connector.resourceType.file.extensions.allowed
* property
*/
public static String getFileResourceTypeAllowedExtensions() {
return properties
.getProperty("connector.resourceType.file.extensions.allowed");
}
/**
* Returns connector.resourceType.file.extensions.denied
* property
*/
public static String getFileResourceTypeDeniedExtensions() {
return properties
.getProperty("connector.resourceType.file.extensions.denied");
}
/**
* Returns connector.resourceType.flash.extensions.allowed
* property
*/
public static String getFlashResourceTypeAllowedExtensions() {
return properties
.getProperty("connector.resourceType.flash.extensions.allowed");
}
/**
* Returns connector.resourceType.flash.extensions.denied
* property
*/
public static String getFlashResourceTypeDeniedExtensions() {
return properties
.getProperty("connector.resourceType.flash.extensions.denied");
}
/**
* Returns connector.resourceType.image.extensions.allowed
* property
*/
public static String getImageResourceTypeAllowedExtensions() {
return properties
.getProperty("connector.resourceType.image.extensions.allowed");
}
/**
* Returns connector.resourceType.image.extensions.denied
* property
*/
public static String getImageResourceTypeDeniedExtensions() {
return properties
.getProperty("connector.resourceType.image.extensions.denied");
}
/**
* Returns connector.resourceType.media.extensions.allowed
* property
*/
public static String getMediaResourceTypeAllowedExtensions() {
return properties
.getProperty("connector.resourceType.media.extensions.allowed");
}
/**
* Returns connector.resourceType.media.extensions.denied
* property
*/
public static String getMediaResourceTypeDeniedExtensions() {
return properties
.getProperty("connector.resourceType.media.extensions.denied");
}
/**
* Returns connector.userFilesPath property
*/
public static String getUserFilesPath() {
return properties.getProperty("connector.userFilesPath");
}
/**
* Returns connector.userFilesAbsolutePath property
*/
public static String getUserFilesAbsolutePath() {
return properties.getProperty("connector.userFilesAbsolutePath");
}
/**
* Returns connector.forceSingleExtension property
*/
public static boolean isForceSingleExtension() {
return Boolean.valueOf(properties
.getProperty("connector.forceSingleExtension"));
}
/**
* Returns connector.secureImageUploads property
*/
public static boolean isSecureImageUploads() {
return Boolean.valueOf(properties
.getProperty("connector.secureImageUploads"));
}
/**
* Returns connector.impl property
*/
public static String getConnectorImpl() {
return properties.getProperty("connector.impl");
}
/**
* Returns connector.userActionImpl property
*/
public static String getUserActionImpl() {
return properties.getProperty("connector.userActionImpl");
}
/**
* Returns connector.userPathBuilderImpl property
*/
public static String getUserPathBuilderImpl() {
return properties.getProperty("connector.userPathBuilderImpl");
}
/**
* Returns connector.localeResolverImpl property
*/
public static String getLocaleResolverImpl() {
return properties.getProperty("localization.localeResolverImpl");
}
}