com.hazelcast.spi.properties.HazelcastProperties Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2024, 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.spi.properties;
import com.hazelcast.config.Config;
import java.util.Properties;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import static com.hazelcast.internal.util.StringUtil.equalsIgnoreCase;
import static java.lang.String.format;
import static java.util.Collections.unmodifiableSet;
/**
* Container for configured Hazelcast properties (see {@link HazelcastProperty}).
*
* A {@link HazelcastProperty} can be set as:
*
* - a system property using {@link System#setProperty(String, String)}
* - the programmatic configuration using {@link Config#setProperty(String, String)}
* - the XML configuration
*
*
* @see
* System properties documentaiton
*/
public class HazelcastProperties {
private final Set keys;
private final Properties properties = new Properties();
private Config config;
/**
* Creates a container with configured Hazelcast properties.
*
* Uses the system property value if no value is defined in the configuration.
* Uses the default value if no system property value is defined.
*
* @param config {@link Config} used to configure the {@link HazelcastProperty} values;
* properties in config are allowed to be {@code null}
*/
public HazelcastProperties(Config config) {
this(config.getProperties());
this.config = config;
}
/**
* Creates a container with configured Hazelcast properties.
*
* Uses the system property value if no value is defined in the configuration.
* Uses the default value if no system property value is defined.
*
* @param nullableProperties {@link Properties} used to configure the {@link HazelcastProperty} values;
* properties are allowed to be {@code null}
*/
@SuppressWarnings("unchecked")
public HazelcastProperties(Properties nullableProperties) {
if (nullableProperties != null) {
properties.putAll(nullableProperties);
}
this.keys = unmodifiableSet((Set) properties.keySet());
}
protected Config getConfig() {
return config;
}
/**
* Returns an immutable set of all keys in this HazelcastProperties.
*
* @return set of keys
*/
public Set keySet() {
return keys;
}
/**
* Returns the value for the given key.
* If this {@code HazelcastProperties} object is initialized with a
* "compromised" {@link Properties} object (ie one where keys/values of types
* other than {@code String} have been inserted), then {@code get} on {@code String} keys
* mapped to non-{@code String} values will return {@code null},
* similarly to {@link Properties#getProperty(String)}.
*
* @param key the key
* @return the value for the given key, or {@code null} if no value is found
* @throws NullPointerException if key is {@code null}
*/
public String get(String key) {
return properties.getProperty(key);
}
/**
* Returns the configured value of a {@link HazelcastProperty} as String.
*
* @param property the {@link HazelcastProperty} to get the value from
* @return the value or {@code null} if nothing has been configured
*/
public String getString(HazelcastProperty property) {
String value = properties.getProperty(property.getName());
if (value != null) {
return value;
}
value = property.getSystemProperty();
if (value != null) {
return value;
}
HazelcastProperty parent = property.getParent();
if (parent != null) {
return getString(parent);
}
String deprecatedName = property.getDeprecatedName();
if (deprecatedName != null) {
value = get(deprecatedName);
if (value == null) {
value = System.getProperty(deprecatedName);
}
if (value != null) {
// we don't have a logger available, and the Logging service is constructed after the Properties are created.
System.err.print("Don't use deprecated '" + deprecatedName + "' "
+ "but use '" + property.getName() + "' instead. "
+ "The former name will be removed in the next Hazelcast release.");
return value;
}
}
Function function = property.getFunction();
if (function != null) {
return "" + function.apply(this);
}
return property.getDefaultValue();
}
/**
* Returns true if value for given key is provided (either as a HazelcastProperty or a System property). Default values are
* not taken into account.
*
* @param property the {@link HazelcastProperty} to check
* @return {@code true} if the value was explicitly provided
*/
public boolean containsKey(HazelcastProperty property) {
if (property == null) {
return false;
}
return containsKey(property.getName())
|| containsKey(property.getParent())
|| containsKey(property.getDeprecatedName());
}
private boolean containsKey(String propertyName) {
if (propertyName == null) {
return false;
}
return properties.containsKey(propertyName)
|| System.getProperty(propertyName) != null;
}
/**
* Returns the configured boolean value of a {@link HazelcastProperty}.
*
* @param property the {@link HazelcastProperty} to get the value from
* @return the value as boolean
*/
public boolean getBoolean(HazelcastProperty property) {
return Boolean.parseBoolean(getString(property));
}
/**
* Returns the configured int value of a {@link HazelcastProperty}.
*
* @param property the {@link HazelcastProperty} to get the value from
* @return the value as int
* @throws NumberFormatException if the value cannot be parsed
*/
public int getInteger(HazelcastProperty property) {
return Integer.parseInt(getString(property));
}
/**
* Returns the configured long value of a {@link HazelcastProperty}.
*
* @param property the {@link HazelcastProperty} to get the value from
* @return the value as long
* @throws NumberFormatException if the value cannot be parsed
*/
public long getLong(HazelcastProperty property) {
return Long.parseLong(getString(property));
}
/**
* Returns the configured float value of a {@link HazelcastProperty}.
*
* @param property the {@link HazelcastProperty} to get the value from
* @return the value as float
* @throws NumberFormatException if the value cannot be parsed
*/
public float getFloat(HazelcastProperty property) {
return Float.valueOf(getString(property));
}
/**
* Returns the configured double value of a {@link HazelcastProperty}.
*
* @param property the {@link HazelcastProperty} to get the value from
* @return the value as double
* @throws NumberFormatException if the value cannot be parsed
*/
public double getDouble(HazelcastProperty property) {
return Double.valueOf(getString(property));
}
/**
* Returns the configured value of a {@link HazelcastProperty} converted to nanoseconds.
*
* @param property the {@link HazelcastProperty} to get the value from
* @return the value in nanoseconds
* @throws IllegalArgumentException if the {@link HazelcastProperty} has no {@link TimeUnit}
*/
public long getNanos(HazelcastProperty property) {
TimeUnit timeUnit = property.getTimeUnit();
return timeUnit.toNanos(getLong(property));
}
/**
* Returns the configured value of a {@link HazelcastProperty} converted to milliseconds.
*
* @param property the {@link HazelcastProperty} to get the value from
* @return the value in milliseconds
* @throws IllegalArgumentException if the {@link HazelcastProperty} has no {@link TimeUnit}
*/
public long getMillis(HazelcastProperty property) {
TimeUnit timeUnit = property.getTimeUnit();
return timeUnit.toMillis(getLong(property));
}
/**
* Returns the configured value of a {@link HazelcastProperty} converted to milliseconds if
* it is positive, otherwise returns its default value.
*
* @param property the {@link HazelcastProperty} to get the value from
* @return the value in milliseconds if it is positive, otherwise its default value.
* @throws IllegalArgumentException if the {@link HazelcastProperty} has no {@link TimeUnit}
*/
public long getPositiveMillisOrDefault(HazelcastProperty property) {
return getPositiveMillisOrDefault(property, Long.parseLong(property.getDefaultValue()));
}
/**
* Returns the configured value of a {@link HazelcastProperty} converted to milliseconds if
* it is positive, otherwise returns the passed default value.
*
* @param property the {@link HazelcastProperty} to get the value from
* @param defaultValue the default value to return if property has non positive value.
* @return the value in milliseconds if it is positive, otherwise the passed default value.
* @throws IllegalArgumentException if the {@link HazelcastProperty} has no {@link TimeUnit}
*/
public long getPositiveMillisOrDefault(HazelcastProperty property, long defaultValue) {
long millis = getMillis(property);
return millis > 0 ? millis : defaultValue;
}
/**
* Returns the configured value of a {@link HazelcastProperty} converted to seconds.
*
* @param property the {@link HazelcastProperty} to get the value from
* @return the value in seconds
* @throws IllegalArgumentException if the {@link HazelcastProperty} has no {@link TimeUnit}
*/
public int getSeconds(HazelcastProperty property) {
TimeUnit timeUnit = property.getTimeUnit();
return (int) timeUnit.toSeconds(getLong(property));
}
/**
* Returns the configured enum value of a {@link ClusterProperty}.
*
* The case of the enum is ignored.
*
* @param property the {@link ClusterProperty} to get the value from
* @param the enum type
* @return the enum
* @throws IllegalArgumentException if the enum value can't be found
*/
public E getEnum(HazelcastProperty property, Class enumClazz) {
String value = getString(property);
for (E enumConstant : enumClazz.getEnumConstants()) {
if (equalsIgnoreCase(enumConstant.name(), value)) {
return enumConstant;
}
}
throw new IllegalArgumentException(format("value '%s' for property '%s' is not a valid %s value",
value, property.getName(), enumClazz.getName()));
}
}