Class Repository

java.lang.Object

repository.Repository

public class Repository
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Repository.GetData
static final record	Repository.PutData
static final record	Repository.RepositoryGet

Field Summary

Fields

Modifier and Type	Field	Description
ChunkingData	chunkingData
HashMap<String,Block>	files	Stores the unencrypted hash as the key and a pair of CID and Size as the value
List<Snapshot>	snapshots	A list to store the snapshots

Constructor Summary

Constructors

Constructor	Description
Repository(ChunkingData chunkingData)

Method Summary

Modifier and Type	Method	Description
static boolean	exists(IPFSClusterConnector connector, String repoName)	Returns a boolean whether the repository exists or not.
static Repository.RepositoryGet	get(Repository.GetData getData)	Gets the repository meta file and converts it to an instance of the Repository class
Long	getSize(int index)	Gets the size of the snapshot with the specified index
Collection<String>	prune(int amountToKeep)	Based on the amount to keep returns the CIDs that are unique to the snapshots with an index higher or equal to amountToKeep
static void	put(Repository.PutData commandData)	Converts the repository file to utf 8 bytes and uploads it as a whole to ipfs.

Methods inherited from class Object

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

Field Details

chunkingData

public ChunkingData chunkingData

files

public HashMap<String,Block> files

Stores the unencrypted hash as the key and a pair of CID and Size as the value

snapshots

public List<Snapshot> snapshots

A list to store the snapshots

Constructor Details

Repository

public Repository(ChunkingData chunkingData)

Method Details

exists

public static boolean exists(IPFSClusterConnector connector,
 String repoName)
                      throws IOException,
IPFSException

Returns a boolean whether the repository exists or not. Assumes that the key of the repository has been correctly removed if the repository itself was removed

Parameters:

connector - the ipfs connector

Returns:

whether a repo exists or not

Throws:

IOException

IPFSException

get

public static Repository.RepositoryGet get(Repository.GetData getData)
                                    throws IOException,
EncryptionException,
IPFSException

Gets the repository meta file and converts it to an instance of the Repository class

Returns:

the extracted repository class

Throws:

IOException

EncryptionException

IPFSException

put

public static void put(Repository.PutData commandData)
                throws EncryptionException,
IOException,
IPFSException

Converts the repository file to utf 8 bytes and uploads it as a whole to ipfs. If the add was successful, the ipns name gets updated to the new file.

Parameters:

commandData - Helper record containing references to important objects

Throws:

EncryptionException

IOException

IPFSException

getSize

public Long getSize(int index)

Gets the size of the snapshot with the specified index

Parameters:

index - The index of the snapshot

Returns:

The size of the snapshot in bytes

prune

public Collection<String> prune(int amountToKeep)

Based on the amount to keep returns the CIDs that are unique to the snapshots with an index higher or equal to amountToKeep

Parameters:

amountToKeep - The amount of snapshots to keep

Returns:

The CIDs that should be removed/unpinned