org.opends.guitools.controlpanel.util

Class ConfigFromDirContext

java.lang.Object

org.opends.guitools.controlpanel.util.ConfigReader

org.opends.guitools.controlpanel.util.ConfigFromDirContext

public class ConfigFromDirContext
extends ConfigReader

A class that reads the configuration and monitoring information using a DirContext through LDAP.

Field Summary

Fields

Modifier and Type	Field and Description
protected DN	entryCachesDN The entry cache monitoring entry DN.
static DateFormat	formatter The date formatter to be used to format dates.
protected DN	jvmMemoryUsageDN The JVM memory usage monitoring entry DN.
protected DN	monitorDN The monitor root entry DN.
protected DN	systemInformationDN The system information monitoring entry DN.
static SimpleDateFormat	utcParser The date formatter to be used to parse GMT dates.
protected DN	versionDN The version monitoring entry DN.
protected DN	workQueueDN The work queue monitoring entry DN.

Fields inherited from class org.opends.guitools.controlpanel.util.ConfigReader

adminConnector, administrativeUsers, backends, configClassName, configFile, configRead, environmentSettingException, exceptions, isSchemaEnabled, javaVersion, listeners, numberConnections, replicationPort, schema, taskEntries

Constructor Summary

Constructors

Constructor and Description
ConfigFromDirContext()

Method Summary

Methods

Modifier and Type	Method and Description
CustomSearchResult	getEntryCaches() Returns the monitoring entry for the entry caches.
CustomSearchResult	getJvmMemoryUsage() Returns the monitoring entry for the JVM memory usage.
protected String[]	getMonitoringAttributes() Returns an array of monitoring attributes to be returned in the request.
CustomSearchResult	getRootMonitor() Returns the root entry of the monitoring tree.
CustomSearchResult	getSystemInformation() Returns the monitoring entry for the system information.
CustomSearchResult	getVersionMonitor() Returns the version entry of the monitoring tree.
CustomSearchResult	getWorkQueue() Returns the monitoring entry for the work queue.
protected void	handleMonitoringSearchResult(SearchResult sr, String searchBaseDN) Takes the provided search result and updates the monitoring information accordingly.
boolean	isLocal() Returns true if we are trying to manage the local host and false otherwise.
void	readConfiguration(InitialLdapContext context) Reads configuration and monitoring information using the provided connection.
void	setIsLocal(boolean isLocal) Sets whether this server represents the local instance or a remote server.
void	updateTaskInformation(InitialLdapContext ctx, List<OpenDsException> ex, Collection<TaskEntry> ts) Updates the provided list of TaskEntry with the task entries found in a server.

Methods inherited from class org.opends.guitools.controlpanel.util.ConfigReader

getAdminConnector, getAdministrativeUsers, getBackends, getConnectionHandlers, getExceptions, getInetAddressComparator, getJavaVersion, getOpenConnections, getReplicationPort, getSchema, getTaskEntries, getVLVSortOrder, isConfigRead, isSchemaEnabled, mustReadSchema, readSchema

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

monitorDN

protected DN monitorDN

The monitor root entry DN.

jvmMemoryUsageDN

protected DN jvmMemoryUsageDN

The JVM memory usage monitoring entry DN.

systemInformationDN

protected DN systemInformationDN

The system information monitoring entry DN.

entryCachesDN

protected DN entryCachesDN

The entry cache monitoring entry DN.

workQueueDN

protected DN workQueueDN

The work queue monitoring entry DN.

versionDN

protected DN versionDN

The version monitoring entry DN.

utcParser

public static final SimpleDateFormat utcParser

The date formatter to be used to parse GMT dates.

formatter

public static final DateFormat formatter

The date formatter to be used to format dates.

Constructor Detail

ConfigFromDirContext

public ConfigFromDirContext()

Method Detail

getEntryCaches

public CustomSearchResult getEntryCaches()

Returns the monitoring entry for the entry caches.

Returns:

the monitoring entry for the entry caches.

getJvmMemoryUsage

public CustomSearchResult getJvmMemoryUsage()

Returns the monitoring entry for the JVM memory usage.

Returns:

the monitoring entry for the JVM memory usage.

getRootMonitor

public CustomSearchResult getRootMonitor()

Returns the root entry of the monitoring tree.

Returns:

the root entry of the monitoring tree.

getVersionMonitor

public CustomSearchResult getVersionMonitor()

Returns the version entry of the monitoring tree.

Returns:

the version entry of the monitoring tree.

getSystemInformation

public CustomSearchResult getSystemInformation()

Returns the monitoring entry for the system information.

Returns:

the monitoring entry for the system information.

getWorkQueue

public CustomSearchResult getWorkQueue()

Returns the monitoring entry for the work queue.

Returns:

the monitoring entry for the work queue.

setIsLocal

public void setIsLocal(boolean isLocal)

Sets whether this server represents the local instance or a remote server.

Parameters:

isLocal - whether this server represents the local instance or a remote server (in another machine or in another installation on the same machine).

isLocal

public boolean isLocal()

Returns true if we are trying to manage the local host and false otherwise.

Returns:

true if we are trying to manage the local host and false otherwise.

readConfiguration

public void readConfiguration(InitialLdapContext context)

Reads configuration and monitoring information using the provided connection.

Parameters:

context - the connection to be used to read the information.

getMonitoringAttributes

protected String[] getMonitoringAttributes()

Returns an array of monitoring attributes to be returned in the request.

Returns:

an array of monitoring attributes to be returned in the request.

handleMonitoringSearchResult

protected void handleMonitoringSearchResult(SearchResult sr,
                                String searchBaseDN)
                                     throws NamingException

Takes the provided search result and updates the monitoring information accordingly.

Parameters:

sr - the search result.

searchBaseDN - the base search.

Throws:

NamingException - if there is an error retrieving the values of the search result.

updateTaskInformation

public void updateTaskInformation(InitialLdapContext ctx,
                         List<OpenDsException> ex,
                         Collection<TaskEntry> ts)

Updates the provided list of TaskEntry with the task entries found in a server.

Parameters:

ctx - the connection to the server.

ex - the list of exceptions encountered while retrieving the task entries.

ts - the list of task entries to be updated.