Nexus Indexer

Maven Integration for Eclipse is extensively using local index for Maven repositories. There are several repository types supported:

remote Maven repositories, such as Central repository at http://repo1.maven.org/maven2/
local Maven repository
Maven projects available in the Eclipse workspace

All those indexes are managed by Nexus indexer component, which is also used by Maven integration for NetBeans, Sonatype repository manager and Nexus indexer command line tool (CLI).

Nexus indexer component provides an API to index Maven repository, merge and download index updates. It also provides an API to search through registered indexes using various search criteria, including:

Browse trough repository indexes
Search jars by artifactId and groupId
Search jars by the packaging type (e.g. to find Maven plugins or Archetypes)
Search jars by sha1 (e.g. to identify arbitrary jars with actual Maven artifacts)
Search Maven artifacts/jar by class name (e.g. resolve classpath issues from build errors or class not found exceptions)

Nexus indexer CLI

Nexus indexer CLI can be used to index arbitrary Maven 2 repository and it is packaged as an executable nexus-indexer-XXX-cli.jar. It can be also downloaded from the Nexus project web site.

To get list of available options you can run it without parameters:

>java -jar nexus-indexer-1.0.0-SNAPSHOT-cli.jar
Options:
 -i,--index         Path to the index folder.
 -n,--name          Repository name.
 -o,--overwrite     Overwrite existing index.
 -r,--repository    Path to the Maven repository.
 -t,--type          Index type (default, min or full).
 -u,--update        Create update.
 -v,--version       Display version information
 -z,--zip           Create index archive.

To index repository you need to specify repository name/id and path to repository on local file system (you can't index repository over http, ftp or scp). Additional parameters can be specified to set name of the directory where index will be created as well as index type. Here is a command we use to index Central Maven repository:

>java -jar nexus-indexer-1.0.0-SNAPSHOT-cli.jar -o -z -t full -i central -n central -r {path to repository on a local fs}

After scanning of Maven repository it will create index folder and two files:

nexus-maven-repository-index.properties
nexus-maven-repository-index.zip

The archive contains zipped Lucene directory for the repository index and property file currently contains repository id and last update timestamp:

#Mon Mar 10 14:19:48 CDT 2008
nexus.index.time=20080310141948.414 -0500
nexus.index.id=central

Those files need to be copied to /.index folder at repository root. See for example http://repo1.maven.org/maven2/.index/.

Nexus Repository Manager

Sonatype Nexus automatically indexes proxyed and hosted Maven repositories. See the project web site for more details.

Pre-configured indexes

Index configuration can be declared using org.maven.ide.eclipse.indexes extension point. It allows to specify repository url or even prepackaged index bundle and install it as a custom plugin dependent on the org.maven.ide.eclipse plugin. Here is how extension point declared for Maven central repository.

<extension point="org.maven.ide.eclipse.indexes">
    <index indexId="central"
           archive="central.zip"
           isShort="false"
           repositoryUrl="http://repo1.maven.org/maven2/"
           updateUrl="http://www.sonatype.com/nexus/"/>
  </extension>

Note that central.zip is the same archive as nexus-maven-repository-index.zip produced by the Nexus indexer CLI.

Nexus Indexer API Example

The following code snippet shows how to obtain NexusIndexer and IndexUpdater components from MavenEmbedder.

This should be done once and instance reused while application is running.

MavenEmbedder embedder;

// get NexusIndexer component from Plexus
PlexusContainer plexus = embedder.getPlexusContainer();
NexusIndexer indexer = (NexusIndexer) plexus.lookup(NexusIndexer.class);
IndexUpdater updater = (IndexUpdater) plexus.lookup(IndexUpdater.class);

// add indexing context (stateful), should be done once for lifetime
indexer.addIndexingContext(
  indexId,         // index id (usually the same as repository id)
  repositoryId,    // repository id 
  directory,       // Lucene directory where index is stored
  repositoryDir,   // local repository dir or null for remote repo
  repositoryUrl,   // repository url, used by index updater
  indexUpdateUrl,  // index update url or null if derived from repositoryUrl
  false, false);

The following snippet shows how to update/download remote index:

IndexingContext context = indexer.getIndexingContexts().get(indexId);

Settings settings = embedder.getSettings();
Proxy proxy = settings.getActiveProxy();
ProxyInfo proxyInfo = null;
if(proxy != null) {
  proxyInfo = new ProxyInfo();
  proxyInfo.setHost(proxy.getHost());
  proxyInfo.setPort(proxy.getPort());
  proxyInfo.setNonProxyHosts(proxy.getNonProxyHosts());
  proxyInfo.setUserName(proxy.getUsername());
  proxyInfo.setPassword(proxy.getPassword());
}

Date indexTime = updater.fetchAndUpdateIndex(context, transferListener, proxyInfo);
...

The following snippet shows how to run search query:

// run search query
BooleanQuery q = new BooleanQuery();
q.add(indexer.constructQuery(ArtifactInfo.GROUP_ID, term), Occur.SHOULD);
q.add(indexer.constructQuery(ArtifactInfo.ARTIFACT_ID, term), Occur.SHOULD);
q.add(new PrefixQuery(new Term(ArtifactInfo.MD5, term)), Occur.SHOULD);
q.add(new PrefixQuery(new Term(ArtifactInfo.SHA1, term)), Occur.SHOULD);

FlatSearchRequest request = new FlatSearchRequest(q);
FlatSearchResponse response = indexer.searchFlat(request);
...

Nexus Indexer

Nexus indexer CLI

Nexus Repository Manager

Pre-configured indexes

Nexus Indexer API Example

Labels

Comments (16)

Jacky says:

Eugene Kuleshov says:

Milos Kleint says:

Justin Edelson says:

Eugene Kuleshov says:

Justin Edelson says:

Jacky says:

Michael Gantert says:

Eugene Kuleshov says:

Baljit says:

Eugene Kuleshov says:

Liliya Pesotska says:

Eugene Kuleshov says:

Memter says:

Tamas Cservenak says:

Memter says:

Add Labels
Enter labels to add to this page: Looking for a label? Just start typing.