Package org.opends.server.backends

Class RebuildConfig

java.lang.Object
org.opends.server.backends.RebuildConfig
public class RebuildConfig extends Object
Configuration for the indexType rebuild process.

  • Constructor Details

    • RebuildConfig

      public RebuildConfig(Dn baseDN)
      Builds a new rebuild config object.
      Parameters:
      baseDN - The base DN to rebuild.

  • Method Details

    • getBaseDN

      public Dn getBaseDN()
      Get the base DN to rebuild.
      Returns:
      The base DN to rebuild.

    • getRebuildList

      public List<String> getRebuildList()
      Get the list of indexes to rebuild in this configuration.
      Returns:
      The list of indexes to rebuild.

    • addRebuildIndex

      public void addRebuildIndex(String index)
      Add an index to be rebuilt into the configuration. Duplicate index names will be ignored. Adding an index that causes a mix of complete and partial rebuild for the same attribute index in the configuration will remove the partial and just keep the complete attribute index name. (ie. uid and uid.presence).
      Parameters:
      index - The index to add.

    • 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.

    • setTmpDirectory

      public void setTmpDirectory(String path)
      Set the temporary directory to the specified path.
      Parameters:
      path - The path to set the temporary directory to.

    • getTmpDirectory

      public String getTmpDirectory()
      Return the temporary directory path.
      Returns:
      The temporary directory string.

    • setRebuildMode

      public void setRebuildMode(RebuildConfig.RebuildMode mode)
      Sets the rebuild mode.
      Parameters:
      mode - The new rebuild mode.

    • getRebuildMode

      public RebuildConfig.RebuildMode getRebuildMode()
      Returns the rebuild mode.
      Returns:
      The rebuild mode.

    • isClearDegradedState

      public boolean isClearDegradedState()
      Returns true if indexes should be forcefully marked as valid even if they are currently degraded.
      Returns:
      true if index should be forcefully marked as valid.

    • isClearDegradedState

      public void isClearDegradedState(boolean isClearDegradedState)
      Sets the 'clear degraded index' status.
      Parameters:
      isClearDegradedState - true if indexes should be forcefully marked as valid even if they are currently degraded.