ControlPanelInfo (OpenDJ 3.0.0 Documentation)

java.lang.Object
- org.opends.guitools.controlpanel.datamodel.ControlPanelInfo

```
public class ControlPanelInfo
extends Object
```
This is the classes that is shared among all the different places in the Control Panel. It contains information about the server status and configuration and some objects that are shared everywhere.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ControlPanelInfo()
Default constructor.

Constructors
Modifier	Constructor and Description
`protected`	`ControlPanelInfo()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBackendPopulatedListener(BackendPopulatedListener listener)` Adds a backend populated listener.
`void`	`addBackupCreatedListener(BackupCreatedListener listener)` Adds a backup creation listener.
`void`	`addConfigChangeListener(ConfigChangeListener listener)` Adds a configuration change listener.
`void`	`addIndexModifiedListener(IndexModifiedListener listener)` Adds an index modification listener.
`void`	`backendPopulated(Set<BackendDescriptor> backends)` Informs that a set of backends have been populated.
`void`	`backupCreated(BackupDescriptor newBackup)` Informs that a backup has been created.
`boolean`	`connectUsingLDAPS()` Tells whether we must connect to the server using LDAPS.
`boolean`	`connectUsingStartTLS()` Tells whether we must connect to the server using Start TLS.
`protected ConfigFromDirContext`	`createNewConfigFromDirContextReader()` Returns a reader that will read the configuration from a dir context.
`protected ConfigFromFile`	`createNewConfigFromFileReader()` Returns a reader that will read the configuration from a file.
`protected ServerDescriptor`	`createNewServerDescriptorInstance()` Returns an empty new server descriptor instance.
`String`	`getAdminConnectorURL()` Gets the Administration Connector URL based in what is read in the configuration.
`ConnectionProtocolPolicy`	`getConnectionPolicy()` Returns the connection policy to be used by this ControlPanelInfo (and in general by the control panel).
`LDAPConnectionPool`	`getConnectionPool()` Returns the connection pool to be used by the LDAP entry browsers.
`int`	`getConnectTimeout()` Returns the timeout to establish the connection in milliseconds.
`InitialLdapContext`	`getDirContext()` Returns the dir context to be used by the ControlPanelInfo to retrieve monitoring and configuration information.
`IconPool`	`getIconPool()` Returns the icon pool to be used by the LDAP entry browsers.
`static ControlPanelInfo`	`getInstance()` Returns a singleton for this instance.
`String`	`getLDAPSURL()` Gets the LDAPS URL based in what is read in the configuration.
`String`	`getLDAPURL()` Gets the LDAP URL based in what is read in the configuration.
`String`	`getLocalAdminConnectorURL()` Gets the Administration Connector URL based in what is read in the local configuration.
`Collection<AbstractIndexDescriptor>`	`getModifiedIndexes()` Returns a collection with all the modified indexes.
`long`	`getPoolingPeriod()` Returns the pooling period in miliseconds.
`ServerDescriptor`	`getServerDescriptor()` Returns the last ServerDescriptor that has been retrieved.
`String`	`getStartTLSURL()` Gets the Start TLS URL based in what is read in the configuration.
`Set<Task>`	`getTasks()` Returns the list of tasks.
`ApplicationTrustManager`	`getTrustManager()` Returns the trust manager to be used by this ControlPanelInfo (and in general by the control panel).
`String`	`getURLToConnect()` Returns the URL that must be used to connect to the server based on the available enabled connection handlers in the server and the connection policy.
`InitialLdapContext`	`getUserDataDirContext()` Returns the dir context to be used by the ControlPanelInfo to retrieve user data.
`void`	`indexModified(AbstractIndexDescriptor modifiedIndex)` Informs that an index has been modified.
`void`	`initializeConfigurationFramework()` Initialize the new configuration framework if needed.
`boolean`	`isLocal()` Returns `true` if we are trying to manage the local host and `false` otherwise.
`boolean`	`mustDeregisterConfig()` Returns `true` if the configuration must be deregistered and `false` otherwise.
`boolean`	`mustReindex(AbstractIndexDescriptor index)` Tells whether an index must be reindexed or not.
`void`	`regenerateDescriptor()` Regenerates the last found ServerDescriptor object.
`void`	`registerModifiedIndex(AbstractIndexDescriptor index)` Registers an index as modified.
`void`	`registerTask(Task task)` Registers a task.
`boolean`	`removeBackendPopulatedListener(BackendPopulatedListener listener)` Removes a backend populated listener.
`boolean`	`removeBackupCreatedListener(BackupCreatedListener listener)` Removes a backup creation listener.
`boolean`	`removeConfigChangeListener(ConfigChangeListener listener)` Removes a configuration change listener.
`boolean`	`removeIndexModifiedListener(IndexModifiedListener listener)` Removes an index modification listener.
`void`	`setConnectionPolicy(ConnectionProtocolPolicy connectionPolicy)` Sets the connection policy to be used by this ControlPanelInfo (and in general by the control panel).
`void`	`setConnectTimeout(int connectTimeout)` Sets the timeout to establish the connection in milliseconds.
`void`	`setDirContext(InitialLdapContext ctx)` Sets the dir context to be used by the ControlPanelInfo to retrieve monitoring and configuration information.
`void`	`setIsLocal(boolean isLocal)` Sets whether the server is local or not.
`void`	`setMustDeregisterConfig(boolean mustDeregisterConfig)` Sets whether the configuration must be deregistered or not.
`void`	`setPoolingPeriod(long poolingPeriod)` Sets the pooling period in miliseconds.
`void`	`setTrustManager(ApplicationTrustManager trustManager)` Sets the trust manager to be used by this ControlPanelInfo (and in general by the control panel).
`void`	`setUserDataDirContext(InitialLdapContext ctx)` Sets the dir context to be used by the ControlPanelInfo to retrieve user data.
`void`	`startPooling()` Starts pooling the server configuration.
`void`	`stopPooling()` Stops pooling the server.
`boolean`	`unregisterModifiedIndex(AbstractIndexDescriptor index)` Unregisters a modified index.
`void`	`unregisterModifiedIndexesInBackend(String backendName)` Unregisters all the modified indexes on a given backend.
`void`	`unregisterTask(Task task)` Unregisters a task.
`protected void`	`updateServerDescriptor(ConfigReader reader, ServerDescriptor desc)` Updates the contents of the server descriptor with the provider reader.

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

