Configuration (Demoiselle Signature Core 4.4.0 API)

java.lang.Object
- org.demoiselle.signer.core.keystore.loader.configuration.Configuration

```
public class Configuration
extends Object
```
Class responsible for retrieving system information, such as operating system version and JVM version. It also manipulates PKCS # 11 driver information to be used by the component. You can add a PKCS # 11 Driver at run time, not restricting the use of only the drivers configured on the component.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`CONFIG_FILE_DIR` Document constant.
`protected static String`	`CONFIG_FILE_PATH` Document constant.
`protected static String`	`CUSTOM_CONFIG_FILENAME` Document constant.
`protected static String`	`CUSTOM_CONFIG_PATH` Document constant.
`protected static String`	`FILE_SEPARATOR` Document constant.
`protected static String`	`KEY_JAVA_VERSION` Document constant.
`protected static String`	`KEY_OS_NAME` Document constant.
`protected static String`	`KEY_OS_VERSION` Document constant.
`protected static String`	`MSCAPI_DISABLED` Document constant.
`protected static String`	`VAR_PKCS11_CONFIG` Document constant.
`protected static String`	`VAR_PKCS11_DRIVER` Document constant.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDriver(String fileName)` The name of the driver is required for proper loading of the library, but there is no obligation for the name to be always the same and unique, so to facilitate in cases where the manufacturer of the driver is not known, this method can be used to create the Name of the driver from your physical file.
`void`	`addDriver(String name, String fileName)` Tests each driver that has been informed, checking if the file exists.
`void`	`doConfiguration()`
`static String`	`getConfigFilePath()`
`SortedMap<String,String>`	`getDrivers()` Returns a set of drivers in the Map, in this pattern: <'driver name', 'path driver'>
`static Configuration`	`getInstance()`
`String`	`getJavaVersion()` Method that returns the version of the JVM that is running the component.
`String`	`getPKCS11ConfigFile()` Retrieve the path of the configuration file for SunPKCS11 according to the links below.
`void`	`getPKCS11DriverFromVariable()` Retrieve the driver and its path from the environment variable or JVM variable.
`String`	`getSO()` Method that returns the name of the operating system.
`Integer`	`getSoVersion()` Method that returns the version of the operating system.
`Integer`	`getSoVersionRelease()`
`boolean`	`isMSCAPI_ON()` default is true.
`boolean`	`isMSCapiDisabled()`
`void`	`setMSCAPI_ON(boolean mSCAPI_ON)` set MSCAPI to ON (true) or OFF (false).

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

- Field Detail
  - KEY_JAVA_VERSION
```
protected static final String KEY_JAVA_VERSION
```
    Document constant.
    
    See Also:
    
    Constant Field Values
  - KEY_OS_NAME
```
protected static final String KEY_OS_NAME
```
    Document constant.
    
    See Also:
    
    Constant Field Values
  - KEY_OS_VERSION
```
protected static final String KEY_OS_VERSION
```
    Document constant.
    
    See Also:
    
    Constant Field Values
  - VAR_PKCS11_CONFIG
```
protected static final String VAR_PKCS11_CONFIG
```
    Document constant.
    
    See Also:
    
    Constant Field Values
  - VAR_PKCS11_DRIVER
```
protected static final String VAR_PKCS11_DRIVER
```
    Document constant.
    
    See Also:
    
    Constant Field Values
  - CUSTOM_CONFIG_PATH
```
protected static final String CUSTOM_CONFIG_PATH
```
    Document constant.
    
    See Also:
    
    Constant Field Values
  - CUSTOM_CONFIG_FILENAME
```
protected static final String CUSTOM_CONFIG_FILENAME
```
    Document constant.
    
    See Also:
    
    Constant Field Values
  - FILE_SEPARATOR
```
protected static final String FILE_SEPARATOR
```
    Document constant.
    
    See Also:
    
    Constant Field Values
  - MSCAPI_DISABLED
```
protected static final String MSCAPI_DISABLED
```
    Document constant.
    
    See Also:
    
    Constant Field Values
  - CONFIG_FILE_DIR
```
protected static final String CONFIG_FILE_DIR
```
    Document constant.
    
    See Also:
    
    Constant Field Values
  - CONFIG_FILE_PATH
```
protected static final String CONFIG_FILE_PATH
```
    Document constant.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static Configuration getInstance()
```
  - doConfiguration
```
public void doConfiguration()
```
  - getJavaVersion
```
public String getJavaVersion()
```
    Method that returns the version of the JVM that is running the component. Look for this information in the system properties.
    
    Returns:
    
    version of current JVM
  - isMSCapiDisabled
