Configuration (OpenDJ 3.0.0-SNAPSHOT Documentation)

java.lang.Object
- org.opends.quicksetup.Configuration

```
public class Configuration
extends Object
```
Represents the contents of an OpenDS configuration file.

Constructor Summary

Constructors
Constructor and Description

Configuration(Installation install, File file)
Create a Configuration from a file.

Constructors
Constructor and Description
`Configuration(Installation install, File file)` Create a Configuration from a file.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getAdminConnectorPort()` Provides the administration port as is specified in the config.ldif file.
`Set<String>`	`getBaseDNs()` Returns the list of base dns as they appear in the configuration file.
`String`	`getContents()` Provides the contents of the config.ldif file in a String.
`Set<String>`	`getDatabasePaths()` Returns the list of paths where the databases are installed as they appear in the configuration file.
`Set<String>`	`getDirectoryManagerDns()` Returns the list of directory manager dns as they appear in the configuration file.
`Set<String>`	`getLogPaths()` Returns the list of paths where the logs files are located as they appear in the configuration file.
`String`	`getLowerCaseContents()` Provides the contents of the config.ldif file in a lower case String.
`Set<String>`	`getOutsideDbs()` Returns a Set of relative paths containing the db paths outside the installation.
`Set<String>`	`getOutsideLogs()` Returns a Set of relative paths containing the log paths outside the installation.
`int`	`getPort()` Provides the LDAP port as is specified in the config.ldif file.
`int`	`getReplicationPort()` Provides the Replication port as is specified in the config.ldif file.
`boolean`	`hasBeenModified()` Indicates whether the config.ldif file has been modified (compared to what we had in the zip file).
`boolean`	`isReplicationServer()` Tells whether this server is configured as a replication server or not.
`void`	`load()` Loads the contents of the configuration file into memory.

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

- Constructor Detail
  - Configuration
```
public Configuration(Installation install,
             File file)
```
    Create a Configuration from a file.
    
    Parameters:
    install - of which this configuration is part
    file - config.ldif file
- Method Detail
  - getDirectoryManagerDns
```
public Set<String> getDirectoryManagerDns()
                                   throws IOException
```
    Returns the list of directory manager dns as they appear in the configuration file.
    
    Returns:
    the list of directory manager dns as they appear in the configuration file.
    
    Throws:
    
    IOException - if there were problems reading the information from the configuration file.
  - getPort
```
public int getPort()
            throws IOException
```
    Provides the LDAP port as is specified in the config.ldif file.
    
    Returns:
    the LDAP port specified in the config.ldif file.
    
    Throws:
    
    IOException - if there were problems reading the information from the configuration file.
  - getAdminConnectorPort
```
public int getAdminConnectorPort()
                          throws IOException
```
    Provides the administration port as is specified in the config.ldif file.
    
    Returns:
    the administration port specified in the config.ldif file.
    
    Throws:
    
    IOException - if there were problems reading the information from the configuration file.
  - isReplicationServer
```
public boolean isReplicationServer()
                            throws IOException
```
    Tells whether this server is configured as a replication server or not.
    
    Returns:
    true if the server is configured as a Replication Server and false otherwise.
    
    Throws:
    
    IOException - if there were problems reading the information from the configuration file.
  - getReplicationPort
```
public int getReplicationPort()
                       throws IOException
```
    Provides the Replication port as is specified in the config.ldif file. Returns -1 if this server is not a Replication Server.
    
    Returns:
    the Replication port specified in the config.ldif file.
    
    Throws:
    
    IOException - if there were problems reading the information from the configuration file.
  - getLogPaths
```
public Set<String> getLogPaths()
                        throws IOException
```
    Returns the list of paths where the logs files are located as they appear in the configuration file.
    
    Returns:
    the list of paths where the logs files are located as they appear in the configuration file.
    
    Throws:
    
    IOException - if there were problems reading the information from the configuration file.
  - hasBeenModified
```
public boolean hasBeenModified()
                        throws IOException
```
    Indicates whether the config.ldif file has been modified (compared to what we had in the zip file). This is used to know if we have configured the current binaries or not.
    
    Returns:
    true if the config.ldif file has been modified, or false if not.
    
    Throws:
    
    IOException - if there were problems reading the information from the configuration file.
  - getOutsideLogs
```
public Set<String> getOutsideLogs()
                           throws IOException
```
    Returns a Set of relative paths containing the log paths outside the installation.
    
    Returns:
    a Set of relative paths containing the log paths outside the installation.
    
    Throws:
    
    IOException - if there is trouble reading the config file
  - getOutsideDbs
```
public Set<String> getOutsideDbs()
                          throws IOException
```
    Returns a Set of relative paths containing the db paths outside the installation.
    
    Returns:
    a Set of relative paths containing the db paths outside the installation.
    
    Throws:
    
    IOException - if there is trouble reading the config file
  - getContents
```
public String getContents()
                   throws IOException
```
    Provides the contents of the config.ldif file in a String.
    
    Returns:
    a String representing the contents of the config.ldif file.
    
    Throws:
    
    IOException - if there was a problem reading the file
  - getLowerCaseContents
```
public String getLowerCaseContents()
                            throws IOException
```
    Provides the contents of the config.ldif file in a lower case String.
    
    Returns:
    a lower case String representing the contents of the config.ldif file.
    
    Throws:
    
    IOException - if there was a problem reading the file
  - getDatabasePaths
```
public Set<String> getDatabasePaths()
                             throws IOException
```
    Returns the list of paths where the databases are installed as they appear in the configuration file.
    
    Returns:
    the list of paths where the databases are installed as they appear in the configuration file.
    
    Throws:
    
    IOException - if there is a problem reading the config file.
  - getBaseDNs
```
public Set<String> getBaseDNs()
                       throws IOException
```
    Returns the list of base dns as they appear in the configuration file.
    
    Returns:
    the list of base dns as they appear in the configuration file.
    
    Throws:
    
    IOException - if there is a problem reading the config file.
  - load
```
public void load()
          throws IOException
```
    Loads the contents of the configuration file into memory.
    
    Throws:
    
    IOException - if there were problems loading the file

Class Configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configuration

Method Detail

getDirectoryManagerDns

getPort

getAdminConnectorPort

isReplicationServer

getReplicationPort

getLogPaths

hasBeenModified

getOutsideLogs

getOutsideDbs

getContents

getLowerCaseContents

getDatabasePaths

getBaseDNs

load