public class ServerDescriptor extends Object
Modifier and Type | Class and Description |
---|---|
static class |
ServerDescriptor.ServerStatus
Enumeration indicating the status of the server.
|
Constructor and Description |
---|
ServerDescriptor()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
areSchemasEqual(org.forgerock.opendj.ldap.schema.Schema schema1,
org.forgerock.opendj.ldap.schema.Schema schema2)
Method used to compare schemas.
|
boolean |
equals(Object o) |
ConnectionHandlerDescriptor |
getAdminConnector()
Returns the admin connector.
|
Set<org.forgerock.opendj.ldap.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.
|
org.forgerock.opendj.ldap.messages.SearchResultEntry |
getEntryCachesMonitor()
Returns the monitoring entry for the entry caches.
|
List<Exception> |
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.
|
org.forgerock.opendj.ldap.messages.SearchResultEntry |
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.
|
org.forgerock.opendj.ldap.messages.SearchResultEntry |
getRootMonitor()
Returns the root entry of the monitoring tree.
|
long |
getRunningTime()
Returns the running time of the server in milliseconds.
|
org.forgerock.opendj.ldap.schema.Schema |
getSchema()
Returns the schema of the server.
|
ServerDescriptor.ServerStatus |
getStatus()
Returns the status of the server.
|
org.forgerock.opendj.ldap.messages.SearchResultEntry |
getSystemInformationMonitor()
Returns the monitoring entry for the system information.
|
Set<TaskEntry> |
getTaskEntries()
Returns the task entries.
|
org.forgerock.opendj.ldap.messages.SearchResultEntry |
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 whether we are trying to manage the local host.
|
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<org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.messages.SearchResultEntry entryCaches)
Sets the monitoring entry for the entry caches.
|
void |
setExceptions(Collection<Exception> 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(org.forgerock.opendj.ldap.messages.SearchResultEntry jvmMemoryUsage)
Sets the monitoring entry for the JVM memory usage.
|
void |
setOpenConnections(int openConnections)
Set the number of open connections.
|
void |
setOpenDJVersion(String openDSVersion)
Sets the version of the server.
|
void |
setRootMonitor(org.forgerock.opendj.ldap.messages.SearchResultEntry rootMonitor)
Sets the root entry of the monitoring tree.
|
void |
setSchema(org.forgerock.opendj.ldap.schema.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(org.forgerock.opendj.ldap.messages.SearchResultEntry 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(org.forgerock.opendj.ldap.messages.SearchResultEntry workQueue)
Sets the monitoring entry of the work queue.
|
String |
toString() |
public ServerDescriptor()
public Set<org.forgerock.opendj.ldap.Dn> getAdministrativeUsers()
public void setAdministrativeUsers(Set<org.forgerock.opendj.ldap.Dn> administrativeUsers)
administrativeUsers
- the administrative users to setpublic boolean isSchemaEnabled()
true
if the schema is enabled, false
otherwise.public void setSchemaEnabled(boolean isSchemaEnabled)
isSchemaEnabled
- true
if the schema is enabled, false
otherwise.public String getInstancePath()
public void setInstancePath(String instancePath)
instancePath
- the instance path where the server databases and
configuration is located.public String getInstallPath()
public void setInstallPath(String installPath)
installPath
- the install path where the server is installed.public boolean sameInstallAndInstance()
public String getJavaVersion()
public void setJavaVersion(String javaVersion)
javaVersion
- the java version used to run the server.public int getOpenConnections()
public void setOpenConnections(int openConnections)
openConnections
- the number of open connections.public String getOpenDSVersion()
public void setOpenDJVersion(String openDSVersion)
openDSVersion
- the version of the server.public ServerDescriptor.ServerStatus getStatus()
public void setStatus(ServerDescriptor.ServerStatus status)
status
- the status of the server.public Set<TaskEntry> getTaskEntries()
public void setTaskEntries(Set<TaskEntry> taskEntries)
taskEntries
- the task entries.public boolean isAuthenticated()
true
if we were authenticated when retrieving the
information of this ServerStatusDescriptor and false
otherwise.public void setAuthenticated(boolean isAuthenticated)
isAuthenticated
- whether we were authenticated when retrieving the
information of this ServerStatusDescriptor.public Set<BackendDescriptor> getBackends()
public void setBackends(Set<BackendDescriptor> backends)
backends
- the database descriptors to set.public Set<ConnectionHandlerDescriptor> getConnectionHandlers()
public void setConnectionHandlers(Set<ConnectionHandlerDescriptor> listeners)
listeners
- the listener descriptors to set.public void setSchema(org.forgerock.opendj.ldap.schema.Schema schema)
schema
- the schema of the server.public org.forgerock.opendj.ldap.schema.Schema getSchema()
public String getHostname()
public void setHostname(String hostName)
hostName
- the host name of the server.public boolean isLocal()
true
if we are trying to manage the local host, false
otherwise.public void setIsLocal(boolean isLocal)
isLocal
- whether this server represents the local instance or a
remote server (in another machine or in another installation on the same
machine).public List<Exception> getExceptions()
public void setExceptions(Collection<Exception> exceptions)
exceptions
- exceptions that occurred while reading the
configuration.public boolean isWindowsServiceEnabled()
true
if the windows service is enabled, false
otherwise.public void setWindowsServiceEnabled(boolean isWindowsServiceEnabled)
isWindowsServiceEnabled
- true
if the windows service is
enabled, false
otherwise.public boolean isWindows()
public static boolean areSchemasEqual(org.forgerock.opendj.ldap.schema.Schema schema1, org.forgerock.opendj.ldap.schema.Schema schema2)
schema1
- the first schema.schema2
- the second schema.true
if the two schemas are equal, false
otherwise.public ConnectionHandlerDescriptor getAdminConnector()
public void setAdminConnector(ConnectionHandlerDescriptor adminConnector)
adminConnector
- the admin connector.public void setEntryCachesMonitor(org.forgerock.opendj.ldap.messages.SearchResultEntry entryCaches)
entryCaches
- the monitoring entry for the entry caches.public void setJvmMemoryUsageMonitor(org.forgerock.opendj.ldap.messages.SearchResultEntry jvmMemoryUsage)
jvmMemoryUsage
- the monitoring entry for the JVM memory usage.public void setRootMonitor(org.forgerock.opendj.ldap.messages.SearchResultEntry rootMonitor)
rootMonitor
- the root entry of the monitoring tree.public long getRunningTime()
public void setSystemInformationMonitor(org.forgerock.opendj.ldap.messages.SearchResultEntry systemInformation)
systemInformation
- entry for the system information.public void setWorkQueueMonitor(org.forgerock.opendj.ldap.messages.SearchResultEntry workQueue)
workQueue
- entry of the work queue.public org.forgerock.opendj.ldap.messages.SearchResultEntry getEntryCachesMonitor()
public org.forgerock.opendj.ldap.messages.SearchResultEntry getJvmMemoryUsageMonitor()
public org.forgerock.opendj.ldap.messages.SearchResultEntry getRootMonitor()
public org.forgerock.opendj.ldap.messages.SearchResultEntry getSystemInformationMonitor()
public org.forgerock.opendj.ldap.messages.SearchResultEntry getWorkQueueMonitor()
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.