Package org.opends.server.backends

Record Class RebuildConfig

java.lang.Object

java.lang.Record

org.opends.server.backends.RebuildConfig

Record Components:

baseDn - the local backend's base DN for which to rebuild indexes

rebuildIndexSelection - how to select indexes to rebuild

rebuildList - the user-provided list of indexes to rebuild. Only significant when rebuildIndexSelection is RebuildConfig.RebuildIndexSelection.USER_DEFINED

tmpDirectory - the temporary directory for rebuild-index

setUntrusted - whether indexes should be forcefully marked as untrusted

public record RebuildConfig(Dn baseDn, RebuildConfig.RebuildIndexSelection rebuildIndexSelection, Collection<String> rebuildList, String tmpDirectory, boolean setUntrusted)
extends Record

Configuration for the indexType rebuild process.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RebuildConfig.RebuildIndexSelection	Identifies which indexes will be selected for rebuild.

Constructor Summary

Constructors

Constructor	Description
RebuildConfig(Dn baseDn, RebuildConfig.RebuildIndexSelection rebuildIndexSelection, Collection<String> rebuildList, String tmpDirectory, boolean setUntrusted)	Builds a new rebuild config object.

Method Summary

Modifier and Type	Method	Description
Dn	baseDn()	Returns the value of the baseDn record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	includesSystemIndex()	Test if this rebuild config includes any system indexes to rebuild.
RebuildConfig.RebuildIndexSelection	rebuildIndexSelection()	Returns the value of the rebuildIndexSelection record component.
Collection<String>	rebuildList()	Returns the value of the rebuildList record component.
boolean	setUntrusted()	Returns the value of the setUntrusted record component.
String	tmpDirectory()	Returns the value of the tmpDirectory record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

RebuildConfig

public RebuildConfig(Dn baseDn,
 RebuildConfig.RebuildIndexSelection rebuildIndexSelection,
 Collection<String> rebuildList,
 String tmpDirectory,
 boolean setUntrusted)

Builds a new rebuild config object.

Method Details

includesSystemIndex

public boolean includesSystemIndex()

Test if this rebuild config includes any system indexes to rebuild.

Returns:

True if rebuilding of system indexes are included. False otherwise.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

baseDn

public Dn baseDn()

Returns the value of the baseDn record component.

Returns:

the value of the baseDn record component

rebuildIndexSelection

public RebuildConfig.RebuildIndexSelection rebuildIndexSelection()

Returns the value of the rebuildIndexSelection record component.

Returns:

the value of the rebuildIndexSelection record component

rebuildList

public Collection<String> rebuildList()

Returns the value of the rebuildList record component.

Returns:

the value of the rebuildList record component

tmpDirectory

public String tmpDirectory()

Returns the value of the tmpDirectory record component.

Returns:

the value of the tmpDirectory record component

setUntrusted

public boolean setUntrusted()

Returns the value of the setUntrusted record component.

Returns:

the value of the setUntrusted record component