org.apache.maven.index.updater

Class DefaultIndexUpdater

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.index.updater.DefaultIndexUpdater

All Implemented Interfaces:

IndexUpdater, org.codehaus.plexus.logging.LogEnabled

@Component(role=IndexUpdater.class)
public class DefaultIndexUpdater
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements IndexUpdater

A default index updater implementation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultIndexUpdater.FileFetcher Filesystem-based ResourceFetcher implementation
private class	DefaultIndexUpdater.IndexAdaptor
private class	DefaultIndexUpdater.LocalCacheIndexAdaptor
(package private) static class	DefaultIndexUpdater.LocalIndexCacheFetcher
private class	DefaultIndexUpdater.LuceneIndexAdaptor

Field Summary

Fields

Modifier and Type	Field and Description
(package private) IncrementalHandler	incrementalHandler
private java.util.List<IndexUpdateSideEffect>	sideEffects

Constructor Summary

Constructors

Constructor and Description
DefaultIndexUpdater()
DefaultIndexUpdater(IncrementalHandler handler, java.util.List<IndexUpdateSideEffect> mySideeffects)

Method Summary

Modifier and Type	Method and Description
protected void	cleanCacheDirectory(java.io.File dir) Cleans specified cache directory.
private static void	copyUpdatedDocuments(org.apache.lucene.store.Directory sourcedir, org.apache.lucene.store.Directory targetdir, IndexingContext context)
private java.util.Properties	downloadIndexProperties(ResourceFetcher fetcher)
IndexUpdateResult	fetchAndUpdateIndex(IndexUpdateRequest updateRequest)
private IndexUpdateResult	fetchAndUpdateIndex(IndexUpdateRequest updateRequest, ResourceFetcher source, DefaultIndexUpdater.IndexAdaptor target)
private static void	filterDirectory(org.apache.lucene.store.Directory directory, DocumentFilter filter)
java.util.Date	getTimestamp(java.util.Properties properties, java.lang.String key)
private java.util.Date	loadIndexDirectory(IndexUpdateRequest updateRequest, ResourceFetcher fetcher, boolean merge, java.lang.String remoteIndexFile)
private java.util.Properties	loadIndexProperties(java.io.File indexDirectoryFile, java.lang.String remoteIndexPropertiesName)
private void	storeIndexProperties(java.io.File dir, java.lang.String indexPropertiesName, java.util.Properties properties)
private static void	unpackDirectory(org.apache.lucene.store.Directory directory, java.io.InputStream is)
static java.util.Date	unpackIndexArchive(java.io.InputStream is, org.apache.lucene.store.Directory directory, IndexingContext context) Unpack legacy index archive into a specified Lucene Directory
static java.util.Date	unpackIndexData(java.io.InputStream is, org.apache.lucene.store.Directory d, IndexingContext context) Unpack index data using specified Lucene Index writer

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

incrementalHandler

@Requirement(role=IncrementalHandler.class)
IncrementalHandler incrementalHandler

sideEffects

@Requirement(role=IndexUpdateSideEffect.class)
private java.util.List<IndexUpdateSideEffect> sideEffects

Constructor Detail

DefaultIndexUpdater

public DefaultIndexUpdater(IncrementalHandler handler,
                           java.util.List<IndexUpdateSideEffect> mySideeffects)

DefaultIndexUpdater

public DefaultIndexUpdater()

Method Detail

fetchAndUpdateIndex

public IndexUpdateResult fetchAndUpdateIndex(IndexUpdateRequest updateRequest)
                                      throws java.io.IOException

Specified by:

fetchAndUpdateIndex in interface IndexUpdater

Returns:

IndexUpdateResult

Throws:

java.io.IOException

loadIndexDirectory

private java.util.Date loadIndexDirectory(IndexUpdateRequest updateRequest,
                                          ResourceFetcher fetcher,
                                          boolean merge,
                                          java.lang.String remoteIndexFile)
                                   throws java.io.IOException

Throws:

java.io.IOException

unpackIndexArchive

public static java.util.Date unpackIndexArchive(java.io.InputStream is,
                                                org.apache.lucene.store.Directory directory,
                                                IndexingContext context)
                                         throws java.io.IOException

Unpack legacy index archive into a specified Lucene Directory

Parameters:

is - a ZipInputStream with index data

directory - Lucene Directory to unpack index data to

Returns:

Date of the index update or null if it can't be read

Throws:

java.io.IOException

unpackDirectory

private static void unpackDirectory(org.apache.lucene.store.Directory directory,
                                    java.io.InputStream is)
                             throws java.io.IOException

Throws:

java.io.IOException

copyUpdatedDocuments

private static void copyUpdatedDocuments(org.apache.lucene.store.Directory sourcedir,
                                         org.apache.lucene.store.Directory targetdir,
                                         IndexingContext context)
                                  throws org.apache.lucene.index.CorruptIndexException,
                                         org.apache.lucene.store.LockObtainFailedException,
                                         java.io.IOException

Throws:

org.apache.lucene.index.CorruptIndexException

org.apache.lucene.store.LockObtainFailedException

java.io.IOException

filterDirectory

private static void filterDirectory(org.apache.lucene.store.Directory directory,
                                    DocumentFilter filter)
                             throws java.io.IOException

Throws:

java.io.IOException

loadIndexProperties

private java.util.Properties loadIndexProperties(java.io.File indexDirectoryFile,
                                                 java.lang.String remoteIndexPropertiesName)

storeIndexProperties

private void storeIndexProperties(java.io.File dir,
                                  java.lang.String indexPropertiesName,
                                  java.util.Properties properties)
                           throws java.io.IOException

Throws:

java.io.IOException

downloadIndexProperties

private java.util.Properties downloadIndexProperties(ResourceFetcher fetcher)
                                              throws java.io.IOException

Throws:

java.io.IOException

getTimestamp

public java.util.Date getTimestamp(java.util.Properties properties,
                                   java.lang.String key)

unpackIndexData

public static java.util.Date unpackIndexData(java.io.InputStream is,
                                             org.apache.lucene.store.Directory d,
                                             IndexingContext context)
                                      throws java.io.IOException

Unpack index data using specified Lucene Index writer

Parameters:

is - an input stream to unpack index data from

w - a writer to save index data

ics - a collection of index creators for updating unpacked documents.

Throws:

java.io.IOException

fetchAndUpdateIndex

private IndexUpdateResult fetchAndUpdateIndex(IndexUpdateRequest updateRequest,
                                              ResourceFetcher source,
                                              DefaultIndexUpdater.IndexAdaptor target)
                                       throws java.io.IOException

Throws:

java.io.IOException

cleanCacheDirectory

protected void cleanCacheDirectory(java.io.File dir)
                            throws java.io.IOException

Cleans specified cache directory. If present, Locker.LOCK_FILE will not be deleted.

Throws:

java.io.IOException