com.atlassian.confluence.search.lucene.tasks

Class IndexTaskFactory

java.lang.Object

com.atlassian.confluence.search.lucene.tasks.IndexTaskFactory

public class IndexTaskFactory
extends Object

Creates index tasks and provides conversion into queue entries for implementations of IndexTaskQueue

Constructor Summary

Constructors

Constructor and Description
IndexTaskFactory() Deprecated. since 5.9. Use constructor injection instead.
IndexTaskFactory(BatchOperationManager batchOperationManager, com.atlassian.bonnie.search.DocumentBuilder documentBuilder, com.atlassian.bonnie.search.DocumentBuilder changeDocumentBuilder, ContentEntityObjectDao contentEntityObjectDao, com.google.common.base.Supplier<AttachmentManager> attachmentManager, com.google.common.base.Supplier<PersonalInformationManager> personalInformationManager, com.google.common.base.Supplier<UserAccessor> userAccessor, PersonalInformationDao personalInformationDao) Deprecated. since 5.10
IndexTaskFactory(BatchOperationManager batchOperationManager, com.atlassian.bonnie.search.DocumentBuilder documentBuilder, com.atlassian.bonnie.search.DocumentBuilder changeDocumentBuilder, ContentEntityObjectDao contentEntityObjectDao, com.google.common.base.Supplier<AttachmentManager> attachmentManager, com.google.common.base.Supplier<PersonalInformationManager> personalInformationManager, com.google.common.base.Supplier<UserAccessor> userAccessor, PersonalInformationDao personalInformationDao, SpaceDao spaceDao, PageDao pageDao)
IndexTaskFactory(BatchOperationManager batchOperationManager, net.sf.hibernate.SessionFactory sessionFactory, com.atlassian.bonnie.search.DocumentBuilder documentBuilder, com.atlassian.bonnie.search.DocumentBuilder changeDocumentBuilder, ContentEntityObjectDao contentEntityObjectDao, com.google.common.base.Supplier<AttachmentManager> attachmentManager, com.google.common.base.Supplier<PersonalInformationManager> personalInformationManager, com.google.common.base.Supplier<UserAccessor> userAccessor) Deprecated. since 5.9. Use the non-deprecated constructor.

Method Summary

Modifier and Type	Method and Description
ConfluenceIndexTask	createAddChangeDocumentTask(com.atlassian.bonnie.Searchable searchable) Constructs an add change document task.
ConfluenceIndexTask	createAddDocumentTask(com.atlassian.bonnie.Searchable searchable) NOTE: Do not call this method without first calling createDeleteDocumentTask(com.atlassian.bonnie.Searchable) for the same object.
ContentIndexTask	createContentIndexTask(List<ContentType> contentTypes, List<ContentStatus> contentStatuses, JournalEntryType journalEntryType)
ConfluenceIndexTask	createDeleteChangeDocumentsIndexTask(com.atlassian.bonnie.Searchable searchable)
ConfluenceIndexTask	createDeleteChangeDocumentsIndexTask(String handle)
ConfluenceIndexTask	createDeleteDocumentTask(com.atlassian.bonnie.Searchable searchable)
ConfluenceIndexTask	createDeleteDocumentTask(String handle)
ContentIndexTask	createIndexDraftsTask()
ConfluenceIndexTask	createRebuildChangeDocumentsIndexTask(com.atlassian.bonnie.Searchable searchable)
ReindexAllBlogsIndexTask	createReindexAllBlogsTask()
ReindexAllSpacesIndexTask	createReindexAllSpacesTask()
ReindexAllUsersIndexTask	createReindexAllUsersTask()
ReindexUsersInGroupIndexTask	createReindexUsersInGroupTask(String groupName)
UnindexContentTypeIndexTask	createUnindexContentTypeTask(String contentType)
UnIndexSpaceIndexTask	createUnIndexSpaceTask(Space space)
UnIndexSpaceIndexTask	createUnIndexSpaceTask(String handle)
ConfluenceIndexTask	createUpdateDocumentTask(com.atlassian.bonnie.Searchable searchable) Returns an update document task.
AttachmentManager	getAttachmentManager()
PersonalInformationDao	getPersonalInformationDao()
PersonalInformationManager	getPersonalInformationManager()
UserAccessor	getUserAccessor()
void	setAnyTypeDao(AnyTypeDao anyTypeDao) Deprecated. since 5.2. No longer required
void	setChangeDocumentBuilder(com.atlassian.bonnie.search.DocumentBuilder changeDocumentBuilder) Deprecated. since 5.8. Use constructor injection instead.
void	setContentEntityObjectDao(ContentEntityObjectDao contentEntityObjectDao) Deprecated. since 5.8. Use constructor injection instead.
void	setDocumentBuilder(com.atlassian.bonnie.search.DocumentBuilder documentBuilder) Deprecated. since 5.8. Use constructor injection instead.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexTaskFactory

public IndexTaskFactory(BatchOperationManager batchOperationManager,
                        com.atlassian.bonnie.search.DocumentBuilder documentBuilder,
                        com.atlassian.bonnie.search.DocumentBuilder changeDocumentBuilder,
                        ContentEntityObjectDao contentEntityObjectDao,
                        com.google.common.base.Supplier<AttachmentManager> attachmentManager,
                        com.google.common.base.Supplier<PersonalInformationManager> personalInformationManager,
                        com.google.common.base.Supplier<UserAccessor> userAccessor,
                        PersonalInformationDao personalInformationDao,
                        SpaceDao spaceDao,
                        PageDao pageDao)

Since:

5.10

IndexTaskFactory