- Constructor Detail
  - ControlPanelInfo
```
protected ControlPanelInfo()
```
    Default constructor.
- Method Detail
  - getInstance
```
public static ControlPanelInfo getInstance()
```
    Returns a singleton for this instance.
    
    Returns:
    the control panel info.
  - getServerDescriptor
```
public ServerDescriptor getServerDescriptor()
```
    Returns the last ServerDescriptor that has been retrieved.
    
    Returns:
    the last ServerDescriptor that has been retrieved.
  - getTasks
```
public Set<Task> getTasks()
```
    Returns the list of tasks.
    
    Returns:
    the list of tasks.
  - registerTask
```
public void registerTask(Task task)
```
    Registers a task. The Control Panel creates a task every time an operation is made and they are stored here.
    
    Parameters:
    task - the task to be registered.
  - unregisterTask
```
public void unregisterTask(Task task)
```
    Unregisters a task.
    
    Parameters:
    task - the task to be unregistered.
  - mustReindex
```
public boolean mustReindex(AbstractIndexDescriptor index)
```
    Tells whether an index must be reindexed or not.
    
    Parameters:
    index - the index.
    
    Returns:
    true if the index must be reindexed and false otherwise.
  - registerModifiedIndex
```
public void registerModifiedIndex(AbstractIndexDescriptor index)
```
    Registers an index as modified. This is used by the panels to be able to inform the user that a rebuild of the index is required.
    
    Parameters:
    index - the index.
  - unregisterModifiedIndex
