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 java.lang.Object
implements IndexManager, IMavenProjectChangedListener, IRepositoryIndexer

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.maven.index.ArtifactContextProducer	artifactContextProducer Lazy instantiated nexus indexer's contextProducer.
private java.io.File	baseIndexDir
private org.codehaus.plexus.PlexusContainer	container
private java.lang.Object	contextProducerLock Lock guarding lazy instantiation of contextProducer instance
private static char[]	DIGITS
private java.util.List<org.apache.maven.index.context.IndexCreator>	fullCreators
private java.util.Properties	indexDetails
private org.apache.maven.index.NexusIndexer	indexer Lazy instantiated nexus indexer instance.
private java.lang.Object	indexerLock Lock guarding lazy instantiation of indexerLock instance
private java.util.List<IndexListener>	indexListeners
private java.util.Map<java.lang.String,java.lang.Object>	indexLocks Maps repository UID to the lock object associated with the repository.
private org.apache.maven.index.updater.IndexUpdater	indexUpdater
private NexusIndex	localIndex
private static EquinoxLocker	locker
private static org.slf4j.Logger	log
private IMaven	maven
static int	MIN_CLASS_QUERY_LENGTH
private java.util.List<org.apache.maven.index.context.IndexCreator>	minCreators
private IMavenProjectRegistry	projectManager
private IRepositoryRegistry	repositoryRegistry
private IndexUpdaterJob	updaterJob
private java.util.Set<java.lang.String>	updatingIndexes
private NexusIndex	workspaceIndex

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, java.io.File stateDir)

Method Summary

