ServerDescriptor (OpenDJ 3.0.0 Documentation)

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

```
public class ServerDescriptor
extends Object
```
This is just a class used to provide a data model describing what the StatusPanelDialog will show to the user.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ServerDescriptor.ServerStatus
Enumeration indicating the status of the server.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ServerDescriptor.ServerStatus` Enumeration indicating the status of the server.

Constructor Summary

Constructors
Constructor and Description

ServerDescriptor()
Default constructor.

Constructors
Constructor and Description
`ServerDescriptor()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`areSchemasEqual(Schema schema1, Schema schema2)` Method used to compare schemas.
`boolean`	`equals(Object o)`
`ConnectionHandlerDescriptor`	`getAdminConnector()` Returns the admin connector.
`Set<DN>`	`getAdministrativeUsers()` Return the administrative users.
`Set<BackendDescriptor>`	`getBackends()` Returns the backend descriptors of the server.
`Set<ConnectionHandlerDescriptor>`	`getConnectionHandlers()` Returns the listener descriptors of the server.
`CustomSearchResult`	`getEntryCachesMonitor()` Returns the monitoring entry for the entry caches.
`List<OpenDsException>`	`getExceptions()` Returns the exceptions that occurred while reading the configuration.
`String`	`getHostname()` Returns the host name of the server.
`String`	`getInstallPath()` Return the install path where the server is installed.
`String`	`getInstancePath()` Return the instance path where the server databases and configuration is located.
`String`	`getJavaVersion()` Return the java version used to run the server.
`CustomSearchResult`	`getJvmMemoryUsageMonitor()` Returns the monitoring entry for the JVM memory usage.
`int`	`getOpenConnections()` Returns the number of open connection in the server.
`String`	`getOpenDSVersion()` Returns the version of the server.
`CustomSearchResult`	`getRootMonitor()` Returns the root entry of the monitoring tree.
`long`	`getRunningTime()` Returns the running time of the server in milliseconds.
`Schema`	`getSchema()` Returns the schema of the server.
`ServerDescriptor.ServerStatus`	`getStatus()` Returns the status of the server.
`CustomSearchResult`	`getSystemInformationMonitor()` Returns the monitoring entry for the system information.
`Set<TaskEntry>`	`getTaskEntries()` Returns the task entries.
`CustomSearchResult`	`getWorkQueueMonitor()` Returns the monitoring entry for the work queue.
`int`	`hashCode()`
`boolean`	`isAuthenticated()` Return whether we were authenticated when retrieving the information of this ServerStatusDescriptor.
`boolean`	`isLocal()` Returns `true` if we are trying to manage the local host and `false` otherwise.
`boolean`	`isSchemaEnabled()` Returns whether the schema is enabled or not.
`boolean`	`isWindows()` Returns whether the server is running under a windows system or not.
`boolean`	`isWindowsServiceEnabled()` Tells whether the windows service is enabled or not.
`boolean`	`sameInstallAndInstance()` Returns whether the install and the instance are on the same server or not.
`void`	`setAdminConnector(ConnectionHandlerDescriptor adminConnector)` Sets the admin connector.
`void`	`setAdministrativeUsers(Set<DN> administrativeUsers)` Set the administrative users.
`void`	`setAuthenticated(boolean isAuthenticated)` Sets whether we were authenticated when retrieving the information of this ServerStatusDescriptor.
`void`	`setBackends(Set<BackendDescriptor> backends)` Sets the backend descriptors of the server.
`void`	`setConnectionHandlers(Set<ConnectionHandlerDescriptor> listeners)` Sets the listener descriptors of the server.
`void`	`setEntryCachesMonitor(CustomSearchResult entryCaches)` Sets the monitoring entry for the entry caches.
`void`	`setExceptions(Collection<OpenDsException> exceptions)` Sets the exceptions that occurred while reading the configuration.
`void`	`setHostname(String hostName)` Sets the host name of the server.
`void`	`setInstallPath(String installPath)` Sets the install path where the server is installed.
`void`	`setInstancePath(String instancePath)` Sets the instance path where the server databases and configuration is located.
`void`	`setIsLocal(boolean isLocal)` Sets whether this server represents the local instance or a remote server.
`void`	`setJavaVersion(String javaVersion)` Set the java version used to run the server.
`void`	`setJvmMemoryUsageMonitor(CustomSearchResult jvmMemoryUsage)` Sets the monitoring entry for the JVM memory usage.
`void`	`setOpenConnections(int openConnections)` Set the number of open connections.
`void`	`setOpenDSVersion(String openDSVersion)` Sets the version of the server.
`void`	`setRootMonitor(CustomSearchResult rootMonitor)` Sets the root entry of the monitoring tree.
`void`	`setSchema(Schema schema)` Sets the schema of the server.
`void`	`setSchemaEnabled(boolean isSchemaEnabled)` Sets whether the schema is enabled or not.
`void`	`setStatus(ServerDescriptor.ServerStatus status)` Sets the status of the server.
`void`	`setSystemInformationMonitor(CustomSearchResult systemInformation)` Sets the monitoring entry for the system information.
`void`	`setTaskEntries(Set<TaskEntry> taskEntries)` Sets the the task entries.
`void`	`setWindowsServiceEnabled(boolean isWindowsServiceEnabled)` Sets whether the windows service is enabled or not.
`void`	`setWorkQueueMonitor(CustomSearchResult workQueue)` Sets the monitoring entry of the work queue.

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