```
public boolean unregisterModifiedIndex(AbstractIndexDescriptor index)
```
    Unregisters a modified index.
    
    Parameters:
    index - the index.
    
    Returns:
    true if the index is found in the list of modified indexes and false otherwise.
  - unregisterModifiedIndexesInBackend
```
public void unregisterModifiedIndexesInBackend(String backendName)
```
    Unregisters all the modified indexes on a given backend.
    
    Parameters:
    backendName - the name of the backend.
  - getModifiedIndexes
```
public Collection<AbstractIndexDescriptor> getModifiedIndexes()
```
    Returns a collection with all the modified indexes.
    
    Returns:
    a collection with all the modified indexes.
  - setDirContext
```
public void setDirContext(InitialLdapContext ctx)
```
    Sets the dir context to be used by the ControlPanelInfo to retrieve monitoring and configuration information.
    
    Parameters:
    ctx - the connection.
  - getDirContext
```
public InitialLdapContext getDirContext()
```
    Returns the dir context to be used by the ControlPanelInfo to retrieve monitoring and configuration information.
    
    Returns:
    the dir context to be used by the ControlPanelInfo to retrieve monitoring and configuration information.
  - setUserDataDirContext
```
public void setUserDataDirContext(InitialLdapContext ctx)
                           throws NamingException
```
    Sets the dir context to be used by the ControlPanelInfo to retrieve user data.
    
    Parameters:
    ctx - the connection.
    
    Throws:
    
    NamingException - if there is a problem updating the connection pool.
  - getUserDataDirContext
```
public InitialLdapContext getUserDataDirContext()
```
    Returns the dir context to be used by the ControlPanelInfo to retrieve user data.
    
    Returns:
    the dir context to be used by the ControlPanelInfo to retrieve user data.
  - backupCreated
```
public void backupCreated(BackupDescriptor newBackup)
```
    Informs that a backup has been created. The method will notify to all the backup listeners that a backup has been created.
    
    Parameters:
    newBackup - the new created backup.
  - backendPopulated
```
public void backendPopulated(Set<BackendDescriptor> backends)
```
    Informs that a set of backends have been populated. The method will notify to all the backend populated listeners.
    
    Parameters:
    backends - the populated backends.
  - indexModified
```
public void indexModified(AbstractIndexDescriptor modifiedIndex)
```
    Informs that an index has been modified. The method will notify to all the index listeners that an index has been modified.
    
    Parameters:
    modifiedIndex - the modified index.
  - createNewServerDescriptorInstance
```
protected ServerDescriptor createNewServerDescriptorInstance()
```
    Returns an empty new server descriptor instance.
    
    Returns:
    an empty new server descriptor instance.
  - createNewConfigFromFileReader
```
protected ConfigFromFile createNewConfigFromFileReader()
```
    Returns a reader that will read the configuration from a file.
    
    Returns:
    a reader that will read the configuration from a file.
  - createNewConfigFromDirContextReader
```
protected ConfigFromDirContext createNewConfigFromDirContextReader()
```
    Returns a reader that will read the configuration from a dir context.
    
    Returns:
    a reader that will read the configuration from a dir context.
  - updateServerDescriptor
```
protected void updateServerDescriptor(ConfigReader reader,
                          ServerDescriptor desc)
```
    Updates the contents of the server descriptor with the provider reader.
    
    Parameters:
    reader - the configuration reader.
    desc - the server descriptor.
  - regenerateDescriptor
```
public void regenerateDescriptor()
```
    Regenerates the last found ServerDescriptor object.
  - addConfigChangeListener
```
public void addConfigChangeListener(ConfigChangeListener listener)
```
    Adds a configuration change listener.
    
    Parameters:
    listener - the listener.
  - removeConfigChangeListener
```
public boolean removeConfigChangeListener(ConfigChangeListener listener)
```
    Removes a configuration change listener.
    
    Parameters:
    listener - the listener.
    
    Returns:
    true if the listener is found and false otherwise.
  - addBackupCreatedListener
```
public void addBackupCreatedListener(BackupCreatedListener listener)
```
    Adds a backup creation listener.
    
    Parameters:
    listener - the listener.
  - removeBackupCreatedListener
