org.apache.archiva.indexer

Interface ArchivaIndexingContext

All Known Implementing Classes:

MavenIndexContext

public interface ArchivaIndexingContext

This represents a indexing context that is used to manage the index of a certain repository.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the context without deleting the files.
void	close(boolean deleteFiles) Closes any resources, this context has open.
void	commit() Writes the last changes to the index.
<T> T	getBaseContext(Class<T> clazz) Returns the repository specific implementation of the index.
Set<String>	getGroups() Returns the list of groups that are assigned to this index
String	getId() The identifier of the context
StorageAsset	getPath() The path where the index is stored.
Repository	getRepository() Returns the repository this index context is associated to.
boolean	isEmpty() Returns true, if the index has no entries or is not initialized.
boolean	isOpen() Returns the status of this context.
void	optimize() Optimizes the index
void	purge() Removes all entries from the index.
void	rollback() Throws away the last changes.
boolean	supports(Class<?> clazz) Returns true, if this index implementation has support for the given repository specific implementation class.
void	updateTimestamp(boolean save) Updates the timestamp of the index.
void	updateTimestamp(boolean save, ZonedDateTime time) Updates the timestamp with the given time.

Method Detail

getId

String getId()

The identifier of the context

Returns:

getRepository

Repository getRepository()

Returns the repository this index context is associated to.

Returns:

getPath

StorageAsset getPath()

The path where the index is stored.

Returns:

isEmpty

boolean isEmpty()
         throws IOException

Returns true, if the index has no entries or is not initialized.

Returns:

Throws:

IOException

commit

void commit()
     throws IOException

Writes the last changes to the index.

Throws:

IOException

rollback

void rollback()
       throws IOException

Throws away the last changes.

Throws:

IOException

optimize

void optimize()
       throws IOException

Optimizes the index

Throws:

IOException

close

void close(boolean deleteFiles)
    throws IOException

Closes any resources, this context has open.

Parameters:

deleteFiles - True, if the index files should be deleted.

Throws:

IOException

close

void close()
    throws IOException

Closes the context without deleting the files. Is identical to close(false)

Throws:

IOException

isOpen

boolean isOpen()

Returns the status of this context. This method will return false, after the close() method has been called.

Returns:

true, if the close() method has not been called, otherwise false

purge

void purge()
    throws IOException

Removes all entries from the index. After this method finished, isEmpty() should return true.

Throws:

IOException

supports

boolean supports(Class<?> clazz)

Returns true, if this index implementation has support for the given repository specific implementation class.

Parameters:

clazz -

Returns:

getBaseContext

<T> T getBaseContext(Class<T> clazz)
              throws UnsupportedBaseContextException

Returns the repository specific implementation of the index. E.g. the maven index class.

Parameters:

clazz - the specific class

Returns:

the instance of the given class representing this index

Throws:

UnsupportedOperationException - if the implementation is not supported

UnsupportedBaseContextException

getGroups

Set<String> getGroups()
               throws IOException

Returns the list of groups that are assigned to this index

Returns:

Throws:

IOException

updateTimestamp

void updateTimestamp(boolean save)
              throws IOException

Updates the timestamp of the index.

Parameters:

save -

Throws:

IOException

updateTimestamp

void updateTimestamp(boolean save,
                     ZonedDateTime time)
              throws IOException

Updates the timestamp with the given time.

Parameters:

save -

time -

Throws:

IOException