Modifier and Type	Method and Description
private void	addArtifactFile(java.util.Map<java.lang.String,IndexedArtifact> result, IndexedArtifactFile af, java.lang.String className, java.lang.String packageName, java.lang.String packaging)
private void	addClassifiersToQuery(org.apache.lucene.search.BooleanQuery.Builder bq, int classifier)
protected void	addDocument(IRepository repository, java.io.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.
private org.apache.lucene.search.Query	constructQuery(org.apache.maven.index.Field field, java.lang.String query, org.apache.maven.index.SearchType searchType)
protected org.apache.maven.index.context.IndexingContext	createIndexingContext(IRepository repository, java.lang.String details)
private static java.lang.String	encode(byte[] digest)
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()
private org.apache.maven.index.ArtifactContext	getArtifactContext(java.io.File file, org.apache.maven.index.context.IndexingContext context)
org.apache.maven.index.ArtifactContextProducer	getArtifactContextProducer()
protected java.lang.String	getArtifactFileKey(java.lang.String group, java.lang.String artifact, java.lang.String packageName, java.lang.String className)
static java.lang.String	getDocumentKey(ArtifactKey artifact)
private java.util.List<org.apache.maven.index.context.IndexCreator>	getFullCreator()
IIndex	getIndex(org.eclipse.core.resources.IProject project) For Maven projects, returns index of all repositories configured for the project.
NexusIndex	getIndex(IRepository repository)
java.lang.String	getIndexDetails(IRepository repository) For tests only
private java.io.File	getIndexDetailsFile()
protected org.apache.lucene.store.Directory	getIndexDirectory(IRepository repository)
protected java.io.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()
java.lang.String	getIndexerId()
protected java.util.List<org.apache.maven.index.context.IndexCreator>	getIndexers(java.lang.String details)
org.apache.maven.index.context.IndexingContext	getIndexingContext(IRepository repository) public for unit tests only!
private java.lang.Object	getIndexLock(IRepository repository)
org.apache.maven.index.updater.IndexUpdater	getIndexUpdate()
org.eclipse.core.runtime.jobs.Job	getIndexUpdateJob() for unit tests only
NexusIndex	getLocalIndex()
private java.util.List<org.apache.maven.index.context.IndexCreator>	getMinCreator()
private IMavenProjectFacade	getProjectByArtifactKey(ArtifactKey artifactKey)
IndexedArtifactGroup[]	getRootIndexedArtifactGroups(IRepository repository) for unit tests
private org.apache.maven.index.ArtifactContext	getWorkspaceArtifactContext(IMavenProjectFacade facade, org.apache.maven.index.context.IndexingContext context)
NexusIndex	getWorkspaceIndex()
IndexedArtifactFile	identify(java.io.File file)
protected org.apache.maven.index.ArtifactInfo	identify(java.io.File artifact, java.util.Collection<org.apache.maven.index.context.IndexingContext> contexts)
protected IndexedArtifactFile	identify(IRepository repository, java.io.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)
private NexusIndex	newLocalIndex(IRepository localRepository)
private void	purgeCurrentIndex(org.apache.maven.index.context.IndexingContext context)
private void	reindexLocalRepository(IRepository repository, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
private void	reindexWorkspace(boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
protected void	removeDocument(IRepository repository, java.io.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 java.util.Map<java.lang.String,IndexedArtifact>	search(IRepository repository, org.apache.lucene.search.Query query)
protected java.util.Map<java.lang.String,IndexedArtifact>	search(IRepository repository, SearchExpression term, java.lang.String type)
protected java.util.Map<java.lang.String,IndexedArtifact>	search(IRepository repository, SearchExpression term, java.lang.String type, int classifier)
java.util.Map<java.lang.String,IndexedArtifact>	search(SearchExpression term, java.lang.String type)
java.util.Map<java.lang.String,IndexedArtifact>	search(SearchExpression term, java.lang.String type, int classifier)
void	setIndexDetails(IRepository repository, java.lang.String details, org.eclipse.core.runtime.IProgressMonitor monitor) Updates index synchronously if monitor!=null.
private void	setIndexDetails(IRepository repository, java.lang.String details, java.lang.String defaultDetails, org.eclipse.core.runtime.IProgressMonitor monitor)
void	updateIndex(IRepository repository, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
private void	updateRemoteIndex(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

log

private static final org.slf4j.Logger log

MIN_CLASS_QUERY_LENGTH

public static final int MIN_CLASS_QUERY_LENGTH

See Also:

Constant Field Values

indexer

private org.apache.maven.index.NexusIndexer indexer

Lazy instantiated nexus indexer instance.

artifactContextProducer

private org.apache.maven.index.ArtifactContextProducer artifactContextProducer

Lazy instantiated nexus indexer's contextProducer.

indexerLock

private final java.lang.Object indexerLock

Lock guarding lazy instantiation of indexerLock instance

contextProducerLock

private final java.lang.Object contextProducerLock

Lock guarding lazy instantiation of contextProducer instance

maven

private final IMaven maven

projectManager

private final IMavenProjectRegistry projectManager

repositoryRegistry

private final IRepositoryRegistry repositoryRegistry

fullCreators

private final java.util.List<org.apache.maven.index.context.IndexCreator> fullCreators

minCreators

private final java.util.List<org.apache.maven.index.context.IndexCreator> minCreators

baseIndexDir

private final java.io.File baseIndexDir

indexListeners

private final java.util.List<IndexListener> indexListeners

localIndex

private NexusIndex localIndex

workspaceIndex

private final NexusIndex workspaceIndex

updaterJob

private final IndexUpdaterJob updaterJob

indexDetails

private java.util.Properties indexDetails

updatingIndexes

private java.util.Set<java.lang.String> updatingIndexes

indexUpdater

private final org.apache.maven.index.updater.IndexUpdater indexUpdater

locker

private static final EquinoxLocker locker

indexLocks

private final java.util.Map<java.lang.String,java.lang.Object> indexLocks

Maps repository UID to the lock object associated with the repository. Entries are only added but never directly removed from the map, although jvm garbage collector may remove otherwise unused entries to reclaim the little memory they use. Never access this map directly. #getIndexLock must be used to get repository lock object.

container

private final org.codehaus.plexus.PlexusContainer container

DIGITS

private static final char[] DIGITS

Constructor Detail

NexusIndexManager

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

Method Detail

newLocalIndex

private NexusIndex newLocalIndex(IRepository localRepository)

getFullCreator

private java.util.List<org.apache.maven.index.context.IndexCreator> getFullCreator()
                                                                            throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

getMinCreator

private java.util.List<org.apache.maven.index.context.IndexCreator> getMinCreator()
                                                                           throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

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(java.io.File file)
                             throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

identify

protected IndexedArtifactFile identify(IRepository repository,
                                       java.io.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:

constructQuery

private org.apache.lucene.search.Query constructQuery(org.apache.maven.index.Field field,
                                                      java.lang.String query,
                                                      org.apache.maven.index.SearchType searchType)

search

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

Throws:

org.eclipse.core.runtime.CoreException

search

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

Throws:

org.eclipse.core.runtime.CoreException

addClassifiersToQuery

private void addClassifiersToQuery(org.apache.lucene.search.BooleanQuery.Builder bq,
                                   int classifier)

search

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

Returns:

Map

Throws:

org.eclipse.core.runtime.CoreException

search

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

Returns:

Map

Throws:

org.eclipse.core.runtime.CoreException

search

protected java.util.Map<java.lang.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

addArtifactFile

private void addArtifactFile(java.util.Map<java.lang.String,IndexedArtifact> result,
                             IndexedArtifactFile af,
                             java.lang.String className,
                             java.lang.String packageName,
                             java.lang.String packaging)

getArtifactFileKey

protected java.lang.String getArtifactFileKey(java.lang.String group,
                                              java.lang.String artifact,
                                              java.lang.String packageName,
                                              java.lang.String className)

purgeCurrentIndex

private void purgeCurrentIndex(org.apache.maven.index.context.IndexingContext context)
                        throws java.io.IOException

Throws:

java.io.IOException

reindexLocalRepository

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

Throws:

org.eclipse.core.runtime.CoreException

reindexWorkspace

private void reindexWorkspace(boolean force,
                              org.eclipse.core.runtime.IProgressMonitor monitor)
                       throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

addDocument

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

getProjectByArtifactKey

private IMavenProjectFacade getProjectByArtifactKey(ArtifactKey artifactKey)
                                             throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

removeDocument

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

getArtifactContext

private org.apache.maven.index.ArtifactContext getArtifactContext(java.io.File file,
                                                                  org.apache.maven.index.context.IndexingContext context)

getWorkspaceArtifactContext

private org.apache.maven.index.ArtifactContext getWorkspaceArtifactContext(IMavenProjectFacade facade,
                                                                           org.apache.maven.index.context.IndexingContext context)

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 java.lang.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 java.io.File getIndexDirectoryFile(IRepository repository)

getIndexDirectory

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

Throws:

java.io.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 java.lang.String getIndexDetails(IRepository repository)

For tests only

setIndexDetails

public void setIndexDetails(IRepository repository,
                            java.lang.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

setIndexDetails

private void setIndexDetails(IRepository repository,
                             java.lang.String details,
                             java.lang.String defaultDetails,
                             org.eclipse.core.runtime.IProgressMonitor monitor)
                      throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

createIndexingContext

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

Throws:

java.io.IOException

getIndexers

protected java.util.List<org.apache.maven.index.context.IndexCreator> getIndexers(java.lang.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

updateRemoteIndex

private void updateRemoteIndex(IRepository repository,
                               boolean force,
                               org.eclipse.core.runtime.IProgressMonitor monitor)

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 java.io.IOException,
                                                                                  org.eclipse.core.runtime.CoreException

Throws:

java.io.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

getIndexDetailsFile

private java.io.File getIndexDetailsFile()

getIndexUpdateJob

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

for unit tests only

getIndexerId

public java.lang.String getIndexerId()

Specified by:

getIndexerId in interface IRepositoryIndexer

getIndexLock

private java.lang.Object getIndexLock(IRepository repository)

identify

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

Throws:

java.io.IOException

encode

private static java.lang.String encode(byte[] digest)

getIndexUpdate

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

Since:

1.5

getArchetypeCatalog

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

Since:

1.5