java.lang.Object
- org.opends.guitools.controlpanel.util.ConfigReader

Direct Known Subclasses:

ConfigFromConnection, ConfigFromFile
```
public abstract class ConfigReader
extends Object
```
An abstract class providing some common interface for the class that read the configuration (and if the server is running, the monitoring information).

Field Summary

Fields
Modifier and Type	Field	Description
`protected ConnectionHandlerDescriptor`	`adminConnector`	The administration connector.
`protected Set<DN>`	`administrativeUsers`	The set of administrative users.
`protected Set<BackendDescriptor>`	`backends`	The set of backend descriptors.
`static String`	`configFile`	The configuration file full path (-INSTANCE_ROOT-/config/config.ldif).
`protected static OpenDsException`	`environmentSettingException`	The error that occurred when setting the environment (null if no error occurred).
`protected List<Exception>`	`exceptions`	The exceptions that occurred reading the configuration.
`protected boolean`	`isSchemaEnabled`	Whether the schema checking is enabled or not.
`protected String`	`javaVersion`	The java version used to run the server.
`protected Set<ConnectionHandlerDescriptor>`	`listeners`	The set of connection listeners.
`protected int`	`numberConnections`	The number of connections opened on the server.
`protected int`	`replicationPort`	The replication serve port (-1 if the replication server port is not defined).
`protected Schema`	`schema`	The schema used by the server.
`protected Set<TaskEntry>`	`taskEntries`	The task entries.

Constructor Summary

Constructors
Constructor Description

ConfigReader()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ConnectionHandlerDescriptor`	`getAdminConnector()`	Returns the admin connector.
`Set<DN>`	`getAdministrativeUsers()`	Returns the Administrative User DNs found in the config.ldif.
`Set<BackendDescriptor>`	`getBackends()`	Returns the backend descriptors found in the config.ldif.
`Set<ConnectionHandlerDescriptor>`	`getConnectionHandlers()`	Returns the listener descriptors found in the config.ldif.
`List<Exception>`	`getExceptions()`	Returns the list of exceptions that were encountered reading the configuration.
`protected Comparator<InetAddress>`	`getInetAddressComparator()`	Returns the comparator to be used to sort InetAddresses.
`String`	`getJavaVersion()`	Returns the java version used to run the server.
`int`	`getOpenConnections()`	Returns the number of open connections on the server
`int`	`getReplicationPort()`	Returns the replication server port. -1 if no replication server port is defined.
`Schema`	`getSchema()`	Returns the schema of the server.
`Set<TaskEntry>`	`getTaskEntries()`	Returns the task entries.
`protected List<VLVSortOrder>`	`getVLVSortOrder(String s)`	Method that transforms the VLV sort order value as it is defined in the schema to a list of VLVSortOrder objects.
`boolean`	`isConfigRead()`	Returns `true` if the configuration has been read at least once and `false` otherwise.
`boolean`	`isSchemaEnabled()`	Returns `true` if the schema check is enabled and `false` otherwise.
`protected boolean`	`mustReadSchema()`	Returns `true` if the schema must be read and `false` otherwise.
`protected Schema`	`readSchema()`	Reads the schema from the files.

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

- Field Detail
  - configFile
```
public static String configFile
```
    The configuration file full path (-INSTANCE_ROOT-/config/config.ldif). of the installation of the control panel.
  - environmentSettingException
```
protected static OpenDsException environmentSettingException
```
    The error that occurred when setting the environment (null if no error occurred).
  - exceptions
```
protected List<Exception> exceptions
```
    The exceptions that occurred reading the configuration.
  - listeners
```
protected Set<ConnectionHandlerDescriptor> listeners
```
    The set of connection listeners.
  - adminConnector
```
protected ConnectionHandlerDescriptor adminConnector
```
    The administration connector.
  - backends
```
protected Set<BackendDescriptor> backends
```
    The set of backend descriptors.
  - administrativeUsers
```
protected Set<DN> administrativeUsers
```
    The set of administrative users.
  - replicationPort
```
protected int replicationPort
```
    The replication serve port (-1 if the replication server port is not defined).
  - javaVersion
```
protected String javaVersion
```
    The java version used to run the server.
  - numberConnections
```
protected int numberConnections
```
    The number of connections opened on the server.
  - isSchemaEnabled
```
protected boolean isSchemaEnabled
```
    Whether the schema checking is enabled or not.
  - schema
```
protected Schema schema
```
    The schema used by the server.
  - taskEntries
```
protected Set<TaskEntry> taskEntries
```
    The task entries.
- Constructor Detail
  - ConfigReader
```
public ConfigReader()
```
- Method Detail
  - getAdministrativeUsers
```
public Set<DN> getAdministrativeUsers()
```
    Returns the Administrative User DNs found in the config.ldif. The set must be unmodifiable (the inheriting classes must take care of this).
    
    Returns:
    
    the Administrative User DNs found in the config.ldif.
  - getBackends
```
public Set<BackendDescriptor> getBackends()
```
    Returns the backend descriptors found in the config.ldif. The set must be unmodifiable (the inheriting classes must take care of this).
    
    Returns:
    
    the backend descriptors found in the config.ldif.
  - getConnectionHandlers
```
public Set<ConnectionHandlerDescriptor> getConnectionHandlers()
```
    Returns the listener descriptors found in the config.ldif. The set must be unmodifiable (the inheriting classes must take care of this).
    
    Returns:
    
    the listeners descriptors found in the config.ldif.
  - getAdminConnector
```
public ConnectionHandlerDescriptor getAdminConnector()
```
    Returns the admin connector.
    
    Returns:
    
    the admin connector.
  - getExceptions
```
public List<Exception> getExceptions()
```
    Returns the list of exceptions that were encountered reading the configuration. The list must be unmodifiable (the inheriting classes must take care of this).
    
    Returns:
    
    the list of exceptions that were encountered reading the configuration.
  - isConfigRead
```
public boolean isConfigRead()
```
    Returns true if the configuration has been read at least once and false otherwise.
    
    Returns:
    
    true if the configuration has been read at least once and false otherwise.
  - getReplicationPort
```
public int getReplicationPort()
```
    Returns the replication server port. -1 if no replication server port is defined.
    
    Returns:
    
    the replication server port. -1 if no replication server port is defined.
  - isSchemaEnabled
```
public boolean isSchemaEnabled()
```
    Returns true if the schema check is enabled and false otherwise.
    
    Returns:
    
    true if the schema check is enabled and false otherwise.
  - getJavaVersion
```
public String getJavaVersion()
```
    Returns the java version used to run the server. null if no java version is used (because the server is down).
    
    Returns:
    
    the java version used to run the server. null if no java version is used (because the server is down).
  - getOpenConnections
```
public int getOpenConnections()
```
    Returns the number of open connections on the server. -1 if the server is down.
    
    Returns:
    
    the number of open connections on the server.
  - getSchema
```
public Schema getSchema()
```
    Returns the schema of the server.
    
    Returns:
    
    the schema of the server.
  - getTaskEntries
```
public Set<TaskEntry> getTaskEntries()
```
    Returns the task entries.
    
    Returns:
    
    the task entries.
  - readSchema
```
protected Schema readSchema()
                     throws ConfigException,
                            InitializationException,
                            DirectoryException