```
public boolean removeBackupCreatedListener(BackupCreatedListener listener)
```
    Removes a backup creation listener.
    
    Parameters:
    listener - the listener.
    
    Returns:
    true if the listener is found and false otherwise.
  - addBackendPopulatedListener
```
public void addBackendPopulatedListener(BackendPopulatedListener listener)
```
    Adds a backend populated listener.
    
    Parameters:
    listener - the listener.
  - removeBackendPopulatedListener
```
public boolean removeBackendPopulatedListener(BackendPopulatedListener listener)
```
    Removes a backend populated listener.
    
    Parameters:
    listener - the listener.
    
    Returns:
    true if the listener is found and false otherwise.
  - addIndexModifiedListener
```
public void addIndexModifiedListener(IndexModifiedListener listener)
```
    Adds an index modification listener.
    
    Parameters:
    listener - the listener.
  - removeIndexModifiedListener
```
public boolean removeIndexModifiedListener(IndexModifiedListener listener)
```
    Removes an index modification listener.
    
    Parameters:
    listener - the listener.
    
    Returns:
    true if the listener is found and false otherwise.
  - startPooling
```
public void startPooling()
```
    Starts pooling the server configuration. The period of the pooling is specified as a parameter. This method is asynchronous and it will start the pooling in another thread.
  - stopPooling
```
public void stopPooling()
```
    Stops pooling the server. This method is synchronous, it does not return until the pooling is actually stopped.
  - getTrustManager
```
public ApplicationTrustManager getTrustManager()
```
    Returns the trust manager to be used by this ControlPanelInfo (and in general by the control panel).
    
    Returns:
    the trust manager to be used by this ControlPanelInfo.
  - setTrustManager
```
public void setTrustManager(ApplicationTrustManager trustManager)
```
    Sets the trust manager to be used by this ControlPanelInfo (and in general by the control panel).
    
    Parameters:
    trustManager - the trust manager to be used by this ControlPanelInfo.
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Returns the timeout to establish the connection in milliseconds.
    
    Returns:
    the timeout to establish the connection in milliseconds.
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
    Sets the timeout to establish the connection in milliseconds. Use 0 to express no timeout.
    
    Parameters:
    connectTimeout - the timeout to establish the connection in milliseconds. Use 0 to express no timeout.
  - getConnectionPolicy
```
public ConnectionProtocolPolicy getConnectionPolicy()
```
    Returns the connection policy to be used by this ControlPanelInfo (and in general by the control panel).
    
    Returns:
    the connection policy to be used by this ControlPanelInfo.
  - setConnectionPolicy
```
public void setConnectionPolicy(ConnectionProtocolPolicy connectionPolicy)
```
    Sets the connection policy to be used by this ControlPanelInfo (and in general by the control panel).
    
    Parameters:
    connectionPolicy - the connection policy to be used by this ControlPanelInfo.
  - getLDAPSURL
```
public String getLDAPSURL()
```
    Gets the LDAPS URL based in what is read in the configuration. It returns null if no LDAPS URL was found.
    
    Returns:
    the LDAPS URL to be used to connect to the server.
  - getAdminConnectorURL
```
public String getAdminConnectorURL()
```
    Gets the Administration Connector URL based in what is read in the configuration. It returns null if no Administration Connector URL was found.
    
    Returns:
    the Administration Connector URL to be used to connect to the server.
  - getLocalAdminConnectorURL
```
public String getLocalAdminConnectorURL()
```
    Gets the Administration Connector URL based in what is read in the local configuration. It returns null if no Administration Connector URL was found.
    
    Returns:
    the Administration Connector URL to be used to connect to the local server.
  - getLDAPURL
```
public String getLDAPURL()
```
    Gets the LDAP URL based in what is read in the configuration. It returns null if no LDAP URL was found.
    
    Returns:
    the LDAP URL to be used to connect to the server.
  - getStartTLSURL