```
public boolean isMSCapiDisabled()
```
    Returns:
    
    true if Microsoft CryptoAPI is DISABLE
  - getSO
```
public String getSO()
```
    Method that returns the name of the operating system. Look for this information in the system properties.
    
    Returns:
    
    name of the operating system
  - getSoVersion
```
public Integer getSoVersion()
```
    Method that returns the version of the operating system. Look for this information in the system properties.
    
    Returns:
    
    version of the operating system
  - getSoVersionRelease
```
public Integer getSoVersionRelease()
```
  - getDrivers
```
public SortedMap<String,String> getDrivers()
```
    Returns a set of drivers in the Map, in this pattern: <'driver name', 'path driver'>
    
    Returns:
    
    map of drivers, with name as key and path as value.
  - addDriver
```
public void addDriver(String name,
                      String fileName)
```
    Tests each driver that has been informed, checking if the file exists. If the driver file you entered does not exist, this driver will not be added to the list to be loaded.
    
    Parameters:
    
    name - Required parameter that informs the driver's nickname to be loaded. Ex: Pronova
    
    fileName - Mandatory parameter that informs the full path of the driver in the operating system. Ex: /etc/driver/driver.so
  - addDriver
```
public void addDriver(String fileName)
```
    The name of the driver is required for proper loading of the library, but there is no obligation for the name to be always the same and unique, so to facilitate in cases where the manufacturer of the driver is not known, this method can be used to create the Name of the driver from your physical file. Ex: /etc/driver/driver.so driver name = driver.so It is important to point out that the higher the information the better it will be to avoid problems.
    
    Parameters:
    
    fileName - Mandatory parameter that informs the full path of the driver in the operating system. Ex: /etc/driver/driver.so
  - getPKCS11ConfigFile
```
public String getPKCS11ConfigFile()
```
    Retrieve the path of the configuration file for SunPKCS11 according to the links below. To use the configuration file, simply enter your path in an environment variable or as a JVM parameter Java 1.5 - http://java.sun.com/j2se/1.5.0/docs/guide/security/p11guide.html Java Java 1.6 - http://java.sun.com/javase/6/docs/technotes/guides/security/p11guide.html Java 7 - http://docs.oracle.com/javase/7/docs/technotes/guides/security/p11guide.html Java 8 - https://docs.oracle.com/javase/8/docs/technotes/guides/security/p11guide.html
    
    Returns:
    
    location of configuration file for PKCS11 driver
  - getPKCS11DriverFromVariable
```
public void getPKCS11DriverFromVariable()
```
    Retrieve the driver and its path from the environment variable or JVM variable. Example of definition: JVM: -DPKCS11_DRIVER=Pronova::/usr/lib/libepsng_p11.so or -DPKCS11_DRIVER=/usr/lib/libepsng_p11.so Environment variable in Linux export PKCS11_DRIVER=Pronova::/usr/lib/libepsng_p11.so ou export PKCS11_DRIVER=/usr/lib/libepsng_p11.so Environment variable in window$ set PKCS11_DRIVER=Pronova::/WINDOWS/system32/ngp11v211.dll set PKCS11_DRIVER=/WINDOWS/system32/ngp11v211.dll
  - getConfigFilePath
```
public static String getConfigFilePath()
```
    Returns:
    
    File path acording to SO
  - isMSCAPI_ON
```
public boolean isMSCAPI_ON()
```
    default is true.
    
    Returns:
    
    if MSCAPI is ON (true) or OFF (false).
  - setMSCAPI_ON
```
public void setMSCAPI_ON(boolean mSCAPI_ON)
```
    set MSCAPI to ON (true) or OFF (false).
    
    Parameters:
    
    mSCAPI_ON - the value to set.

Class Configuration

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_JAVA_VERSION

KEY_OS_NAME

KEY_OS_VERSION

VAR_PKCS11_CONFIG

VAR_PKCS11_DRIVER

CUSTOM_CONFIG_PATH

CUSTOM_CONFIG_FILENAME

FILE_SEPARATOR

MSCAPI_DISABLED

CONFIG_FILE_DIR

CONFIG_FILE_PATH

Method Detail

getInstance

doConfiguration

getJavaVersion

isMSCapiDisabled

getSO

getSoVersion

getSoVersionRelease

getDrivers

addDriver

addDriver

getPKCS11ConfigFile

getPKCS11DriverFromVariable

getConfigFilePath

isMSCAPI_ON

setMSCAPI_ON