com.threecrickets.sincerity.packaging

Class ArtifactManager

java.lang.Object

com.threecrickets.sincerity.packaging.ArtifactManager

public class ArtifactManager
extends Object

This class manages a database of artifacts.

The database is normally stored in "/configuration/sincerity/artifacts.conf".

Author:

Tal Liron

Constructor Summary

Constructors

Constructor and Description
ArtifactManager(File file, PackagingContext packagingContext) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(Artifact artifact, boolean installed, byte[] digest) Adds the artifact to the database, marking the configuration file as requiring a save if the addition caused a change.
byte[]	getOriginalDigest(Artifact artifact) The digest when the artifact's file was first unpacked.
void	prune() Removes all artifacts from the database, deletes all unnecessary files that have not been modified (for which the digest has not changed), and finally saves the changes.
void	prune(Iterable<Artifact> necessaryArtifacts) Removes all artifacts from the database that are not mentioned, deletes all unnecessary files that have not been modified (for which the digest has not changed), and finally saves the changes.
void	save() Saves the database if there were changes.
boolean	wasInstalled(Artifact artifact) True if the artifact was marked as installed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArtifactManager

public ArtifactManager(File file,
                       PackagingContext packagingContext)

Constructor.

Parameters:

file - The database file (usually "/configuration/sincerity/artifacts.conf")

packagingContext - The packaging context

Method Detail

wasInstalled

public boolean wasInstalled(Artifact artifact)
                     throws SincerityException

True if the artifact was marked as installed.

Parameters:

artifact - The artifact

Returns:

True if was installed

Throws:

SincerityException - In case of an error

getOriginalDigest

public byte[] getOriginalDigest(Artifact artifact)
                         throws SincerityException

The digest when the artifact's file was first unpacked.

Parameters:

artifact - The artifact

Returns:

The digest or null

Throws:

SincerityException - In case of an error

add

public void add(Artifact artifact,
                boolean installed,
                byte[] digest)
         throws SincerityException

Adds the artifact to the database, marking the configuration file as requiring a save if the addition caused a change.

Parameters:

artifact - The artifact

installed - True if the artifact is installed

digest - The artifact's digest or null

Throws:

SincerityException - In case of an error

save

public void save()
          throws SincerityException

Saves the database if there were changes.

Throws:

SincerityException - In case of an error

prune

public void prune()
           throws SincerityException

Removes all artifacts from the database, deletes all unnecessary files that have not been modified (for which the digest has not changed), and finally saves the changes.

Throws:

SincerityException - In case of an error

prune

public void prune(Iterable<Artifact> necessaryArtifacts)
           throws SincerityException

Removes all artifacts from the database that are not mentioned, deletes all unnecessary files that have not been modified (for which the digest has not changed), and finally saves the changes.

Parameters:

necessaryArtifacts - The artifacts that should stay

Throws:

SincerityException - In case of an error