```
    Reads the schema from the files.
    
    Returns:
    
    the schema
    
    Throws:
    
    ConfigException - if an error occurs reading the schema.
    
    InitializationException - if an error occurs initializing configuration to read schema.
    
    DirectoryException - if there is an error registering the minimal objectclasses.
  - getVLVSortOrder
```
protected List<VLVSortOrder> getVLVSortOrder(String s)
```
    Method that transforms the VLV sort order value as it is defined in the schema to a list of VLVSortOrder objects.
    
    Parameters:
    
    s - the string in the configuration.
    
    Returns:
    
    a list of VLVSortOrder objects.
  - getInetAddressComparator
```
protected Comparator<InetAddress> getInetAddressComparator()
```
    Returns the comparator to be used to sort InetAddresses.
    
    Returns:
    
    the comparator to be used to sort InetAddresses.
  - mustReadSchema
```
protected boolean mustReadSchema()
```
    Returns true if the schema must be read and false otherwise.
    
    Returns:
    
    true if the schema must be read and false otherwise.

Class ConfigReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

configFile

environmentSettingException

exceptions

listeners

adminConnector

backends

administrativeUsers

replicationPort

javaVersion

numberConnections

isSchemaEnabled

schema

taskEntries

Constructor Detail

ConfigReader

Method Detail

getAdministrativeUsers

getBackends

getConnectionHandlers

getAdminConnector

getExceptions

isConfigRead

getReplicationPort

isSchemaEnabled

getJavaVersion

getOpenConnections

getSchema

getTaskEntries

readSchema

getVLVSortOrder

getInetAddressComparator

mustReadSchema