- Constructor Detail
  - ServerDescriptor
```
public ServerDescriptor()
```
    Default constructor.
- Method Detail
  - getAdministrativeUsers
```
public Set<DN> getAdministrativeUsers()
```
    Return the administrative users.
    
    Returns:
    the administrative users.
  - setAdministrativeUsers
```
public void setAdministrativeUsers(Set<DN> administrativeUsers)
```
    Set the administrative users.
    
    Parameters:
    administrativeUsers - the administrative users to set
  - isSchemaEnabled
```
public boolean isSchemaEnabled()
```
    Returns whether the schema is enabled or not.
    
    Returns:
    true if the schema is enabled and false otherwise.
  - setSchemaEnabled
```
public void setSchemaEnabled(boolean isSchemaEnabled)
```
    Sets whether the schema is enabled or not.
    
    Parameters:
    isSchemaEnabled - true if the schema is enabled and false otherwise.
  - getInstancePath
```
public String getInstancePath()
```
    Return the instance path where the server databases and configuration is located.
    
    Returns:
    the instance path where the server databases and configuration is located
  - setInstancePath
```
public void setInstancePath(String instancePath)
```
    Sets the instance path where the server databases and configuration is located.
    
    Parameters:
    instancePath - the instance path where the server databases and configuration is located.
  - getInstallPath
```
public String getInstallPath()
```
    Return the install path where the server is installed.
    
    Returns:
    the install path where the server is installed.
  - setInstallPath
```
public void setInstallPath(String installPath)
```
    Sets the install path where the server is installed.
    
    Parameters:
    installPath - the install path where the server is installed.
  - sameInstallAndInstance
```
public boolean sameInstallAndInstance()
```
    Returns whether the install and the instance are on the same server or not.
    
    Returns:
    whether the install and the instance are on the same server or not.
  - getJavaVersion
```
public String getJavaVersion()
```
    Return the java version used to run the server.
    
    Returns:
    the java version used to run the server.
  - setJavaVersion
```
public void setJavaVersion(String javaVersion)
```
    Set the java version used to run the server.
    
    Parameters:
    javaVersion - the java version used to run the server.
  - getOpenConnections
```
public int getOpenConnections()
```
    Returns the number of open connection in the server.
    
    Returns:
    the number of open connection in the server.
  - setOpenConnections
```
public void setOpenConnections(int openConnections)
```
    Set the number of open connections.
    
    Parameters:
    openConnections - the number of open connections.
  - getOpenDSVersion
