public class BackendDescriptor extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
BackendDescriptor.Type
An enumeration describing the type of backend.
|
| Constructor and Description |
|---|
BackendDescriptor(String backendID,
Set<BaseDNDescriptor> baseDns,
Set<IndexDescriptor> indexes,
Set<VLVIndexDescriptor> vlvIndexes,
int entries,
boolean isEnabled,
BackendDescriptor.Type type)
Constructor for this class.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object o) |
String |
getBackendID()
Returns the ID of the Backend.
|
SortedSet<BaseDNDescriptor> |
getBaseDns()
Returns the Base DN objects associated with the backend.
|
int |
getEntries()
Return the number of entries in the backend.
|
SortedSet<IndexDescriptor> |
getIndexes()
Returns the index objects associated with the backend.
|
CustomSearchResult |
getMonitoringEntry()
Returns the monitoring entry information.
|
BackendDescriptor.Type |
getType()
Returns the type of the backend.
|
SortedSet<VLVIndexDescriptor> |
getVLVIndexes()
Returns the vlv index objects associated with the backend.
|
int |
hashCode() |
boolean |
isConfigBackend()
Tells whether this is a configuration backend or not.
|
boolean |
isEnabled()
Tells whether this backend is enabled or not.
|
void |
setEntries(int entries)
Sets the number of entries contained in this backend.
|
void |
setMonitoringEntry(CustomSearchResult monitoringEntry)
Sets the monitoring entry corresponding to this backend.
|
public BackendDescriptor(String backendID, Set<BaseDNDescriptor> baseDns, Set<IndexDescriptor> indexes, Set<VLVIndexDescriptor> vlvIndexes, int entries, boolean isEnabled, BackendDescriptor.Type type)
backendID - the backend ID of the Backend.baseDns - the base DNs associated with the Backend.indexes - the indexes defined in the backend.vlvIndexes - the VLV indexes defined in the backend.entries - the number of entries in the Backend.isEnabled - whether the backend is enabled or not.type - the type of the backend.public String getBackendID()
public SortedSet<BaseDNDescriptor> getBaseDns()
public SortedSet<VLVIndexDescriptor> getVLVIndexes()
public SortedSet<IndexDescriptor> getIndexes()
public int getEntries()
public CustomSearchResult getMonitoringEntry()
public boolean isConfigBackend()
true if this is a configuration backend and
false otherwise.public void setEntries(int entries)
entries - the number of entries contained in this backend.public void setMonitoringEntry(CustomSearchResult monitoringEntry)
monitoringEntry - the monitoring entry corresponding to this backend.public BackendDescriptor.Type getType()
public boolean isEnabled()
true if this is backend is enabled
false otherwise.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.