```
public String getStartTLSURL()
```
    Gets the Start TLS URL based in what is read in the configuration. It returns null if no Start TLS URL is found.
    
    Returns:
    the Start TLS URL to be used to connect to the server.
  - connectUsingStartTLS
```
public boolean connectUsingStartTLS()
```
    Tells whether we must connect to the server using Start TLS.
    
    Returns:
    true if we must connect to the server using Start TLS and false otherwise.
  - connectUsingLDAPS
```
public boolean connectUsingLDAPS()
```
    Tells whether we must connect to the server using LDAPS.
    
    Returns:
    true if we must connect to the server using LDAPS and false otherwise.
  - getURLToConnect
```
public String getURLToConnect()
```
    Returns the URL that must be used to connect to the server based on the available enabled connection handlers in the server and the connection policy.
    
    Returns:
    the URL that must be used to connect to the server.
  - mustDeregisterConfig
```
public boolean mustDeregisterConfig()
```
    Returns true if the configuration must be deregistered and false otherwise. This is required when we use the ConfigFileHandler to update the configuration, in these cases cn=config must the deregistered from the ConfigFileHandler and after that register again.
    
    Returns:
    true if the configuration must be deregistered and false otherwise.
  - setMustDeregisterConfig
```
public void setMustDeregisterConfig(boolean mustDeregisterConfig)
```
    Sets whether the configuration must be deregistered or not.
    
    Parameters:
    mustDeregisterConfig - whether the configuration must be deregistered or not.
  - setIsLocal
```
public void setIsLocal(boolean isLocal)
```
    Sets whether the server is local or not.
    
    Parameters:
    isLocal - whether the server is local or not.
  - 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.
  - getConnectionPool
```
public LDAPConnectionPool getConnectionPool()
```
    Returns the connection pool to be used by the LDAP entry browsers.
    
    Returns:
    the connection pool to be used by the LDAP entry browsers.
  - getIconPool
```
public IconPool getIconPool()
```
    Returns the icon pool to be used by the LDAP entry browsers.
    
    Returns:
    the icon pool to be used by the LDAP entry browsers.
  - getPoolingPeriod
```
public long getPoolingPeriod()
```
    Returns the pooling period in miliseconds.
    
    Returns:
    the pooling period in miliseconds.
  - setPoolingPeriod
```
public void setPoolingPeriod(long poolingPeriod)
```
    Sets the pooling period in miliseconds.
    
    Parameters:
    poolingPeriod - the pooling time in miliseconds.
  - initializeConfigurationFramework
```
public void initializeConfigurationFramework()
                                      throws ConfigException
```
    Initialize the new configuration framework if needed.
    
    Throws:
    
    ConfigException - If error occurred during the initialization

Class ControlPanelInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ControlPanelInfo

Method Detail

getInstance

getServerDescriptor

getTasks

registerTask

unregisterTask

mustReindex

registerModifiedIndex

unregisterModifiedIndex

unregisterModifiedIndexesInBackend

getModifiedIndexes

setDirContext

getDirContext

setUserDataDirContext

getUserDataDirContext

backupCreated

backendPopulated

indexModified

createNewServerDescriptorInstance

createNewConfigFromFileReader

createNewConfigFromDirContextReader

updateServerDescriptor

regenerateDescriptor

addConfigChangeListener

removeConfigChangeListener

addBackupCreatedListener

removeBackupCreatedListener

addBackendPopulatedListener

removeBackendPopulatedListener

addIndexModifiedListener

removeIndexModifiedListener

startPooling

stopPooling

getTrustManager

setTrustManager

getConnectTimeout

setConnectTimeout

getConnectionPolicy

setConnectionPolicy

getLDAPSURL

getAdminConnectorURL

getLocalAdminConnectorURL

getLDAPURL

getStartTLSURL

connectUsingStartTLS

connectUsingLDAPS

getURLToConnect

mustDeregisterConfig

setMustDeregisterConfig

setIsLocal

isLocal

getConnectionPool

getIconPool

getPoolingPeriod

setPoolingPeriod

initializeConfigurationFramework