```
public String getOpenDSVersion()
```
    Returns the version of the server.
    
    Returns:
    the version of the server.
  - setOpenDSVersion
```
public void setOpenDSVersion(String openDSVersion)
```
    Sets the version of the server.
    
    Parameters:
    openDSVersion - the version of the server.
  - getStatus
```
public ServerDescriptor.ServerStatus getStatus()
```
    Returns the status of the server.
    
    Returns:
    the status of the server.
  - setStatus
```
public void setStatus(ServerDescriptor.ServerStatus status)
```
    Sets the status of the server.
    
    Parameters:
    status - the status of the server.
  - getTaskEntries
```
public Set<TaskEntry> getTaskEntries()
```
    Returns the task entries.
    
    Returns:
    the task entries.
  - setTaskEntries
```
public void setTaskEntries(Set<TaskEntry> taskEntries)
```
    Sets the the task entries.
    
    Parameters:
    taskEntries - the task entries.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Return whether we were authenticated when retrieving the information of this ServerStatusDescriptor.
    
    Returns:
    true if we were authenticated when retrieving the information of this ServerStatusDescriptor and false otherwise.
  - setAuthenticated
```
public void setAuthenticated(boolean isAuthenticated)
```
    Sets whether we were authenticated when retrieving the information of this ServerStatusDescriptor.
    
    Parameters:
    isAuthenticated - whether we were authenticated when retrieving the information of this ServerStatusDescriptor.
  - getBackends
```
public Set<BackendDescriptor> getBackends()
```
    Returns the backend descriptors of the server.
    
    Returns:
    the backend descriptors of the server.
  - setBackends
```
public void setBackends(Set<BackendDescriptor> backends)
```
    Sets the backend descriptors of the server.
    
    Parameters:
    backends - the database descriptors to set.
  - getConnectionHandlers
```
public Set<ConnectionHandlerDescriptor> getConnectionHandlers()
```
    Returns the listener descriptors of the server.
    
    Returns:
    the listener descriptors of the server.
  - setConnectionHandlers
```
public void setConnectionHandlers(Set<ConnectionHandlerDescriptor> listeners)
```
    Sets the listener descriptors of the server.
    
    Parameters:
    listeners - the listener descriptors to set.
  - setSchema
```
public void setSchema(Schema schema)
```
    Sets the schema of the server.
    
    Parameters:
    schema - the schema of the server.
  - getSchema
```
public Schema getSchema()
```
    Returns the schema of the server.
    
    Returns:
    the schema of the server.
  - getHostname
```
public String getHostname()
```
    Returns the host name of the server.
    
    Returns:
    the host name of the server.
  - setHostname
```
public void setHostname(String hostName)
```
    Sets the host name of the server.
    
    Parameters:
    hostName - the host name of the server.
  - 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.
  - 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).
  - getExceptions
```
public List<OpenDsException> getExceptions()
```
    Returns the exceptions that occurred while reading the configuration.
    
    Returns:
    the exceptions that occurred while reading the configuration.
  - setExceptions
```
public void setExceptions(Collection<OpenDsException> exceptions)
```
    Sets the exceptions that occurred while reading the configuration.
    
    Parameters:
    exceptions - exceptions that occurred while reading the configuration.
  - isWindowsServiceEnabled
```
public boolean isWindowsServiceEnabled()
```
    Tells whether the windows service is enabled or not.
    
    Returns:
    true if the windows service is enabled and false otherwise.
  - setWindowsServiceEnabled
```
public void setWindowsServiceEnabled(boolean isWindowsServiceEnabled)
```
    Sets whether the windows service is enabled or not.
    
    Parameters:
    isWindowsServiceEnabled - true if the windows service is enabled and false otherwise.
  - isWindows
```
public boolean isWindows()
```
    Returns whether the server is running under a windows system or not.
    
    Returns:
    whether the server is running under a windows system or not.
  - areSchemasEqual
