org.apache.archiva.indexer

Interface ArchivaIndexManager

All Known Implementing Classes:

MavenIndexManager

public interface ArchivaIndexManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_INDEX_PATH
static String	DEFAULT_PACKED_INDEX_PATH

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

Field Detail

DEFAULT_INDEX_PATH

static final String DEFAULT_INDEX_PATH

See Also:

Constant Field Values

DEFAULT_PACKED_INDEX_PATH

static final String DEFAULT_PACKED_INDEX_PATH

See Also:

Constant Field Values

Method Detail

pack

void pack(ArchivaIndexingContext context)
   throws IndexUpdateFailedException

Compresses the index to a more dense packed format.

Parameters:

context -

Throws:

IndexUpdateFailedException

scan

void scan(ArchivaIndexingContext context)
   throws IndexUpdateFailedException

Rescans the whole repository, this index is associated to.

Parameters:

context -

Throws:

IndexUpdateFailedException

update

void update(ArchivaIndexingContext context,
            boolean fullUpdate)
     throws IndexUpdateFailedException

Updates the index from the remote url.

Parameters:

context -

fullUpdate -

Throws:

IndexUpdateFailedException

addArtifactsToIndex

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

Adds a list of artifacts to the index.

Parameters:

context -

artifactReference -

Throws:

IndexUpdateFailedException

removeArtifactsFromIndex

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

Removes a list of artifacts from the index.

Parameters:

context -

artifactReference -

Throws:

IndexUpdateFailedException

supportsRepository

boolean supportsRepository(RepositoryType type)

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

Parameters:

type -

Returns:

createContext

ArchivaIndexingContext createContext(Repository repository)
                              throws IndexCreationFailedException

Creates the indexing context for the given repository.

Parameters:

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

Returns:

the index context

Throws:

IndexCreationFailedException

reset

ArchivaIndexingContext reset(ArchivaIndexingContext context)
                      throws IndexUpdateFailedException

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

Parameters:

context -

Returns:

the new created index

Throws:

IndexUpdateFailedException

move

ArchivaIndexingContext move(ArchivaIndexingContext context,
                            Repository repo)
                     throws IndexCreationFailedException

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.

Parameters:

context - The current context

repo - The repository

Returns:

The new context

Throws:

IndexCreationFailedException

updateLocalIndexPath

void updateLocalIndexPath(Repository repo)

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

mergeContexts

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

Merges a list of contexts into a single one.

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