com.hazelcast.config.ClasspathXmlConfig Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2013, Hazelcast, Inc. All Rights Reserved.
*
* 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.
*/
package com.hazelcast.config;
import com.hazelcast.logging.ILogger;
import com.hazelcast.logging.Logger;
import java.io.InputStream;
import java.util.Properties;
/**
* A {@link Config} which is initialized by loading an XML configuration file from the classpath.
*
* @see FileSystemXmlConfig
*/
public class ClasspathXmlConfig extends Config {
private static final ILogger LOGGER = Logger.getLogger(ClasspathXmlConfig.class);
/**
* Creates a config which is loaded from a classpath resource using the
* Thread.currentThread contextClassLoader. The System.properties are used to resolve variables
* in the XML.
*
* @param resource the xml resource.
* @throws IllegalArgumentException if the resource could not be found.
* @throws com.hazelcast.core.HazelcastException if the XML content is invalid
*/
public ClasspathXmlConfig(String resource) {
this(resource, System.getProperties());
}
/**
* Creates a config which is loaded from a classpath resource using the
* Thread.currentThread contextClassLoader.
*
* @param resource the xml resource.
* @param properties the Properties to resolve variables in the XML.
* @throws IllegalArgumentException if the resource could not be found or if properties is null.
* @throws com.hazelcast.core.HazelcastException if the XML content is invalid
*/
public ClasspathXmlConfig(String resource, Properties properties) {
this(Thread.currentThread().getContextClassLoader(), resource, properties);
}
/**
* Creates a config which is loaded from a classpath resource. The System.properties are used to
* resolve variables in the XML.
*
* @param classLoader the ClassLoader used to load the resource.
* @param resource the classpath resource
* @throws IllegalArgumentException if classLoader or resource is null, or if the resource is not found.
* @throws com.hazelcast.core.HazelcastException if the XML content is invalid
*/
public ClasspathXmlConfig(ClassLoader classLoader, String resource) {
this(classLoader, resource, System.getProperties());
}
/**
* Creates a config which is loaded from a classpath resource.
*
* @param classLoader the ClassLoader used to load the resource.
* @param resource the classpath resource
* @param properties to properties used to resolve variables in the XML.
* @throws IllegalArgumentException if classLoader or resource is null, or if the resource is not found.
* @throws com.hazelcast.core.HazelcastException if the XML content is invalid
*/
public ClasspathXmlConfig(ClassLoader classLoader, String resource, Properties properties) {
if (classLoader == null) {
throw new IllegalArgumentException("classLoader can't be null");
}
if (resource == null) {
throw new IllegalArgumentException("resource can't be null");
}
if (properties == null) {
throw new IllegalArgumentException("properties can't be null");
}
LOGGER.info("Configuring Hazelcast from '" + resource + "'.");
InputStream in = classLoader.getResourceAsStream(resource);
if (in == null) {
throw new IllegalArgumentException("Specified resource '" + resource + "' could not be found!");
}
new XmlConfigBuilder(in).setProperties(properties).build(this);
}
}