```
public static boolean areSchemasEqual(Schema schema1,
                      Schema schema2)
```
    Method used to compare schemas. Returns true if the two schemas are equal and false otherwise.
    
    Parameters:
    schema1 - the first schema.
    schema2 - the second schema.
    
    Returns:
    true if the two schemas are equal and false otherwise.
  - getAdminConnector
```
public ConnectionHandlerDescriptor getAdminConnector()
```
    Returns the admin connector.
    
    Returns:
    the admin connector.
  - setAdminConnector
```
public void setAdminConnector(ConnectionHandlerDescriptor adminConnector)
```
    Sets the admin connector.
    
    Parameters:
    adminConnector - the admin connector.
  - setEntryCachesMonitor
```
public void setEntryCachesMonitor(CustomSearchResult entryCaches)
```
    Sets the monitoring entry for the entry caches.
    
    Parameters:
    entryCaches - the monitoring entry for the entry caches.
  - setJvmMemoryUsageMonitor
```
public void setJvmMemoryUsageMonitor(CustomSearchResult jvmMemoryUsage)
```
    Sets the monitoring entry for the JVM memory usage.
    
    Parameters:
    jvmMemoryUsage - the monitoring entry for the JVM memory usage.
  - setRootMonitor
```
public void setRootMonitor(CustomSearchResult rootMonitor)
```
    Sets the root entry of the monitoring tree.
    
    Parameters:
    rootMonitor - the root entry of the monitoring tree.
  - getRunningTime
```
public long getRunningTime()
```
    Returns the running time of the server in milliseconds. Returns -1 if no running time could be found.
    
    Returns:
    the running time of the server in milliseconds.
  - setSystemInformationMonitor
```
public void setSystemInformationMonitor(CustomSearchResult systemInformation)
```
    Sets the monitoring entry for the system information.
    
    Parameters:
    systemInformation - entry for the system information.
  - setWorkQueueMonitor
```
public void setWorkQueueMonitor(CustomSearchResult workQueue)
```
    Sets the monitoring entry of the work queue.
    
    Parameters:
    workQueue - entry of the work queue.
  - getEntryCachesMonitor
```
public CustomSearchResult getEntryCachesMonitor()
```
    Returns the monitoring entry for the entry caches.
    
    Returns:
    the monitoring entry for the entry caches.
  - getJvmMemoryUsageMonitor
```
public CustomSearchResult getJvmMemoryUsageMonitor()
```
    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.
  - getSystemInformationMonitor
```
public CustomSearchResult getSystemInformationMonitor()
```
    Returns the monitoring entry for the system information.
    
    Returns:
    the monitoring entry for the system information.
  - getWorkQueueMonitor
```
public CustomSearchResult getWorkQueueMonitor()
```
    Returns the monitoring entry for the work queue.
    
    Returns:
    the monitoring entry for the work queue.

Class ServerDescriptor

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServerDescriptor

Method Detail

getAdministrativeUsers

setAdministrativeUsers

isSchemaEnabled

setSchemaEnabled

getInstancePath

setInstancePath

getInstallPath

setInstallPath

sameInstallAndInstance

getJavaVersion

setJavaVersion

getOpenConnections

setOpenConnections

getOpenDSVersion

setOpenDSVersion

getStatus

setStatus

getTaskEntries

setTaskEntries

equals

hashCode

isAuthenticated

setAuthenticated

getBackends

setBackends

getConnectionHandlers

setConnectionHandlers

setSchema

getSchema

getHostname

setHostname

isLocal

setIsLocal

getExceptions

setExceptions

isWindowsServiceEnabled

setWindowsServiceEnabled

isWindows

areSchemasEqual

getAdminConnector

setAdminConnector

setEntryCachesMonitor

setJvmMemoryUsageMonitor

setRootMonitor

getRunningTime

setSystemInformationMonitor

setWorkQueueMonitor

getEntryCachesMonitor

getJvmMemoryUsageMonitor

getRootMonitor

getSystemInformationMonitor

getWorkQueueMonitor