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() |
Modifier and Type | Method and Description |
---|---|
ConnectionHandlerDescriptor |
getAdminConnector()
Returns the admin connector.
|
Set<BackendDescriptor> |
getBackends()
Returns the backend descriptors of the server.
|
Set<ConnectionHandlerDescriptor> |
getConnectionHandlers()
Returns the listener descriptors of the server.
|
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.
|
int |
getOpenConnections()
Returns the number of open connection in the server.
|
String |
getOpenDSVersion()
Returns the version of the server.
|
Schema |
getSchema()
Returns the schema of the server.
|
ServerDescriptor.ServerStatus |
getStatus()
Returns the status of the server.
|
boolean |
isAuthenticated()
Return whether we were authenticated when retrieving the information of this server descriptor.
|
boolean |
isLocal()
Returns whether we are trying to manage the local host.
|
boolean |
sameInstallAndInstance()
Returns whether the install and the instance are on the same server or not.
|
void |
setAuthenticated(boolean isAuthenticated)
Sets whether we were authenticated when retrieving the information of this server descriptor.
|
void |
setBackends(Set<BackendDescriptor> backends)
Sets the backend descriptors of the server.
|
void |
setExceptions(Collection<Exception> exceptions)
Sets the exceptions that occurred while reading the configuration.
|
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 |
setSchema(Schema schema)
Sets the schema of the server.
|
void |
setStatus(ServerDescriptor.ServerStatus status)
Sets the status of the server.
|
String |
toString() |
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 int getOpenConnections()
public String getOpenDSVersion()
public ServerDescriptor.ServerStatus getStatus()
public void setStatus(ServerDescriptor.ServerStatus status)
status
- the status of the server.public boolean isAuthenticated()
true
if we were authenticated when retrieving the information of this server descriptor,
false
otherwise.public void setAuthenticated(boolean isAuthenticated)
isAuthenticated
- whether we were authenticated when retrieving the information of this server descriptor.public Set<BackendDescriptor> getBackends()
public void setBackends(Set<BackendDescriptor> backends)
backends
- the database descriptors to set.public Set<ConnectionHandlerDescriptor> getConnectionHandlers()
public void setSchema(Schema schema)
schema
- the schema of the server.public Schema getSchema()
public String getHostname()
public boolean isLocal()
true
if we are trying to manage the local host, false
otherwise.public List<Exception> getExceptions()
public void setExceptions(Collection<Exception> exceptions)
exceptions
- exceptions that occurred while reading the configuration.public ConnectionHandlerDescriptor getAdminConnector()
Copyright 2010-2018 ForgeRock AS.