org.apache.archiva.indexer.maven

Class MavenIndexContext

java.lang.Object

org.apache.archiva.indexer.maven.MavenIndexContext

All Implemented Interfaces:

ArchivaIndexingContext

public class MavenIndexContext
extends Object
implements ArchivaIndexingContext

Maven implementation of index context

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MavenIndexContext(Repository repository, org.apache.maven.index.context.IndexingContext delegate)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenIndexContext

protected MavenIndexContext(Repository repository,
                            org.apache.maven.index.context.IndexingContext delegate)

Method Detail

getId

public String getId()

Description copied from interface: ArchivaIndexingContext

The identifier of the context

Specified by:

getId in interface ArchivaIndexingContext

Returns:

getRepository

public Repository getRepository()

Description copied from interface: ArchivaIndexingContext

Returns the repository this index context is associated to.

Specified by:

getRepository in interface ArchivaIndexingContext

Returns:

getPath

public StorageAsset getPath()

Description copied from interface: ArchivaIndexingContext

The path where the index is stored.

Specified by:

getPath in interface ArchivaIndexingContext

Returns:

isEmpty

public boolean isEmpty()
                throws IOException

Description copied from interface: ArchivaIndexingContext

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

Specified by:

isEmpty in interface ArchivaIndexingContext

Returns:

Throws:

IOException

commit

public void commit()
            throws IOException

Description copied from interface: ArchivaIndexingContext

Writes the last changes to the index.

Specified by:

commit in interface ArchivaIndexingContext

Throws:

IOException

rollback

public void rollback()
              throws IOException

Description copied from interface: ArchivaIndexingContext

Throws away the last changes.

Specified by:

rollback in interface ArchivaIndexingContext

Throws:

IOException

optimize

public void optimize()
              throws IOException

Description copied from interface: ArchivaIndexingContext

Optimizes the index

Specified by:

optimize in interface ArchivaIndexingContext

Throws:

IOException

close

public void close(boolean deleteFiles)
           throws IOException

Description copied from interface: ArchivaIndexingContext

Closes any resources, this context has open.

Specified by:

close in interface ArchivaIndexingContext

Parameters:

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

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: ArchivaIndexingContext

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

Specified by:

close in interface ArchivaIndexingContext

Throws:

IOException

isOpen

public boolean isOpen()

Description copied from interface: ArchivaIndexingContext

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

Specified by:

isOpen in interface ArchivaIndexingContext

Returns:

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

purge

public void purge()
           throws IOException

Description copied from interface: ArchivaIndexingContext

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

Specified by:

purge in interface ArchivaIndexingContext

Throws:

IOException

supports

public boolean supports(Class<?> clazz)

Description copied from interface: ArchivaIndexingContext

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

Specified by:

supports in interface ArchivaIndexingContext

Returns:

getBaseContext

public <T> T getBaseContext(Class<T> clazz)
                     throws UnsupportedOperationException

Description copied from interface: ArchivaIndexingContext

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

Specified by:

getBaseContext in interface ArchivaIndexingContext

Parameters:

clazz - the specific class

Returns:

the instance of the given class representing this index

Throws:

UnsupportedOperationException - if the implementation is not supported

getGroups

public Set<String> getGroups()
                      throws IOException

Description copied from interface: ArchivaIndexingContext

Returns the list of groups that are assigned to this index

Specified by:

getGroups in interface ArchivaIndexingContext

Returns:

Throws:

IOException

updateTimestamp

public void updateTimestamp(boolean save)
                     throws IOException

Description copied from interface: ArchivaIndexingContext

Updates the timestamp of the index.

Specified by:

updateTimestamp in interface ArchivaIndexingContext

Throws:

IOException

updateTimestamp

public void updateTimestamp(boolean save,
                            ZonedDateTime time)
                     throws IOException

Description copied from interface: ArchivaIndexingContext

Updates the timestamp with the given time.

Specified by:

updateTimestamp in interface ArchivaIndexingContext

Throws:

IOException