Package com.atlassian.confluence.search

Enum Class ReIndexOption

java.lang.Object
java.lang.Enum<ReIndexOption>
com.atlassian.confluence.search.ReIndexOption
All Implemented Interfaces:
ReIndexSupport<Object>, Serializable, Comparable<ReIndexOption>, Constable
@Deprecated public enum ReIndexOption extends Enum<ReIndexOption> implements ReIndexSupport<Object>
Deprecated.
since 10.1.0. Use ReIndexOption from com.atlassian.confluence.api.service.index instead if possible.
Options for reindexing operations in Confluence. NB when adding options, also add to the metric tags in LuceneFullReindexManager
Since:
5.10

  • Enum Constant Details

    • CONTENT_ONLY

      public static final ReIndexOption CONTENT_ONLY
      Deprecated.
      All content except those others specifically listed below - e.g. attachments or users

    • ATTACHMENT_ONLY

      public static final ReIndexOption ATTACHMENT_ONLY
      Deprecated.
      Attachment only

    • USER_ONLY

      public static final ReIndexOption USER_ONLY
      Deprecated.
      User only

  • Method Details

    • values

      public static ReIndexOption[] values()
      Deprecated.
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ReIndexOption valueOf(String name)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getDeleteQuery

      public SearchQuery getDeleteQuery()
      Deprecated.
      Description copied from interface: ReIndexSupport
      Get the search query for deleting documents during reindexing.
      Specified by:
      getDeleteQuery in interface ReIndexSupport<Object>
      Returns:
      the delete query

    • getDeleteQuery

      public SearchQuery getDeleteQuery(Optional<String> spaceKey)
      Deprecated.
      Description copied from interface: ReIndexSupport
      Get the search query for deleting documents during reindexing within a specific space.
      Specified by:
      getDeleteQuery in interface ReIndexSupport<Object>
      Parameters:
      spaceKey - the space key to limit the deletion to
      Returns:
      the delete query

    • getThreadCount

      public Integer getThreadCount()
      Deprecated.

    • getThreadCount

      public Integer getThreadCount(JvmSystemResources jvmRuntime)
      Deprecated.
      Description copied from interface: ReIndexSupport
      Get the number of threads to use for reindexing with specific JVM resources.
      Specified by:
      getThreadCount in interface ReIndexSupport<Object>
      Parameters:
      jvmRuntime - the JVM system resources
      Returns:
      the thread count

    • getClassFilter

      public Predicate<String> getClassFilter()
      Deprecated.
      Description copied from interface: ReIndexSupport
      Get the class filter predicate for this reindex option.
      Specified by:
      getClassFilter in interface ReIndexSupport<Object>
      Returns:
      predicate to filter classes

    • getHandles

      public List<HibernateHandle> getHandles(SearchableDao dao, Optional<String> spaceKey)
      Deprecated.
      Description copied from interface: ReIndexSupport
      Get handles for reindexing within a specific space.
      Specified by:
      getHandles in interface ReIndexSupport<Object>
      Parameters:
      dao - the searchable DAO
      spaceKey - the space key to limit to
      Returns:
      list of hibernate handles

    • getHandles

      public List<HibernateHandle> getHandles(SearchableDao dao)
      Deprecated.
      Description copied from interface: ReIndexSupport
      Get handles for reindexing.
      Specified by:
      getHandles in interface ReIndexSupport<Object>
      Parameters:
      dao - the searchable DAO
      Returns:
      list of hibernate handles

    • isFullReindex

      public static boolean isFullReindex(Set<ReIndexOption> options)
      Deprecated.

    • fullReindex

      public static EnumSet<ReIndexOption> fullReindex()
      Deprecated.
      This is only for site reindexing

    • fullReindex

      public static EnumSet<ReIndexOption> fullReindex(boolean reindexingSite)
      Deprecated.
      Parameters:
      reindexingSite - true if Confluence is re-indexing the whole site
      Returns:
      the relevant options
      Since:
      8.2.0

    • deserialise

      public static EnumSet<ReIndexOption> deserialise(Collection<String> options, boolean reindexingSite)
      Deprecated.
      Parameters:
      options - a collection of options is their serialised form
      Returns:
      an EnumSet of ReIndexOption
      Since:
      8.2.0