com.varra.props

Class VarraProperties

java.lang.Object

com.varra.props.VarraProperties

All Implemented Interfaces:

Constants

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public final class VarraProperties
extends Object
implements Constants

Loads the Properties from the environment, system and file, make them Available to rest of the application. Note: It can be used to load the properties from Spring xml file or a plain .properties file.

Version:

1.0

Author:

Rajakrishna V. Reddy

Field Summary

Fields inherited from interface com.varra.props.Constants

CR, DEF_MONITORING_INTERVAL, ENV_VARIABLE_REGEX, FIRST_PART, GT_KEEP_ALIVE_TIME_DEFAULT_VALUE, GT_KEEP_ALIVE_TIME_PROPERTY, LF, LOG_PROPS_FILE, LOG_XML_FILE, NEW_LINE, OS_DOMAIN, RAPID_TYPE, RAPIDAPPSERVER_HOME, REPLACE_UNKNOWN_2_SPACE_PROPERTY, RESOLVE_REQUIRED_PROPERTY, RUNTIME_DOMAIN, SECOND_PART, SPRING_CONTEXT_ENABLED, SPRING_CONTEXT_FILE, TAB, THIS_INTERVAL_PROPERTY, THREADING_DOMAIN, UTF_8

Method Summary

Modifier and Type	Method and Description
static boolean	addApplicationProperties(ApplicationProperties properties) Adds the application properties.
static Map<? extends Object,? extends Object>	getAppProperties(String fileName) Gets the application property.
static Object	getAppProperty(String propName) Gets the application property.
static Object	getAppProperty(String fileName, String propName) Gets the application property.
static boolean	getBooleanProperty(String propName, boolean defValue) Deprecated.
static int	getIntegerProperty(String propName, int defValue) Deprecated.
static Object	getProperty(String propName) Gets the global property, it could be a SpringContext bean, application monitoring property or an environment property.
static Object	getProperty(String propName, Object defValue) Gets the property value if it is available, else returns the defValue provided.
static <T> T	getPropertyAsGeneric(String propName) Gets the property as generic, But be careful in taking care of TYPE while using it.
static <T> T	getPropertyAsGeneric(String propName, Class<T> klass) Gets the property as generic, But be careful in taking care of TYPE while using it.
static Set<ApplicationProperties>	getPropertyFileList() Gets the property file list, contains only the valid.
static String	getSystemProperty(String propName) Gets the system property.
static <T> T	getWrapperProperty(String propName, T defValue) Gets the property value if it is available, else returns the defValue provided.
static void	registerPropertyChangeListener(PropertyChangeListener listener, String... properties) Register property change listener.
static boolean	removeApplicationProperties(ApplicationProperties properties) Removes the application properties.
static void	setProperty(String propName, Object value) Sets the property.
static void	setProperty(String propName, Object value, Object source) Sets the property.
static void	setSystemProperty(String propName, String value) Sets the system property.
static void	startMonitoring() Deprecated.
static List<String>	startsWith(String prefix) Gets the global property, it could be a SpringContext bean, application monitoring property or an environment property which starts with the given prefix.
static void	unregisterPropertyChangeListener(PropertyChangeListener listener) Unregister property change listener.
static void	unregisterPropertyChangeListener(String property, PropertyChangeListener listener) Unregister property change listener.

Methods inherited from class java.lang.Object

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

Method Detail

getPropertyAsGeneric

public static <T> T getPropertyAsGeneric(String propName)

Gets the property as generic, But be careful in taking care of TYPE while using it.

For Best Implementation and correctness use getPropertyAsGeneric(String, Class).

Type Parameters:

T - the generic type

Parameters:

propName - the prop name

Returns:

the property as generic

Since:

3.0

See Also:

getPropertyAsGeneric(String, Class)

getPropertyAsGeneric

public static <T> T getPropertyAsGeneric(String propName,
                                         Class<T> klass)

Gets the property as generic, But be careful in taking care of TYPE while using it.

Type Parameters:

T - the generic type

Parameters:

propName - the prop name

klass - the klass

Returns:

the property as generic

Since:

3.0

getProperty

