org.apache.archiva.repository.features

Class IndexCreationFeature

java.lang.Object

org.apache.archiva.repository.features.AbstractFeature

org.apache.archiva.repository.features.IndexCreationFeature

All Implemented Interfaces:

RepositoryFeature<IndexCreationFeature>

public class IndexCreationFeature
extends AbstractFeature
implements RepositoryFeature<IndexCreationFeature>

This feature provides information about index creation. Repositories that support this feature are able to create indexes and download them from remote repositories. Repositories may have a normal and packed index. A normal index is used by repository search utilities, the packed index is for downloading purpose. A index may have a remote and a local representation. The remote representation is used for downloading and updating the local representation. The feature is throwing a RepositoryIndexEvent, if the URI of the index has been changed.

Constructor Summary

Constructors

Constructor and Description
IndexCreationFeature(boolean skipPackedIndexCreation)
IndexCreationFeature(Repository repository, EventHandler listener)

Method Summary

Modifier and Type	Method and Description
IndexCreationFeature	get() Returns the concrete feature instance.
URI	getIndexPath() Returns the path that is used to store the index.
StorageAsset	getLocalIndexPath() Returns the path where the index is stored physically.
StorageAsset	getLocalPackedIndexPath() Returns the directory where the packed index is stored.
URI	getPackedIndexPath() Returns the path of the packed index.
boolean	hasIndex() Returns true, if this repository has a index defined.
boolean	isSkipPackedIndexCreation() Returns true, if no packed index files should be created.
void	setIndexPath(URI indexPath) Sets the path that is used to store the index.
void	setLocalIndexPath(StorageAsset localIndexPath) Sets the path where the index is stored locally.
void	setLocalPackedIndexPath(StorageAsset localPackedIndexPath) Sets the path where the packed index is stored physically.
void	setPackedIndexPath(URI packedIndexPath) Sets the path (relative or absolute) of the packed index.
void	setSkipPackedIndexCreation(boolean skipPackedIndexCreation) Sets the flag for packed index creation.
String	toString()

Methods inherited from class org.apache.archiva.repository.features.AbstractFeature

addListener, clearListeners, pushEvent, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.archiva.repository.features.RepositoryFeature

getId, isFeature, isFeature

Constructor Detail

IndexCreationFeature

public IndexCreationFeature(Repository repository,
                            EventHandler listener)

IndexCreationFeature

public IndexCreationFeature(boolean skipPackedIndexCreation)

Method Detail

get

public IndexCreationFeature get()

Description copied from interface: RepositoryFeature

Returns the concrete feature instance.

Specified by:

get in interface RepositoryFeature<IndexCreationFeature>

Returns:

the feature instance.

isSkipPackedIndexCreation

public boolean isSkipPackedIndexCreation()

Returns true, if no packed index files should be created.

Returns:

True, if no packed index files are created, otherwise false.

setSkipPackedIndexCreation

public void setSkipPackedIndexCreation(boolean skipPackedIndexCreation)

Sets the flag for packed index creation.

Parameters:

skipPackedIndexCreation -

getIndexPath

public URI getIndexPath()

Returns the path that is used to store the index. The path may be a absolute URI or relative to the base URI of the repository.

Returns:

the uri (may be relative or absolute)

setIndexPath

public void setIndexPath(URI indexPath)

Sets the path that is used to store the index. The path may be either absolute or a path that is relative to the repository storage path (either a local or remote path).

Parameters:

indexPath - the uri to the index path (may be relative)

hasIndex

public boolean hasIndex()

Returns true, if this repository has a index defined.

Returns:

true, if a index path is set, otherwise false

getLocalIndexPath

public StorageAsset getLocalIndexPath()

Returns the path where the index is stored physically.

Returns:

setLocalIndexPath

public void setLocalIndexPath(StorageAsset localIndexPath)

Sets the path where the index is stored locally.

Parameters:

localIndexPath -

getPackedIndexPath

public URI getPackedIndexPath()

Returns the path of the packed index.

Returns:

setPackedIndexPath

public void setPackedIndexPath(URI packedIndexPath)

Sets the path (relative or absolute) of the packed index. Throws a RepositoryIndexEvent.Index#PACKED_INDEX_URI_CHANGE, if the value changes.

Parameters:

packedIndexPath - the new path uri for the packed index

getLocalPackedIndexPath

public StorageAsset getLocalPackedIndexPath()

Returns the directory where the packed index is stored.

Returns:

setLocalPackedIndexPath

public void setLocalPackedIndexPath(StorageAsset localPackedIndexPath)

Sets the path where the packed index is stored physically. This method should only be used by the MavenIndexProvider implementations.

Parameters:

localPackedIndexPath -

toString

public String toString()

Overrides:

toString in class Object