com.hazelcast.internal.config

Class DeclarativeConfigUtil

java.lang.Object

com.hazelcast.internal.config.DeclarativeConfigUtil

public final class DeclarativeConfigUtil
extends Object

Utility class for handling declarative configuration files.

Field Summary

Fields

Modifier and Type	Field and Description
static Collection<String>	ALL_ACCEPTED_SUFFIXES Array of the suffixes accepted in Hazelcast configuration files.
static String	ALL_ACCEPTED_SUFFIXES_STRING The list of the suffixes accepted in Hazelcast configuration files.
static String	SYSPROP_CLIENT_CONFIG System property used for defining the configuring file used for client configuration.
static String	SYSPROP_CLIENT_FAILOVER_CONFIG System property used for defining the configuring file used for client failover configuration.
static String	SYSPROP_MEMBER_CONFIG System property used for defining the configuring file used for member configuration.
static Collection<String>	XML_ACCEPTED_SUFFIXES Array of accepted suffixes for XML configuration files.
static String	XML_ACCEPTED_SUFFIXES_STRING List of accepted suffixes for XML configuration files.
static Collection<String>	YAML_ACCEPTED_SUFFIXES Array of accepted suffixes for YAML configuration files.
static String	YAML_ACCEPTED_SUFFIXES_STRING List of accepted suffixes for YAML configuration files.

Method Summary

Modifier and Type	Method and Description
static boolean	isAcceptedSuffixConfigured(String configFile, Collection<String> acceptedSuffixes) Checks if the suffix of the passed configFile is in the accepted suffixes list passed in acceptedSuffixes.
static void	throwUnacceptedSuffixInSystemProperty(String propertyKey, String configResource, Collection<String> acceptedSuffixes) Throws HazelcastException unconditionally referring to that the configuration file referenced in the system property propertyKey has a suffix not in the accepted suffix list defined in acceptedSuffixes.
static void	validateSuffixInSystemProperty(String propertyKey) Validates if the config file referenced in propertyKey has an accepted suffix.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYSPROP_MEMBER_CONFIG

public static final String SYSPROP_MEMBER_CONFIG

System property used for defining the configuring file used for member configuration.

See Also:

Constant Field Values

SYSPROP_CLIENT_CONFIG

public static final String SYSPROP_CLIENT_CONFIG

System property used for defining the configuring file used for client configuration.

See Also:

Constant Field Values

SYSPROP_CLIENT_FAILOVER_CONFIG

public static final String SYSPROP_CLIENT_FAILOVER_CONFIG

System property used for defining the configuring file used for client failover configuration.

See Also:

Constant Field Values

XML_ACCEPTED_SUFFIXES

public static final Collection<String> XML_ACCEPTED_SUFFIXES

Array of accepted suffixes for XML configuration files.

XML_ACCEPTED_SUFFIXES_STRING

public static final String XML_ACCEPTED_SUFFIXES_STRING

List of accepted suffixes for XML configuration files.

See Also:

XML_ACCEPTED_SUFFIXES

YAML_ACCEPTED_SUFFIXES

public static final Collection<String> YAML_ACCEPTED_SUFFIXES

Array of accepted suffixes for YAML configuration files.

YAML_ACCEPTED_SUFFIXES_STRING

public static final String YAML_ACCEPTED_SUFFIXES_STRING

List of accepted suffixes for YAML configuration files.

See Also:

YAML_ACCEPTED_SUFFIXES

ALL_ACCEPTED_SUFFIXES

public static final Collection<String> ALL_ACCEPTED_SUFFIXES

Array of the suffixes accepted in Hazelcast configuration files.

ALL_ACCEPTED_SUFFIXES_STRING

public static final String ALL_ACCEPTED_SUFFIXES_STRING

The list of the suffixes accepted in Hazelcast configuration files.

See Also:

ALL_ACCEPTED_SUFFIXES

Method Detail

validateSuffixInSystemProperty

public static void validateSuffixInSystemProperty(String propertyKey)

Validates if the config file referenced in propertyKey has an accepted suffix. If the system property is not set, the validation passes without throwing exception.

Parameters:

propertyKey - The name of the system property to validate

Throws:

HazelcastException - If the suffix of the config file name is not in the accepted suffix list

throwUnacceptedSuffixInSystemProperty

public static void throwUnacceptedSuffixInSystemProperty(String propertyKey,
                                                         String configResource,
                                                         Collection<String> acceptedSuffixes)

Throws HazelcastException unconditionally referring to that the configuration file referenced in the system property propertyKey has a suffix not in the accepted suffix list defined in acceptedSuffixes.

Parameters:

propertyKey - The name of the system property key holding the reference to the configuration file

configResource - The value of the system property

acceptedSuffixes - The list of the accepted suffixes

Throws:

HazelcastException - Thrown unconditionally with a message referring to the unaccepted suffix of the file referenced by propertyKey

isAcceptedSuffixConfigured

public static boolean isAcceptedSuffixConfigured(String configFile,
                                                 Collection<String> acceptedSuffixes)

Checks if the suffix of the passed configFile is in the accepted suffixes list passed in acceptedSuffixes.

Parameters:

configFile - The configuration file to check

acceptedSuffixes - The list of the accepted suffixes

Returns:

true if the suffix of the configuration file is in the accepted list, false otherwise