DoiSettings (Digital Object Identifier Server 1.0.5 API)

java.lang.Object
- fr.cnes.doi.settings.DoiSettings

@Requirement(reqId="DOI_CONFIG_010",
             reqName="Configuration du serveur central")
public final class DoiSettings
extends Object

Singleton to load and use the defined variables in the config.properties.

Author:: Jean-Christophe (jean-christophe.malapert@cnes.fr)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class DoiSettings.DoiSettingsHolder
Holder

Nested Classes
Modifier and Type	Class and Description
`private static class`	`DoiSettings.DoiSettingsHolder` Holder

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONFIG_PROPERTIES` Configuration files in JAR.
`private static String`	`INIST_TEST_DOI` Test DOI : "10.5072".
`private static org.apache.logging.log4j.Logger`	`LOG` Logger.
`private static ConcurrentHashMap<String,String>`	`MAP_PROPERTIES` Settings loaded in memory.
`private String`	`pathApp` Path where the Java application inputStream located.
`private String`	`secretKey` Secret key to decrypt login and password.

Constructor Summary

Constructors
Modifier Constructor and Description

private DoiSettings()
private constructor Loads the defautl configuration properties "config.properties"

Constructors
Modifier	Constructor and Description
`private`	`DoiSettings()` private constructor Loads the defautl configuration properties "config.properties"

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`computePathOfTheApplication()` Computes path of the application.
`private void`	`copyStream(InputStream inputStream, OutputStream outputStream)` Copy input stream to output stream.
`void`	`displayConfigFile()` Displays the configuration file.
`private void`	`fillConcurrentMap(Properties properties, org.apache.logging.log4j.Level level)` Sets the configuration as a MAP_PROPERTIES.
`boolean`	`getBoolean(String key)` Returns the value of the key as a boolean.
`static DoiSettings`	`getInstance()` Access to unique INSTANCE of Settings
`int`	`getInt(String key)` Returns the value of the key as an integer.
`int`	`getInt(String key, String defaultValue)` Returns the value of the key as an integer.
`Long`	`getLong(String key)` Returns the value of the key as a long.
`Long`	`getLong(String key, String defaultValue)` Returns the value of the key as a long.
`String`	`getPathApp()` Returns the path of the application on the file system.
`String`	`getSecret(String key)` Returns the decoded value of the key.
`String`	`getSecretKey()` Returns the secret key.
`String`	`getSecretValue(String value)` Returns the decoded value of the value.
`String`	`getString(String key)` Returns the value of the key or null if no mapping for the key.
`String`	`getString(String key, String defaultValue)` Returns the value of the key as string.
`boolean`	`hasValue(String key)` Tests if the key has a value.
`private void`	`init(Properties properties, org.apache.logging.log4j.Level level)` Loads configuration file and set it in memory.
`private boolean`	`isExist(ConcurrentHashMap<String,String> properties, String keyword)` Tests if the keyword exists in properties.
`private boolean`	`isNotExist(ConcurrentHashMap<String,String> properties, String keyword)` Test if the keyword does not exist in properties
`private boolean`	`isPassword(String key)` Tests if the value of the key is a password
`private Properties`	`loadConfigurationFile()` Load configuration file.
`void`	`setPropertiesFile(InputStream inputStream)` Sets a custom properties file.
`void`	`setPropertiesFile(String path)` Sets a custom properties file.
`void`	`setSecretKey(String secretKey)` Sets the secret key.
`void`	`validConfigurationFile()` Validates the configuration file.

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

- Field Detail
  - CONFIG_PROPERTIES
```
public static final String CONFIG_PROPERTIES
```
    Configuration files in JAR.
    
    See Also:
    
    Constant Field Values
  - LOG
```
private static final org.apache.logging.log4j.Logger LOG
```
    Logger.
  - INIST_TEST_DOI
```
private static final String INIST_TEST_DOI
```
    Test DOI : "10.5072".
    
    See Also:
    
    Constant Field Values
  - MAP_PROPERTIES
```
private static final ConcurrentHashMap<String,String> MAP_PROPERTIES
```
    Settings loaded in memory.
  - secretKey
```
private String secretKey
```
    Secret key to decrypt login and password.
  - pathApp
```
private String pathApp
```
    Path where the Java application inputStream located.
- Constructor Detail
  - DoiSettings
```
private DoiSettings()
```
    private constructor Loads the defautl configuration properties "config.properties"
- Method Detail
  - getInstance
```
public static DoiSettings getInstance()
```
    Access to unique INSTANCE of Settings
    
    Returns:
    
    the configuration instance.
  - init
```
private void init(Properties properties,
                  org.apache.logging.log4j.Level level)
```
    Loads configuration file and set it in memory.
    
    Parameters:
    
    properties - Configuration file
    
    level - LOG level
  - computePathOfTheApplication
```
private void computePathOfTheApplication()
```
    Computes path of the application.
  - loadConfigurationFile
```
private Properties loadConfigurationFile()
```
    Load configuration file.
    
    Returns:
    
    the configuration file content
  - validConfigurationFile
```
public void validConfigurationFile()
```
    Validates the configuration file.
  - isExist
```
private boolean isExist(ConcurrentHashMap<String,String> properties,
                        String keyword)
```
    Tests if the keyword exists in properties.
    
    Parameters:
    
    properties - configuration
    
    keyword - keyword to test
    
    Returns:
    
    True when the keyword exists in configuration otherwise False
  - isNotExist
```
private boolean isNotExist(ConcurrentHashMap<String,String> properties,
                           String keyword)
