Package org.ametys.cms.indexing.solr

Class SolrWorkspaceIndexer

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.indexing.solr.SolrWorkspaceIndexer

All Implemented Interfaces:

WorkspaceIndexer, LogEnabled, Component, Contextualizable, Serviceable

Direct Known Subclasses:

SolrWebWorkspaceIndexer

public class SolrWorkspaceIndexer
extends AbstractLogEnabled
implements WorkspaceIndexer, Component, Serviceable, Contextualizable

Component indexing a workspace in a Solr server.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The component context.
protected DocumentProviderExtensionPoint	_docProviderEP	Additional documents provider extension point.
protected javax.jcr.Repository	_repository	The repository.
protected SolrClientProvider	_solrClientProvider	The Solr client provider
protected SolrIndexer	_solrIndexer	The solr indexer.
protected WorkspaceSelector	_workspaceSelector	The workspace selector.

Fields inherited from interface org.ametys.cms.indexing.WorkspaceIndexer

ROLE

Constructor Summary

Constructors

Constructor	Description
SolrWorkspaceIndexer()

Method Summary

Modifier and Type	Method	Description
protected void	_createAdditionalDocumentsProgressionTrackerSteps(ContainerProgressionTracker progressionTracker)	Create the progression tracker steps for additional documents
void	contextualize(Context context)
protected void	doIndex(String workspaceName)	Index the given workspace.
protected void	doIndex(String workspaceName, ContainerProgressionTracker progressionTracker)	Index the given workspace.
protected void	ensureCoreExists(String coreName)	Create the given core if it doesn't exist.
protected void	ensureCoresExists(String[] coreNames)	Create the given cores if they do not exist.
String[]	getWorkspacesNames()	Get the workspaces labels
void	index(String workspaceName)	Index a workspace.
void	index(String workspaceName, ContainerProgressionTracker progressionTracker)	Index a workspace.
protected void	indexAdditionalDocuments(String workspaceName, org.apache.solr.client.solrj.SolrClient solrClient)	Index additional documents provided by the extensions.
protected void	indexAdditionalDocuments(String workspaceName, org.apache.solr.client.solrj.SolrClient solrClient, ContainerProgressionTracker progressionTracker)	Index additional documents provided by the extensions.
void	indexAllWorkspaces()	Index all the workspaces.
void	indexAllWorkspaces(ContainerProgressionTracker progressionTracker)	Index all the workspaces.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

_repository

protected javax.jcr.Repository _repository

The repository.

_solrIndexer

protected SolrIndexer _solrIndexer

The solr indexer.

_workspaceSelector

protected WorkspaceSelector _workspaceSelector

The workspace selector.

_docProviderEP

protected DocumentProviderExtensionPoint _docProviderEP

Additional documents provider extension point.

_solrClientProvider

protected SolrClientProvider _solrClientProvider

The Solr client provider

_context

protected Context _context

The component context.

Constructor Details

SolrWorkspaceIndexer

public SolrWorkspaceIndexer()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getWorkspacesNames

public String[] getWorkspacesNames()
                            throws javax.jcr.RepositoryException

Description copied from interface: WorkspaceIndexer

Get the workspaces labels

Specified by:

getWorkspacesNames in interface WorkspaceIndexer

Returns:

The list of labels

Throws:

javax.jcr.RepositoryException - If an error occurs

indexAllWorkspaces

public void indexAllWorkspaces()
                        throws IndexingException

Description copied from interface: WorkspaceIndexer

Index all the workspaces.

Specified by:

indexAllWorkspaces in interface WorkspaceIndexer

Throws:

IndexingException - If an error occurs while indexing.

indexAllWorkspaces

public void indexAllWorkspaces(ContainerProgressionTracker progressionTracker)
                        throws IndexingException

Description copied from interface: WorkspaceIndexer

Index all the workspaces.

Specified by:

indexAllWorkspaces in interface WorkspaceIndexer

Parameters:

progressionTracker - The progression of the indexation

Throws:

IndexingException - If an error occurs while indexing.

index

public void index(String workspaceName)
           throws IndexingException

Description copied from interface: WorkspaceIndexer

Index a workspace.

Specified by:

index in interface WorkspaceIndexer

Parameters:

workspaceName - The workspace name.

Throws:

IndexingException - If an error occurs while indexing the workspace.

index

public void index(String workspaceName,
 ContainerProgressionTracker progressionTracker)
           throws IndexingException

Description copied from interface: WorkspaceIndexer

Index a workspace.

Specified by:

index in interface WorkspaceIndexer

Parameters:

workspaceName - The workspace name.

progressionTracker - The progression tracker

Throws:

IndexingException - If an error occurs while indexing the workspace.

doIndex

protected void doIndex(String workspaceName)
                throws IndexingException

Index the given workspace.

Parameters:

workspaceName - The workspace name.

Throws:

IndexingException - If an error occurs indexing the workspace.

doIndex

protected void doIndex(String workspaceName,
 ContainerProgressionTracker progressionTracker)
                throws IndexingException

Index the given workspace.

Parameters:

workspaceName - The workspace name.

progressionTracker - The progression of the indexation

Throws:

IndexingException - If an error occurs indexing the workspace.

indexAdditionalDocuments

protected void indexAdditionalDocuments(String workspaceName,
 org.apache.solr.client.solrj.SolrClient solrClient)
                                 throws IndexingException

Index additional documents provided by the extensions.

Parameters:

workspaceName - The workspace name.

solrClient - The solr client to use

Throws:

IndexingException - If an error occurs while indexing.

_createAdditionalDocumentsProgressionTrackerSteps

protected void _createAdditionalDocumentsProgressionTrackerSteps(ContainerProgressionTracker progressionTracker)

Create the progression tracker steps for additional documents

Parameters:

progressionTracker - The progression tracker

indexAdditionalDocuments

protected void indexAdditionalDocuments(String workspaceName,
 org.apache.solr.client.solrj.SolrClient solrClient,
 ContainerProgressionTracker progressionTracker)
                                 throws IndexingException

Index additional documents provided by the extensions.

Parameters:

workspaceName - The workspace name.

solrClient - The solr client to use

progressionTracker - The progression of the indexation

Throws:

IndexingException - If an error occurs while indexing.

ensureCoresExists

protected void ensureCoresExists(String[] coreNames)
                          throws IndexingException

Create the given cores if they do not exist.

Parameters:

coreNames - The core names.

Throws:

IndexingException - If an error occurs while checking if cores exist.

ensureCoreExists

protected void ensureCoreExists(String coreName)
                         throws IndexingException

Create the given core if it doesn't exist.

Parameters:

coreName - The core name.

Throws:

IndexingException - If an error occurs while checking if core exists.