public IndexTaskFactory(BatchOperationManager batchOperationManager,
                        com.atlassian.bonnie.search.DocumentBuilder documentBuilder,
                        com.atlassian.bonnie.search.DocumentBuilder changeDocumentBuilder,
                        ContentEntityObjectDao contentEntityObjectDao,
                        com.google.common.base.Supplier<AttachmentManager> attachmentManager,
                        com.google.common.base.Supplier<PersonalInformationManager> personalInformationManager,
                        com.google.common.base.Supplier<UserAccessor> userAccessor,
                        PersonalInformationDao personalInformationDao)

Deprecated. since 5.10

Since:

5.9

IndexTaskFactory

@Deprecated
public IndexTaskFactory()

Deprecated. since 5.9. Use constructor injection instead.

IndexTaskFactory

public IndexTaskFactory(BatchOperationManager batchOperationManager,
                        net.sf.hibernate.SessionFactory sessionFactory,
                        com.atlassian.bonnie.search.DocumentBuilder documentBuilder,
                        com.atlassian.bonnie.search.DocumentBuilder changeDocumentBuilder,
                        ContentEntityObjectDao contentEntityObjectDao,
                        com.google.common.base.Supplier<AttachmentManager> attachmentManager,
                        com.google.common.base.Supplier<PersonalInformationManager> personalInformationManager,
                        com.google.common.base.Supplier<UserAccessor> userAccessor)

Deprecated. since 5.9. Use the non-deprecated constructor.

Method Detail

setDocumentBuilder

@Deprecated
public void setDocumentBuilder(com.atlassian.bonnie.search.DocumentBuilder documentBuilder)

Deprecated. since 5.8. Use constructor injection instead.

createContentIndexTask

public ContentIndexTask createContentIndexTask(List<ContentType> contentTypes,
                                               List<ContentStatus> contentStatuses,
                                               JournalEntryType journalEntryType)

createIndexDraftsTask

public ContentIndexTask createIndexDraftsTask()

createUnIndexSpaceTask

public UnIndexSpaceIndexTask createUnIndexSpaceTask(String handle)

Parameters:

handle - space key

createUnindexContentTypeTask

public UnindexContentTypeIndexTask createUnindexContentTypeTask(String contentType)

createUnIndexSpaceTask

public UnIndexSpaceIndexTask createUnIndexSpaceTask(Space space)

createReindexAllUsersTask

public ReindexAllUsersIndexTask createReindexAllUsersTask()

createReindexAllBlogsTask

public ReindexAllBlogsIndexTask createReindexAllBlogsTask()

createReindexUsersInGroupTask

public ReindexUsersInGroupIndexTask createReindexUsersInGroupTask(String groupName)

createDeleteDocumentTask

public ConfluenceIndexTask createDeleteDocumentTask(com.atlassian.bonnie.Searchable searchable)

createDeleteDocumentTask

public ConfluenceIndexTask createDeleteDocumentTask(String handle)

createUpdateDocumentTask

public ConfluenceIndexTask createUpdateDocumentTask(com.atlassian.bonnie.Searchable searchable)

Returns an update document task.

Parameters:

searchable - the searchable

Returns:

an update document task or null if searchable is null or not indexable

createAddDocumentTask

public ConfluenceIndexTask createAddDocumentTask(com.atlassian.bonnie.Searchable searchable)

NOTE: Do not call this method without first calling createDeleteDocumentTask(com.atlassian.bonnie.Searchable) for the same object. The index flushing strategy is intentionally inaccurate and relies on an in-memory 'flushed entries' cache to prevent the same object being flushed twice, which risks duplicate entries being created in the index immediately after the application is restarted. CONF-29072 has additional details.

You probably want to use createUpdateDocumentTask(com.atlassian.bonnie.Searchable) instead - the delete operation will fail silently :)

Parameters:

searchable - the searchable

Returns:

an add document task or null if searchable is null or not indexable

createDeleteChangeDocumentsIndexTask

public ConfluenceIndexTask createDeleteChangeDocumentsIndexTask(com.atlassian.bonnie.Searchable searchable)

Parameters:

searchable -

Returns:

an index task to remove the change documents for this searchable, or a no op task otherwise.

createDeleteChangeDocumentsIndexTask

public ConfluenceIndexTask createDeleteChangeDocumentsIndexTask(String handle)

Parameters:

handle - handle to the latest version

Returns:

delete index task

createRebuildChangeDocumentsIndexTask

public ConfluenceIndexTask createRebuildChangeDocumentsIndexTask(com.atlassian.bonnie.Searchable searchable)

createAddChangeDocumentTask

public ConfluenceIndexTask createAddChangeDocumentTask(com.atlassian.bonnie.Searchable searchable)

Constructs an add change document task.

Parameters:

searchable - the searchable

Returns:

an add change document task or NoOpIndexTask if searchable is null

createReindexAllSpacesTask

public ReindexAllSpacesIndexTask createReindexAllSpacesTask()

setChangeDocumentBuilder

@Deprecated
public void setChangeDocumentBuilder(com.atlassian.bonnie.search.DocumentBuilder changeDocumentBuilder)

Deprecated. since 5.8. Use constructor injection instead.

setContentEntityObjectDao

@Deprecated
public void setContentEntityObjectDao(ContentEntityObjectDao contentEntityObjectDao)

Deprecated. since 5.8. Use constructor injection instead.

getAttachmentManager

public AttachmentManager getAttachmentManager()

getPersonalInformationManager

public PersonalInformationManager getPersonalInformationManager()

getUserAccessor

public UserAccessor getUserAccessor()

setAnyTypeDao

@Deprecated
public void setAnyTypeDao(AnyTypeDao anyTypeDao)

Deprecated. since 5.2. No longer required

Parameters:

anyTypeDao -

getPersonalInformationDao

public PersonalInformationDao getPersonalInformationDao()