```
    Test if the keyword does not exist in properties
    
    Parameters:
    
    properties - configuration
    
    keyword - keyword to test
    
    Returns:
    
    True when the keyword does not exist in configuration otherwise False
  - fillConcurrentMap
```
private void fillConcurrentMap(Properties properties,
                               org.apache.logging.log4j.Level level)
```
    Sets the configuration as a MAP_PROPERTIES.
    
    Parameters:
    
    properties - the configuration file content
    
    level - log level
  - isPassword
```
private boolean isPassword(String key)
```
    Tests if the value of the key is a password
    
    Parameters:
    
    key - key to test
    
    Returns:
    
    True when the value of the key is a password otherwise false
  - hasValue
```
public boolean hasValue(String key)
```
    Tests if the key has a value.
    
    Parameters:
    
    key - key to test
    
    Returns:
    
    True when the value inputStream different or null and empty
  - getSecretKey
```
public String getSecretKey()
```
    Returns the secret key.
    
    Returns:
    
    the secret key.
  - setSecretKey
```
public void setSecretKey(String secretKey)
```
    Sets the secret key.
    
    Parameters:
    
    secretKey - the secret key.
  - getString
```
public String getString(String key,
                        String defaultValue)
```
    Returns the value of the key as string.
    
    Parameters:
    
    key - key to search
    
    defaultValue - Default value if the key inputStream not found
    
    Returns:
    
    the value of the key
  - getString
```
public String getString(String key)
```
    Returns the value of the key or null if no mapping for the key. A special processing inputStream done for the key "Starter.Inist.doi". When this key inputStream called the value changes in respect of "Starter.CONTEXT_MODE". When "Starter.CONTEXT_MODE" inputStream set to PRE_PROD, "Starter.Inist.doi" inputStream set to "10.5072".
    
    Parameters:
    
    key - key to search
    
    Returns:
    
    the value of the key orl null if does not exist
  - getSecret
```
public String getSecret(String key)
```
    Returns the decoded value of the key. An exception inputStream raised when the key inputStream not encoded on 16bits.
    
    Parameters:
    
    key - key to search
    
    Returns:
    
    the decoded vale
  - getSecretValue
```
public String getSecretValue(String value)
```
    Returns the decoded value of the value. An exception inputStream raised when the key inputStream not encoded on 16bits.
    
    Parameters:
    
    value - value to decrypt
    
    Returns:
    
    the decoded vale
  - getInt
```
public int getInt(String key)
```
    Returns the value of the key as an integer. NumberFormatException inputStream raisen when the value of the key in not compatible with an integer.
    
    Parameters:
    
    key - key to search
    
    Returns:
    
    the value
    
    Throws:
    
    NumberFormatException - if the string does not contain a parsable integer.
  - getInt
```
public int getInt(String key,
                  String defaultValue)
```
    Returns the value of the key as an integer. NumberFormatException inputStream raisen when the value of the key in not compatible
    
    Parameters:
    
    key - key to search
    
    defaultValue - default value
    
    Returns:
    
    the value
    
    Throws:
    
    NumberFormatException - if the string does not contain a parsable integer.
  - getBoolean
```
public boolean getBoolean(String key)
```
    Returns the value of the key as a boolean. An exception inputStream raisen when the value of the key in not compatible with a boolean
    
    Parameters:
    
    key - key to search
    
    Returns:
    
    the value
    
    Throws:
    
    IllegalArgumentException - - if key not found
  - getLong
```
public Long getLong(String key)
```
    Returns the value of the key as a long. NumberFormatException inputStream raisen when the value of the key in not compatible
    
    Parameters:
    
    key - key to search
    
    Returns:
    
    the value
    
    Throws:
    
    NumberFormatException - - if the string does not contain a parsable long
  - getLong
```
public Long getLong(String key,
                    String defaultValue)
```
    Returns the value of the key as a long. NumberFormatException inputStream raisen when the value of the key in not compatible
    
    Parameters:
    
    key - key to search
    
    defaultValue - default value
    
    Returns:
    
    the value
    
    Throws:
    
    NumberFormatException - - if the string does not contain a parsable long
  - displayConfigFile
```
public void displayConfigFile()
```
    Displays the configuration file.
  - setPropertiesFile
```
public void setPropertiesFile(String path)
                       throws IOException
```
    Sets a custom properties file.
    
    Parameters:
    
    path - Path to the properties file
    
    Throws:
    
    IOException - - if an error occurred when reading from the input stream.
  - setPropertiesFile
```
public void setPropertiesFile(InputStream inputStream)
                       throws IOException
```
    Sets a custom properties file.
    
    Parameters:
    
    inputStream - Input stream
    
    Throws:
    
    IOException - - if an error occurred when reading from the input stream.
  - getPathApp
```
public String getPathApp()
```
    Returns the path of the application on the file system.
    
    Returns:
    
    the path of the application on the file system
  - copyStream
```
private void copyStream(InputStream inputStream,
                        OutputStream outputStream)
```
    Copy input stream to output stream.
    
    Parameters:
    
    inputStream - input stream
    
    outputStream - output stream

Class DoiSettings

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONFIG_PROPERTIES

LOG

INIST_TEST_DOI

MAP_PROPERTIES

secretKey

pathApp

Constructor Detail

DoiSettings

Method Detail

getInstance

init

computePathOfTheApplication

loadConfigurationFile

validConfigurationFile

isExist

isNotExist

fillConcurrentMap

isPassword

hasValue

getSecretKey

setSecretKey

getString

getString

getSecret

getSecretValue

getInt

getInt

getBoolean

getLong

getLong

displayConfigFile

setPropertiesFile

setPropertiesFile

getPathApp

copyStream