org.apache.archiva.indexer.maven

Class MavenIndexManager

java.lang.Object

org.apache.archiva.indexer.maven.MavenIndexManager

All Implemented Interfaces:

ArchivaIndexManager

@Service(value="archivaIndexManager#maven")
public class MavenIndexManager
extends Object
implements ArchivaIndexManager

Maven implementation of index manager. The index manager is a singleton, so we try to make sure, that index operations are not running parallel by synchronizing on the index path. A update operation waits for parallel running methods to finish before starting, but after a certain time of retries a IndexUpdateFailedException is thrown.

Field Summary

Fields inherited from interface org.apache.archiva.indexer.ArchivaIndexManager

DEFAULT_INDEX_PATH, DEFAULT_PACKED_INDEX_PATH

Constructor Summary

Constructors

Constructor and Description
MavenIndexManager()

Method Summary

Modifier and Type	Method and Description
void	addArtifactsToIndex(ArchivaIndexingContext context, Collection<URI> artifactReference) Adds a list of artifacts to the index.
ArchivaIndexingContext	createContext(Repository repository) Creates the indexing context for the given repository.
static org.apache.maven.index.context.IndexingContext	getMvnContext(ArchivaIndexingContext context)
ArchivaIndexingContext	mergeContexts(Repository destinationRepo, List<ArchivaIndexingContext> contexts, boolean packIndex) Merges a list of contexts into a single one.
ArchivaIndexingContext	move(ArchivaIndexingContext context, Repository repo) Moves the context to a new directory.
void	pack(ArchivaIndexingContext context) Compresses the index to a more dense packed format.
void	removeArtifactsFromIndex(ArchivaIndexingContext context, Collection<URI> artifactReference) Removes a list of artifacts from the index.
ArchivaIndexingContext	reset(ArchivaIndexingContext context) Reinitializes the index.
void	scan(ArchivaIndexingContext context) Rescans the whole repository, this index is associated to.
boolean	supportsRepository(RepositoryType type) Returns true, if this manager is able to apply the index actions for the given repository type.
void	update(ArchivaIndexingContext context, boolean fullUpdate) Updates the index from the remote url.
void	updateLocalIndexPath(Repository repo) Updates the local path where the index is stored using the repository information.

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenIndexManager

public MavenIndexManager()

Method Detail

getMvnContext

public static org.apache.maven.index.context.IndexingContext getMvnContext(ArchivaIndexingContext context)
                                                                    throws UnsupportedBaseContextException

Throws:

UnsupportedBaseContextException

pack

public void pack(ArchivaIndexingContext context)
          throws IndexUpdateFailedException

Description copied from interface: ArchivaIndexManager

Compresses the index to a more dense packed format.

Specified by:

pack in interface ArchivaIndexManager

Throws:

IndexUpdateFailedException

scan

public void scan(ArchivaIndexingContext context)
          throws IndexUpdateFailedException

Description copied from interface: ArchivaIndexManager

Rescans the whole repository, this index is associated to.

Specified by:

scan in interface ArchivaIndexManager

Throws:

IndexUpdateFailedException

update

public void update(ArchivaIndexingContext context,
                   boolean fullUpdate)
            throws IndexUpdateFailedException

Description copied from interface: ArchivaIndexManager

Updates the index from the remote url.

Specified by:

update in interface ArchivaIndexManager

Throws:

IndexUpdateFailedException

addArtifactsToIndex

public void addArtifactsToIndex(ArchivaIndexingContext context,
                                Collection<URI> artifactReference)
                         throws IndexUpdateFailedException

Description copied from interface: ArchivaIndexManager

Adds a list of artifacts to the index.

Specified by:

addArtifactsToIndex in interface ArchivaIndexManager

Throws:

IndexUpdateFailedException

removeArtifactsFromIndex

public void removeArtifactsFromIndex(ArchivaIndexingContext context,
                                     Collection<URI> artifactReference)
                              throws IndexUpdateFailedException

Description copied from interface: ArchivaIndexManager

Removes a list of artifacts from the index.

Specified by:

removeArtifactsFromIndex in interface ArchivaIndexManager

Throws:

IndexUpdateFailedException

supportsRepository

public boolean supportsRepository(RepositoryType type)

Description copied from interface: ArchivaIndexManager

Returns true, if this manager is able to apply the index actions for the given repository type.

Specified by:

supportsRepository in interface ArchivaIndexManager

Returns:

createContext

public ArchivaIndexingContext createContext(Repository repository)
                                     throws IndexCreationFailedException

Description copied from interface: ArchivaIndexManager

Creates the indexing context for the given repository.

Specified by:

createContext in interface ArchivaIndexManager

Parameters:

repository - the repository for which the index context should be created

Returns:

the index context

Throws:

IndexCreationFailedException

reset

public ArchivaIndexingContext reset(ArchivaIndexingContext context)
                             throws IndexUpdateFailedException

Description copied from interface: ArchivaIndexManager

Reinitializes the index. E.g. remove the files and create a new empty index.

Specified by:

reset in interface ArchivaIndexManager

Returns:

the new created index

Throws:

IndexUpdateFailedException

move

public ArchivaIndexingContext move(ArchivaIndexingContext context,
                                   Repository repo)
                            throws IndexCreationFailedException

Description copied from interface: ArchivaIndexManager

Moves the context to a new directory. It's up to the implementation, if a new context is created or the context is moved only.

Specified by:

move in interface ArchivaIndexManager

Parameters:

context - The current context

repo - The repository

Returns:

The new context

Throws:

IndexCreationFailedException

updateLocalIndexPath

public void updateLocalIndexPath(Repository repo)

Description copied from interface: ArchivaIndexManager

Updates the local path where the index is stored using the repository information.

Specified by:

updateLocalIndexPath in interface ArchivaIndexManager

mergeContexts

public ArchivaIndexingContext mergeContexts(Repository destinationRepo,
                                            List<ArchivaIndexingContext> contexts,
                                            boolean packIndex)
                                     throws UnsupportedOperationException,
                                            IndexCreationFailedException,
                                            IllegalArgumentException

Description copied from interface: ArchivaIndexManager

Merges a list of contexts into a single one.

Specified by:

mergeContexts in interface ArchivaIndexManager

Parameters:

destinationRepo - The destination repository

contexts - The contexts of the indexes that should be merged.

packIndex - True, if the merged index should be packed, otherwise false.

Returns:

The merged context

Throws:

UnsupportedOperationException - if the underlying implementation does not allow to merge indexing contexts

IndexCreationFailedException

IllegalArgumentException