Package org.opends.guitools.controlpanel.datamodel

Class BackendDescriptor

java.lang.Object

org.opends.guitools.controlpanel.datamodel.BackendDescriptor

public class BackendDescriptor
extends Object

The class that describes the backend configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BackendDescriptor.PluggableType	An enumeration describing the different pluggable backends.
static class	BackendDescriptor.Type	An enumeration describing the type of backend.

Constructor Summary

Constructors

Constructor	Description
BackendDescriptor(String backendID, Set<BaseDNDescriptor> baseDns, Set<IndexDescriptor> indexes, Set<VLVIndexDescriptor> vlvIndexes, int entries, boolean isEnabled, BackendDescriptor.Type type)	Constructor for this class.

Method Summary

Modifier and Type	Method	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.
SearchResultEntry	getMonitoringEntry()	Returns the monitoring entry information.
BackendDescriptor.PluggableType	getPluggableType()	Get the type of pluggable backend.
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(SearchResultEntry sr)	Sets the monitoring entry corresponding to this backend.
void	setPluggableType(BackendDescriptor.PluggableType pluggableType)	Set the type of pluggable backend.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BackendDescriptor

public BackendDescriptor(String backendID,
                         Set<BaseDNDescriptor> baseDns,
                         Set<IndexDescriptor> indexes,
                         Set<VLVIndexDescriptor> vlvIndexes,
                         int entries,
                         boolean isEnabled,
                         BackendDescriptor.Type type)

Constructor for this class.

Parameters:

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.

Method Detail

getBackendID

public String getBackendID()

Returns the ID of the Backend.

Returns:

the ID of the Backend.

getBaseDns

public SortedSet<BaseDNDescriptor> getBaseDns()

Returns the Base DN objects associated with the backend.

Returns:

the Base DN objects associated with the backend.

getVLVIndexes

public SortedSet<VLVIndexDescriptor> getVLVIndexes()

Returns the vlv index objects associated with the backend.

Returns:

the vlv index objects associated with the backend.

getIndexes

public SortedSet<IndexDescriptor> getIndexes()

Returns the index objects associated with the backend.

Returns:

the index objects associated with the backend.

getEntries

public int getEntries()

Return the number of entries in the backend. -1 indicates that the number of entries could not be found.

Returns:

the number of entries in the backend.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getMonitoringEntry

public SearchResultEntry getMonitoringEntry()

Returns the monitoring entry information.

Returns:

the monitoring entry information.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isConfigBackend

public boolean isConfigBackend()

Tells whether this is a configuration backend or not.

Returns:

true if this is a configuration backend, false otherwise.

setEntries

public void setEntries(int entries)

Sets the number of entries contained in this backend.

Parameters:

entries - the number of entries contained in this backend.

setMonitoringEntry

public void setMonitoringEntry(SearchResultEntry sr)

Sets the monitoring entry corresponding to this backend.

Parameters:

sr - the monitoring entry corresponding to this backend.

getType

public BackendDescriptor.Type getType()

Returns the type of the backend.

Returns:

the type of the backend.

isEnabled

public boolean isEnabled()

Tells whether this backend is enabled or not.

Returns:

true if this is backend is enabled, false otherwise.

setPluggableType

public void setPluggableType(BackendDescriptor.PluggableType pluggableType)

Set the type of pluggable backend.

Parameters:

pluggableType - the type of pluggable backend.

getPluggableType

public BackendDescriptor.PluggableType getPluggableType()

Get the type of pluggable backend.

Returns:

the type of pluggable backend.

toString

public String toString()

Overrides:

toString in class Object