org.eclipse.m2e.core.internal.index.nexus

Class NexusIndexManager

java.lang.Object

org.eclipse.m2e.core.internal.index.nexus.NexusIndexManager

All Implemented Interfaces:

IndexManager, IRepositoryIndexer, IMavenProjectChangedListener

public class NexusIndexManager
extends Object
implements IndexManager, IMavenProjectChangedListener, IRepositoryIndexer

Author:

Eugene Kuleshov

Field Summary

Fields

Modifier and Type	Field and Description
static int	MIN_CLASS_QUERY_LENGTH

Fields inherited from interface org.eclipse.m2e.core.internal.index.IndexManager

LOCAL_INDEX, WORKSPACE_INDEX

Constructor Summary

Constructors

Constructor and Description
NexusIndexManager(org.codehaus.plexus.PlexusContainer container, IMavenProjectRegistry projectManager, IRepositoryRegistry repositoryRegistry, File stateDir)

Method Summary

Modifier and Type	Method and Description
protected void	addDocument(IRepository repository, File file, ArtifactKey key)
void	addIndexListener(IndexListener listener)
org.apache.lucene.search.Query	constructQuery(org.apache.maven.index.Field field, SearchExpression query) Method to construct Lucene Queries without need to actually know the structure and details (field names, analyze details, etc) of the underlying index.
protected org.apache.maven.index.context.IndexingContext	createIndexingContext(IRepository repository, String details)
protected void	fireIndexAdded(IRepository repository)
protected void	fireIndexChanged(IRepository repository)
protected void	fireIndexRemoved(IRepository repository)
protected void	fireIndexUpdating(IRepository repository)
IIndex	getAllIndexes() Returns index aggregating all indexes enabled for repositories defined in settings.xml
org.apache.maven.archetype.source.ArchetypeDataSource	getArchetypeCatalog()
org.apache.maven.index.ArtifactContextProducer	getArtifactContextProducer()
protected String	getArtifactFileKey(String group, String artifact, String packageName, String className)
static String	getDocumentKey(ArtifactKey artifact)
IIndex	getIndex(org.eclipse.core.resources.IProject project) For Maven projects, returns index of all repositories configured for the project.
NexusIndex	getIndex(IRepository repository)
String	getIndexDetails(IRepository repository) For tests only
protected org.apache.lucene.store.Directory	getIndexDirectory(IRepository repository)
protected File	getIndexDirectoryFile(IRepository repository)
IndexedArtifactFile	getIndexedArtifactFile(org.apache.maven.index.ArtifactInfo artifactInfo) for Unit test
IndexedArtifactFile	getIndexedArtifactFile(IRepository repository, ArtifactKey gav) for Unit test
org.apache.maven.index.NexusIndexer	getIndexer()
String	getIndexerId()
protected List<org.apache.maven.index.context.IndexCreator>	getIndexers(String details)
org.apache.maven.index.context.IndexingContext	getIndexingContext(IRepository repository) public for unit tests only!
org.apache.maven.index.updater.IndexUpdater	getIndexUpdate()
org.eclipse.core.runtime.jobs.Job	getIndexUpdateJob() for unit tests only
NexusIndex	getLocalIndex()
IndexedArtifactGroup[]	getRootIndexedArtifactGroups(IRepository repository) for unit tests
NexusIndex	getWorkspaceIndex()
IndexedArtifactFile	identify(File file)
protected org.apache.maven.index.ArtifactInfo	identify(File artifact, Collection<org.apache.maven.index.context.IndexingContext> contexts)
protected IndexedArtifactFile	identify(IRepository repository, File file)
void	initialize(org.eclipse.core.runtime.IProgressMonitor monitor) This method is called from a background thread which does not keep any workspace locks.
protected boolean	isUpdatingIndex(IRepository repository)
void	mavenProjectChanged(MavenProjectChangedEvent[] events, org.eclipse.core.runtime.IProgressMonitor monitor) This method is called while holding workspace lock.
protected org.apache.maven.index.updater.IndexUpdateRequest	newIndexUpdateRequest(IRepository repository, org.apache.maven.index.context.IndexingContext context, org.eclipse.core.runtime.IProgressMonitor monitor)
protected void	removeDocument(IRepository repository, File file, ArtifactKey key, IMavenProjectFacade facade)
void	removeIndexListener(IndexListener listener)
void	repositoryAdded(IRepository repository, org.eclipse.core.runtime.IProgressMonitor monitor) Called by repository registry when new repository is added.
void	repositoryRemoved(IRepository repository, org.eclipse.core.runtime.IProgressMonitor monitor) Called by repository registry when a repository is removed.
IndexedArtifactGroup	resolveGroup(IndexedArtifactGroup group)
protected void	scheduleIndexUpdate(IRepository repository, boolean force)
protected Map<String,IndexedArtifact>	search(IRepository repository, org.apache.lucene.search.Query query)
protected Map<String,IndexedArtifact>	search(IRepository repository, SearchExpression term, String type)
protected Map<String,IndexedArtifact>	search(IRepository repository, SearchExpression term, String type, int classifier)
Map<String,IndexedArtifact>	search(SearchExpression term, String type)
Map<String,IndexedArtifact>	search(SearchExpression term, String type, int classifier)
void	setIndexDetails(IRepository repository, String details, org.eclipse.core.runtime.IProgressMonitor monitor) Updates index synchronously if monitor!=null.
void	updateIndex(IRepository repository, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
protected void	writeIndexDetails()

Methods inherited from class java.lang.Object

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

Field Detail

MIN_CLASS_QUERY_LENGTH

public static final int MIN_CLASS_QUERY_LENGTH

See Also:

Constant Field Values

Constructor Detail

NexusIndexManager

public NexusIndexManager(org.codehaus.plexus.PlexusContainer container,
                         IMavenProjectRegistry projectManager,
                         IRepositoryRegistry repositoryRegistry,
                         File stateDir)

Method Detail

getIndexedArtifactFile

public IndexedArtifactFile getIndexedArtifactFile(IRepository repository,
                                                  ArtifactKey gav)
                                           throws org.eclipse.core.runtime.CoreException

for Unit test

Throws:

org.eclipse.core.runtime.CoreException

getIndexedArtifactFile

public IndexedArtifactFile getIndexedArtifactFile(org.apache.maven.index.ArtifactInfo artifactInfo)

for Unit test

identify

public IndexedArtifactFile identify(File file)
                             throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

identify

protected IndexedArtifactFile identify(IRepository repository,
                                       File file)
                                throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

constructQuery

public org.apache.lucene.search.Query constructQuery(org.apache.maven.index.Field field,
                                                     SearchExpression query)

Method to construct Lucene Queries without need to actually know the structure and details (field names, analyze details, etc) of the underlying index. Also, using this methods makes you "future proof". Naturally, at caller level you can still combine these queries using BooleanQuery to suit your needs.

Parameters:

field -

query -

type -

Returns:

search

public Map<String,IndexedArtifact> search(SearchExpression term,
                                          String type)
                                   throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

search

public Map<String,IndexedArtifact> search(SearchExpression term,
                                          String type,
                                          int classifier)
                                   throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

search

protected Map<String,IndexedArtifact> search(IRepository repository,
                                             SearchExpression term,
                                             String type,
                                             int classifier)
                                      throws org.eclipse.core.runtime.CoreException

Returns:

Map

Throws:

org.eclipse.core.runtime.CoreException

search

protected Map<String,IndexedArtifact> search(IRepository repository,
                                             SearchExpression term,
                                             String type)
                                      throws org.eclipse.core.runtime.CoreException

Returns:

Map

Throws:

org.eclipse.core.runtime.CoreException

search

protected Map<String,IndexedArtifact> search(IRepository repository,
                                             org.apache.lucene.search.Query query)
                                      throws org.eclipse.core.runtime.CoreException

Returns:

Map

Throws:

org.eclipse.core.runtime.CoreException

getArtifactFileKey

protected String getArtifactFileKey(String group,
                                    String artifact,
                                    String packageName,
                                    String className)

addDocument

protected void addDocument(IRepository repository,
                           File file,
                           ArtifactKey key)

removeDocument

protected void removeDocument(IRepository repository,
                              File file,
                              ArtifactKey key,
                              IMavenProjectFacade facade)

scheduleIndexUpdate

protected void scheduleIndexUpdate(IRepository repository,
                                   boolean force)

getRootIndexedArtifactGroups

public IndexedArtifactGroup[] getRootIndexedArtifactGroups(IRepository repository)
                                                    throws org.eclipse.core.runtime.CoreException

for unit tests

Throws:

org.eclipse.core.runtime.CoreException

getIndexingContext

public org.apache.maven.index.context.IndexingContext getIndexingContext(IRepository repository)

public for unit tests only!

getIndexer

public org.apache.maven.index.NexusIndexer getIndexer()

getArtifactContextProducer

public org.apache.maven.index.ArtifactContextProducer getArtifactContextProducer()

getDocumentKey

public static String getDocumentKey(ArtifactKey artifact)

mavenProjectChanged

public void mavenProjectChanged(MavenProjectChangedEvent[] events,
                                org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IMavenProjectChangedListener

This method is called while holding workspace lock.

Specified by:

mavenProjectChanged in interface IMavenProjectChangedListener

getWorkspaceIndex

public NexusIndex getWorkspaceIndex()

Specified by:

getWorkspaceIndex in interface IndexManager

getLocalIndex

public NexusIndex getLocalIndex()

Specified by:

getLocalIndex in interface IndexManager

getIndex

public IIndex getIndex(org.eclipse.core.resources.IProject project)

Description copied from interface: IndexManager

For Maven projects, returns index of all repositories configured for the project. Index includes repositories defined in the project pom.xml, inherited from parent projects and defined in enabled profiles in settings.xml. If project is null or is not a maven project, returns index that includes repositories defined in profiles enabled by default in settings.xml.

Specified by:

getIndex in interface IndexManager

getAllIndexes

public IIndex getAllIndexes()

Description copied from interface: IndexManager

Returns index aggregating all indexes enabled for repositories defined in settings.xml

Specified by:

getAllIndexes in interface IndexManager

Returns:

getIndex

public NexusIndex getIndex(IRepository repository)

getIndexDirectoryFile

protected File getIndexDirectoryFile(IRepository repository)

getIndexDirectory

protected org.apache.lucene.store.Directory getIndexDirectory(IRepository repository)
                                                       throws IOException

Throws:

IOException

resolveGroup

public IndexedArtifactGroup resolveGroup(IndexedArtifactGroup group)

repositoryAdded

public void repositoryAdded(IRepository repository,
                            org.eclipse.core.runtime.IProgressMonitor monitor)
                     throws org.eclipse.core.runtime.CoreException

Description copied from interface: IRepositoryIndexer

Called by repository registry when new repository is added. This method is called from a background thread which does not keep any workspace locks.

Specified by:

repositoryAdded in interface IRepositoryIndexer

Throws:

org.eclipse.core.runtime.CoreException

getIndexDetails

public String getIndexDetails(IRepository repository)

For tests only

setIndexDetails

public void setIndexDetails(IRepository repository,
                            String details,
                            org.eclipse.core.runtime.IProgressMonitor monitor)
                     throws org.eclipse.core.runtime.CoreException

Updates index synchronously if monitor!=null. Schedules index update otherwise. ... and yes, I know this ain't kosher. Public for unit tests only!

Throws:

org.eclipse.core.runtime.CoreException

createIndexingContext

protected org.apache.maven.index.context.IndexingContext createIndexingContext(IRepository repository,
                                                                               String details)
                                                                        throws IOException

Throws:

IOException

getIndexers

protected List<org.apache.maven.index.context.IndexCreator> getIndexers(String details)

repositoryRemoved

public void repositoryRemoved(IRepository repository,
                              org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IRepositoryIndexer

Called by repository registry when a repository is removed. This method is called from a background thread which does not keep any workspace locks.

Specified by:

repositoryRemoved in interface IRepositoryIndexer

fireIndexAdded

protected void fireIndexAdded(IRepository repository)

fireIndexRemoved

protected void fireIndexRemoved(IRepository repository)

isUpdatingIndex

protected boolean isUpdatingIndex(IRepository repository)

fireIndexUpdating

protected void fireIndexUpdating(IRepository repository)

fireIndexChanged

protected void fireIndexChanged(IRepository repository)

removeIndexListener

public void removeIndexListener(IndexListener listener)

Specified by:

removeIndexListener in interface IndexManager

addIndexListener

public void addIndexListener(IndexListener listener)

Specified by:

addIndexListener in interface IndexManager

updateIndex

public void updateIndex(IRepository repository,
                        boolean force,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

newIndexUpdateRequest

protected org.apache.maven.index.updater.IndexUpdateRequest newIndexUpdateRequest(IRepository repository,
                                                                                  org.apache.maven.index.context.IndexingContext context,
                                                                                  org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                           throws IOException,
                                                                                  org.eclipse.core.runtime.CoreException

Throws:

IOException

org.eclipse.core.runtime.CoreException

initialize

public void initialize(org.eclipse.core.runtime.IProgressMonitor monitor)
                throws org.eclipse.core.runtime.CoreException

Description copied from interface: IRepositoryIndexer

This method is called from a background thread which does not keep any workspace locks.

Specified by:

initialize in interface IRepositoryIndexer

Throws:

org.eclipse.core.runtime.CoreException

writeIndexDetails

protected void writeIndexDetails()
                          throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

getIndexUpdateJob

public org.eclipse.core.runtime.jobs.Job getIndexUpdateJob()

for unit tests only

getIndexerId

public String getIndexerId()

Specified by:

getIndexerId in interface IRepositoryIndexer

identify

protected org.apache.maven.index.ArtifactInfo identify(File artifact,
                                                       Collection<org.apache.maven.index.context.IndexingContext> contexts)
                                                throws IOException

Throws:

IOException

getIndexUpdate

public org.apache.maven.index.updater.IndexUpdater getIndexUpdate()

Since:

1.5

getArchetypeCatalog

public org.apache.maven.archetype.source.ArchetypeDataSource getArchetypeCatalog()

Since:

1.5