public static Object getProperty(String propName)

Gets the global property, it could be a SpringContext bean, application monitoring property or an environment property.

Parameters:

propName - the prop name

Returns:

the property

getAppProperty

public static Object getAppProperty(String propName)

Gets the application property.

Parameters:

propName - the prop name

Returns:

the application property

getAppProperty

public static Object getAppProperty(String fileName,
                                    String propName)

Gets the application property.

Parameters:

propName - the prop name

Returns:

the application property

getAppProperties

public static Map<? extends Object,? extends Object> getAppProperties(String fileName)

Gets the application property.

Parameters:

fileName - the file name

Returns:

the application properties

getSystemProperty

public static String getSystemProperty(String propName)

Gets the system property.

Parameters:

propName - the prop name

Returns:

the system property

getProperty

public static Object getProperty(String propName,
                                 Object defValue)

Gets the property value if it is available, else returns the defValue provided.

Parameters:

propName - the prop name

defValue - the default value

Returns:

the property

getIntegerProperty

@Deprecated
public static int getIntegerProperty(String propName,
                                                 int defValue)

Deprecated.

Gets the property value if it is available, else returns the defValue provided. Note: start using getWrapperProperty(String, Object), as it is @Deprecated.

Parameters:

propName - the prop name

defValue - the default value

Returns:

the property

getBooleanProperty

@Deprecated
public static boolean getBooleanProperty(String propName,
                                                     boolean defValue)

Deprecated.

Gets the property value if it is available, else returns the defValue provided. Note: start using getWrapperProperty(String, Object), as it is @deprecated.

Parameters:

propName - the prop name

defValue - the default value

Returns:

the property

getWrapperProperty

public static <T> T getWrapperProperty(String propName,
                                       T defValue)

Gets the property value if it is available, else returns the defValue provided.

Type Parameters:

T - the generic type

Parameters:

propName - the prop name

defValue - the default value

Returns:

the property

Since:

3.0

startsWith

public static List<String> startsWith(String prefix)

Gets the global property, it could be a SpringContext bean, application monitoring property or an environment property which starts with the given prefix.

Parameters:

prefix - the prefix

Returns:

the list

setProperty

public static void setProperty(String propName,
                               Object value)

Sets the property.

Parameters:

propName - the prop name

value - the value

setSystemProperty

public static void setSystemProperty(String propName,
                                     String value)

Sets the system property.

Parameters:

propName - the prop name

value - the value

Since:

3.0

setProperty

public static void setProperty(String propName,
                               Object value,
                               Object source)

Sets the property.

Parameters:

propName - the prop name

value - the value

source - the source

getPropertyFileList

public static Set<ApplicationProperties> getPropertyFileList()

Gets the property file list, contains only the valid.

Returns:

the propertyFileList ApplicationProperties entries.

addApplicationProperties

public static boolean addApplicationProperties(ApplicationProperties properties)
                                        throws PropertyFileLoaderException

Adds the application properties.

Parameters:

properties - the properties

Returns:

true, if successful

Throws:

PropertyFileLoaderException - the property file loader exception

removeApplicationProperties

public static boolean removeApplicationProperties(ApplicationProperties properties)

Removes the application properties.

Parameters:

properties - the properties

Returns:

true, if successful

registerPropertyChangeListener

public static void registerPropertyChangeListener(PropertyChangeListener listener,
                                                  String... properties)
                                           throws VarraPropertiesException

Register property change listener.

Parameters:

listener - the listener

properties - the properties

Throws:

VarraPropertiesException - the mind tree properties exception

unregisterPropertyChangeListener

public static void unregisterPropertyChangeListener(String property,
                                                    PropertyChangeListener listener)

Unregister property change listener.

Parameters:

property - the property

listener - the listener

unregisterPropertyChangeListener

public static void unregisterPropertyChangeListener(PropertyChangeListener listener)

Unregister property change listener.

Parameters:

listener - the listener

startMonitoring

@Deprecated
public static void startMonitoring()

Deprecated.

Starts monitoring thread, if not started earlier.

Since:

3.0 this is automated, whenever listeners are registered, this will be started, hence no need to call it manually.