PropertyFrameworkGlobals (JHPropertiesTyped

java.lang.Object
- dk.heick.properties.PropertyFrameworkGlobals

All Implemented Interfaces:

Serializable
```
public class PropertyFrameworkGlobals
extends Object
implements Serializable
```
Contains different static parameters, which is used by the framework.
This is used to override certain default behaviours, which is rarely a need for but nice to have the option.
IMPORTANT:When setting global paramenters, remember to reload your collection if caching is ON.

Since:

1.1

Author:

Frederik Heick

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static class PropertyFrameworkGlobals.GlobalPropertyStaticCollection

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`PropertyFrameworkGlobals.GlobalPropertyStaticCollection`

Constructor Summary

Constructors
Constructor and Description

PropertyFrameworkGlobals()

Constructors
Constructor and Description
`PropertyFrameworkGlobals()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`doAutoEncryptPasswords()` Gets the framework override for `autoEncrypts` a password in `PasswordPropertyType`.
`static boolean`	`doAutoRegisterPropertyCollections()` Gets if all PropertyCollections shall automatically register it self in `PropertyCollectionRegistry`.
`static boolean`	`doDisardValueQuotes()` Gets if values loaded from PropertyIO should have any "" or '' removed before further validation.
`static boolean`	`doLogDebugFrameworkPerformance()` If framework performance should be logged as a debug message.
`static boolean`	`doLogFileValidations()` Shall the framework log a message everytime its use a FileValidator.
`static boolean`	`doLogWarningIfUsingDefaultValues()` Do the framework logs a warning if the a property cant be loaded and the default value is used instead.
`static boolean`	`doReplaceInlinedProperties()` Do the framework replace inline values.
`static boolean`	`doUseDefaultValues()` Do the framework use default value set for the PropertyType is a valid value isnt found for a Property.
`static boolean`	`doValidateIPathPropertyTypes()` In PropertyCollection should Properties with a PropertyType which implements the marker interface "IPathPropertyType" be validated.
`static long`	`getDefaultPropertyIOCacheFlushingInMs()` Gets the time in milliseconds which is the default timeout value for the cache for any PropertyIO.
`static Proxy`	`getDefaultProxy()` Get the globally set Proxy.
`static double`	`getDoublePrecision()` When comparing two doubles, this value is total amount of difference two doubles must have absolute.
`static Localizer`	`getPropertyDescriptionLocalizer()` An implementation of the Localizer, from where Property will retrieve the description.
`static void`	`logGlobalProperties()` Logs all the values for the global propeties as info messages.
`static void`	`logGlobalPropertiesOnce()` Logs all the values for the global propeties as info messages, but only once.
`static void`	`resetGlobalSettings()` Resets all the global setting to default values and print them to the logger.
`static void`	`setAutoEncryptPasswords(boolean value)` Overrides general behaviour of PasswordPropertyType, no matter what the `autoEncrypt` is set to in the PasswordPropertyType.
`static void`	`setAutoRegisterPropertyCollections(boolean newAutoRegisterPropertyCollections)` Sets whether PropertyCollections automatically shall be registered in "PropertyCollectionRegistry".
`static void`	`setDefaultPropertyIOCacheFlushingInMs(long defaultPropertyIOCacheFlushingInMs)` Sets the time in milliseconds which is the default timeout value for the cache for any PropertyIO.
`static void`	`setDefaultProxy(Proxy defaultProxy)` Sets a proxy configuration, which can be used by the framework, currently only URLPropertyType is using this.
`static void`	`setDisardValueQuotes(boolean b_disardValueQuotes)` Sets wether values loaded from PropertyIO should have any "" or '' removed before further validation.
`static void`	`setDoublePrecision(double newDoublePrecision)` Sets the precision that two double maximum must have to determine them as equals.
`static void`	`setLogDebugFrameworkPerformance(boolean logDebugFrameworkPerformance)` Sets if framework performance should be logged as a debug message.
`static void`	`setLogFileValidations(boolean value)` Sets if the framework log a message everytime its use a FileValidator.
`static void`	`setLogWarningIfUsingDefaultValues(boolean value)` Set if a warning should be logged if the a property cant be loaded and the default value is used instead.
`static void`	`setPropertyDescriptionLocalizer(Localizer propertyDescriptionLocalizer)` Sets the implementation of the Property description localizer.
`static void`	`setReplaceInlinedProperties(boolean value)` Sets the value if "we" want to have replacement of System properties and System env variables of the loaded values.
`static void`	`setUseDefaultValues(boolean value)` Sets the global behaviour if the framework shall use default values set for a PropertyType, if a valid property value isnt found for a Property.
`static void`	`setValidateIPathPropertyTypes(boolean value)` Overrides general behaviour of PropertyTypes mark with the interface "IPathPropertyType".

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PropertyFrameworkGlobals
```
public PropertyFrameworkGlobals()
```
- Method Detail
  - logGlobalProperties
```
public static final void logGlobalProperties()
```
    Logs all the values for the global propeties as info messages.
  - logGlobalPropertiesOnce
```
public static final void logGlobalPropertiesOnce()
```
    Logs all the values for the global propeties as info messages, but only once. This is called by the AbstractPropertyIO at construction time.
    But it is ensured that the it is only displayed once in the log "file".
  - resetGlobalSettings
```
public static final void resetGlobalSettings()
```
    Resets all the global setting to default values and print them to the logger.
  - doReplaceInlinedProperties
```
public static final boolean doReplaceInlinedProperties()
```
    Do the framework replace inline values. From System.properties and System.env. Mark by the "${name}pattern.
    
    Returns:
    
    true if replacing inline values, otherwise false.
  - setReplaceInlinedProperties
```
public static final void setReplaceInlinedProperties(boolean value)
```
    Sets the value if "we" want to have replacement of System properties and System env variables of the loaded values.
    
    Parameters:
    
    value - true to replace inline values, otherwise false.
  - doLogWarningIfUsingDefaultValues
```
public static final boolean doLogWarningIfUsingDefaultValues()
```
    Do the framework logs a warning if the a property cant be loaded and the default value is used instead.
    
    Returns:
    
    log warning if default warning is used.
  - setLogWarningIfUsingDefaultValues
```
public static final void setLogWarningIfUsingDefaultValues(boolean value)
```
    Set if a warning should be logged if the a property cant be loaded and the default value is used instead.
    
    Parameters:
    
    value - true to log warning if default is used, otherwise false.
  - doUseDefaultValues
```
public static final boolean doUseDefaultValues()
```
    Do the framework use default value set for the PropertyType is a valid value isnt found for a Property.
    If no default value shall be used, null is returned.
    This can be useful, helps to ensure no misconfigurations.
    
    Returns:
    
    true if the framework uses default values for invalid properties, otherwise false.
  - setUseDefaultValues
```
public static final void setUseDefaultValues(boolean value)
```
    Sets the global behaviour if the framework shall use default values set for a PropertyType, if a valid property value isnt found for a Property. If not null is returned.
    
    Parameters:
    
    value - true if the framework shall use default values for invalid properties, otherwise false and null is returned.
  - doLogFileValidations
```
public static final boolean doLogFileValidations()
```
    Shall the framework log a message everytime its use a FileValidator.
    
    Returns:
    
    true if logs a message, otherwise false.
  - setLogFileValidations
```
public static final void setLogFileValidations(boolean value)
```
    Sets if the framework log a message everytime its use a FileValidator.
    
    Parameters:
    
    value - true to log, false if not.
  - doAutoEncryptPasswords
```
public static final boolean doAutoEncryptPasswords()
```
    Gets the framework override for autoEncrypts a password in PasswordPropertyType.
    
    Returns:
    
    true will auto encrypt password if setup in the PasswordPropertyType, if false the framework will NEVER autoEncrypts a password, even if set so.
    
    See Also:
    
    PasswordPropertyType
  - setAutoEncryptPasswords
```
public static final void setAutoEncryptPasswords(boolean value)
```
    Overrides general behaviour of PasswordPropertyType, no matter what the autoEncrypt is set to in the PasswordPropertyType.
    Note:This can be usefull in test modes.
    
    Parameters:
    
    value - true to set normal PasswordPropertyType behavior is executed, set to false than framework will NEVER autoEncrypts a password, even if set so.
    
    See Also:
    
    PasswordTypeVO, PasswordPropertyType
  - doValidateIPathPropertyTypes
```
public static final boolean doValidateIPathPropertyTypes()
```
    In PropertyCollection should Properties with a PropertyType which implements the marker interface "IPathPropertyType" be validated.
    
    Returns:
    
    true if PropertyTypes mark with "IPathPropertyType" should be validated otherwise false.
    
    See Also:
    
    FilePropertyType, DirectoryPropertyType, FileStructurePropertyType
  - setValidateIPathPropertyTypes
```
public static final void setValidateIPathPropertyTypes(boolean value)
```
    Overrides general behaviour of PropertyTypes mark with the interface "IPathPropertyType".
    Note:This can be usefull in test modes, when validating different property sets for different environment properly not pointing the same file structure.
    
    Parameters:
    
    value - true to validate PropertyTypes mark with "IPathPropertyType", set to false to never a PropertyCollecton will never validate then.
    
    See Also:
    
    FilePropertyType, DirectoryPropertyType, FileStructurePropertyType
  - getDoublePrecision
```
public static final double getDoublePrecision()
```
    When comparing two doubles, this value is total amount of difference two doubles must have absolute. Before they are validated as equals.
    
    Returns:
    
    the difference two doubles maximum must have to be determine as equals.
  - setDoublePrecision
```
public static final void setDoublePrecision(double newDoublePrecision)
                                     throws IllegalArgumentException
```
    Sets the precision that two double maximum must have to determine them as equals.
    Default value is 1.0E-12
    
    Parameters:
    
    newDoublePrecision - the new double equal precision.
    
    Throws:
    
    IllegalArgumentException - if value is above 0.01
  - doAutoRegisterPropertyCollections
```
public static final boolean doAutoRegisterPropertyCollections()
```
    Gets if all PropertyCollections shall automatically register it self in PropertyCollectionRegistry.
    
    Returns:
    
    true if they automatically registeres, otherwise false.
    
    Since:
    
    1.7
    
    See Also:
    
    PropertyCollectionRegistry
  - setAutoRegisterPropertyCollections
```
public static final void setAutoRegisterPropertyCollections(boolean newAutoRegisterPropertyCollections)
```
    Sets whether PropertyCollections automatically shall be registered in "PropertyCollectionRegistry".
    If setting the value to false, it will clear the registry.
    
    Parameters:
    
    newAutoRegisterPropertyCollections - should PropertyCollections automatically be registred.
    
    Since:
    
    1.7
    
    See Also:
    
    PropertyCollectionRegistry
  - getDefaultProxy
```
public static final Proxy getDefaultProxy()
```
    Get the globally set Proxy. Default is null.
    
    Returns:
    
    the proxy.
    
    Since:
    
    1.8
  - setDefaultProxy
```
public static final void setDefaultProxy(Proxy defaultProxy)
```
    Sets a proxy configuration, which can be used by the framework, currently only URLPropertyType is using this.
    
    Parameters:
    
    defaultProxy - the default proxy.
  - doDisardValueQuotes
```
public static final boolean doDisardValueQuotes()
```
    Gets if values loaded from PropertyIO should have any "" or '' removed before further validation.
    This option is default false.
    
    Returns:
    
    true if "" or '' is to remove around any value loaded, otherwise false.
    Since: 1.8 See Also: PropertyCollectionRegistry
  setDisardValueQuotes public static final void setDisardValueQuotes(boolean b_disardValueQuotes) Sets wether values loaded from PropertyIO should have any "" or '' removed before further validation. Parameters: b_disardValueQuotes - true if "" or '' has to removed around values. Since: 1.8 getPropertyDescriptionLocalizer public static final Localizer getPropertyDescriptionLocalizer() An implementation of the Localizer, from where Property will retrieve the description. Default is null. Set this in the "PropertyCollection.preValidation()" method override. Returns: the property description localizer implementation. Since: 1.8 See Also: Localizer, setPropertyDescriptionLocalizer(Localizer), Property.getDescription(), Property.getI18NName(), PropertyUtils.getI18NName(String, String), PropertyUtils.getPropertyI18NDescription(String) setPropertyDescriptionLocalizer public static final void setPropertyDescriptionLocalizer(Localizer propertyDescriptionLocalizer) Sets the implementation of the Property description localizer. Parameters: propertyDescriptionLocalizer - the localizer for the Property descriptions. Since: 1.8 See Also: Localizer, getPropertyDescriptionLocalizer(), Property.getDescription(), Property.getI18NName(), PropertyUtils.getI18NName(String, String), PropertyUtils.getPropertyI18NDescription(String) getDefaultPropertyIOCacheFlushingInMs public static long getDefaultPropertyIOCacheFlushingInMs() Gets the time in milliseconds which is the default timeout value for the cache for any PropertyIO. The value "-1" means that no timeout is the cache. If the cache time is exceeded than the value is re - retrieved from the PropertyIO. Returns: the default cache timeout value for any PropertyIO, is less than 1, no timeout is exceuted. See Also: PropertyIO.getCacheTime(), PropertyIO.setCacheTime(long) setDefaultPropertyIOCacheFlushingInMs public static void setDefaultPropertyIOCacheFlushingInMs(long defaultPropertyIOCacheFlushingInMs) Sets the time in milliseconds which is the default timeout value for the cache for any PropertyIO. Parameters: defaultPropertyIOCacheFlushingInMs - the default timeout in ms for PropertyIO cache. See Also: PropertyIO.getCacheTime(), PropertyIO.setCacheTime(long) doLogDebugFrameworkPerformance public static boolean doLogDebugFrameworkPerformance() If framework performance should be logged as a debug message. Default is false. Returns: the logDebugFrameworkPerformance If framework performance should be logged as a debug message. Default is false. setLogDebugFrameworkPerformance public static void setLogDebugFrameworkPerformance(boolean logDebugFrameworkPerformance) Sets if framework performance should be logged as a debug message. Default is false. Parameters: logDebugFrameworkPerformance - the logDebugFrameworkPerformance to set

Class PropertyFrameworkGlobals

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PropertyFrameworkGlobals

Method Detail

logGlobalProperties

logGlobalPropertiesOnce

resetGlobalSettings

doReplaceInlinedProperties

setReplaceInlinedProperties

doLogWarningIfUsingDefaultValues

setLogWarningIfUsingDefaultValues

doUseDefaultValues

setUseDefaultValues

doLogFileValidations

setLogFileValidations

doAutoEncryptPasswords

setAutoEncryptPasswords

doValidateIPathPropertyTypes

setValidateIPathPropertyTypes

getDoublePrecision

setDoublePrecision

doAutoRegisterPropertyCollections

setAutoRegisterPropertyCollections

getDefaultProxy

setDefaultProxy

doDisardValueQuotes

setDisardValueQuotes

getPropertyDescriptionLocalizer

setPropertyDescriptionLocalizer

getDefaultPropertyIOCacheFlushingInMs

setDefaultPropertyIOCacheFlushingInMs

doLogDebugFrameworkPerformance

setLogDebugFrameworkPerformance