Index (IPFS-Tic 1.0-SNAPSHOT API)

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

add(InputStream) - Method in class wrappers.IPFSProxyConnector: Adds a file to IPFS.
add(InputStream, String) - Method in class wrappers.IPFSClusterConnector: Adds a file to ipfs through the cluster, meaning its automatically pinned Due to not needing the CID, nothing is returned
addBlock(InputStream) - Method in class wrappers.IPFSProxyConnector: Puts a block on to IPFS.
AllocationsRecord - Record Class in other
AllocationsRecord(String, String, String) - Constructor for record class other.AllocationsRecord: Creates an instance of a AllocationsRecord record class.

B

backup(String, String, File...) - Method in class wrappers.IPFSBackupMethods: Executes a backup operation
BackupCommand - Class in commands
BackupCommand() - Constructor for class commands.BackupCommand
BaseCommand - Class in commands.other
BaseCommand() - Constructor for class commands.other.BaseCommand
Block - Record Class in repository
Block(String, long) - Constructor for record class repository.Block: Creates an instance of a Block record class.
bytesToGiB(long) - Static method in class utils.FileUtils: Converts bytes to GiBs

C

call() - Method in class commands.BackupCommand
call() - Method in class commands.CleanupCommand
call() - Method in class commands.InitCommand
call() - Method in class commands.ListCommand
call() - Method in class commands.other.BaseCommand
call() - Method in class commands.other.WrapperBaseCommand
call() - Method in class commands.PruneCommand
call() - Method in class commands.RestoreCommand
cause - Variable in exception class exceptions.CDCException
CDCException - Exception Class in exceptions
CDCException(String, Exception) - Constructor for exception class exceptions.CDCException
chunkCIDs - Variable in class repository.File: The CIDs pointing to the chunks that the file is made up of
chunkingData - Variable in class repository.Repository
ChunkingData - Record Class in other
ChunkingData() - Constructor for record class other.ChunkingData
ChunkingData(int, int, int) - Constructor for record class other.ChunkingData: Creates an instance of a ChunkingData record class.
cid() - Method in record class other.AllocationsRecord: Returns the value of the cid record component.
CID() - Method in record class repository.Repository.RepositoryGet: Returns the value of the CID record component.
CleanupCommand - Class in commands
CleanupCommand() - Constructor for class commands.CleanupCommand
close() - Method in class commands.other.WrapperBaseCommand
close() - Method in class logger.LoggingHandler
close() - Method in class other.TempFile
clusterConnector() - Method in record class repository.Repository.GetData: Returns the value of the clusterConnector record component.
clusterConnector() - Method in record class repository.Repository.PutData: Returns the value of the clusterConnector record component.
clusterHost - Variable in class commands.other.WrapperBaseCommand
commands - package commands
commands.other - package commands.other
connector() - Method in record class repository.Repository.GetData: Returns the value of the connector record component.
connector() - Method in record class repository.Snapshot.CreateSnapshotData: Returns the value of the connector record component.
constructMultiPartBody(InputStream) - Static method in class utils.IPFSUtils: Constructs a put body for the ipfs proxy with a multipart body from the passed input stream
convert(String) - Method in class commands.other.HostConverter
create(Snapshot.CreateSnapshotData) - Static method in class repository.Snapshot: Constructs the object to create a new snapshot and uploads the files
CreateSnapshotData(IPFSProxyConnector, Repository, Encryption, Gson, List, HashMap) - Constructor for record class repository.Snapshot.CreateSnapshotData: Creates an instance of a CreateSnapshotData record class.

D

decrypt(InputStream) - Method in class utils.Encryption: Decrypts a passed input stream and returns it.
decryptionCipher(byte[]) - Method in class utils.Encryption: Generates a decryption cipher
DEFAULT - Enum constant in enum class logger.LoggingLevel
directories - Variable in class repository.Directory: All the directories that were inside this directory when it was backed up
Directory - Class in repository: Stores data about a directory when it was backed up.
Directory() - Constructor for class repository.Directory
Directory(String) - Constructor for class repository.Directory

E

encrypt(InputStream) - Method in class utils.Encryption: Encrypts the provided input stream and returns it
encryption() - Method in record class repository.Repository.GetData: Returns the value of the encryption record component.
encryption() - Method in record class repository.Repository.PutData: Returns the value of the encryption record component.
encryption() - Method in record class repository.Snapshot.CreateSnapshotData: Returns the value of the encryption record component.
Encryption - Class in utils
Encryption(String, String) - Constructor for class utils.Encryption
Encryption(String, String, int) - Constructor for class utils.Encryption
encryptionCipher(byte[]) - Method in class utils.Encryption: Generates an encryption cipher based on the passed IV
EncryptionException - Exception Class in exceptions
EncryptionException(String, Exception) - Constructor for exception class exceptions.EncryptionException
equals(Object) - Method in record class other.AllocationsRecord: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class other.ChunkingData: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class other.FreespaceMetric: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class repository.Block: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class repository.Repository.GetData: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class repository.Repository.PutData: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class repository.Repository.RepositoryGet: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class repository.Snapshot.CreateSnapshotData: Indicates whether some other object is "equal to" this one.
exceptions - package exceptions
exists(IPFSClusterConnector, String) - Static method in class repository.Repository: Returns a boolean whether the repository exists or not.

F

FastCDC - Class in utils: A class with methods to execute content defined chunking.
FastCDC(ChunkingData) - Constructor for class utils.FastCDC
file - Variable in class other.TempFile
File - Class in repository
File(String, List) - Constructor for class repository.File
fileName - Variable in class repository.File: The name of the file as it was before being uploaded
fileOutputStream - Variable in class other.TempFile
files - Variable in class repository.Directory: Stores the files inside the directory as list with name and unencrypted hash
files - Variable in class repository.Repository: Stores the unencrypted hash as the key and a pair of CID and Size as the value
FileUtils - Class in utils
FileUtils() - Constructor for class utils.FileUtils
forEachChunk(InputStream, BiConsumer) - Method in class utils.FastCDC: Finds all the chunks of a provided input stream and allows the use of a consumer to execute operations on each chunk
FreespaceMetric - Record Class in other
FreespaceMetric(String) - Constructor for record class other.FreespaceMetric: Creates an instance of a FreespaceMetric record class.

G

generateIV() - Method in class utils.Encryption: Generates a new IV based on the set size
get() - Method in class other.Host
get(Repository.GetData) - Static method in class repository.Repository: Gets the repository meta file and converts it to an instance of the Repository class
get(IPFSProxyConnector, Encryption, String) - Method in class repository.Directory: Downloads all files referenced by this directory
get(IPFSProxyConnector, Encryption, String) - Method in class repository.File: Downloads the file into the provided directory
getBlock(String) - Method in class wrappers.IPFSProxyConnector: Retrieves the block with the given CID See block/get
getBreakpoint(byte[], int) - Method in class utils.FastCDC: Gets the next breakpoint of the passed bytes and returns it
getChunks(InputStream) - Method in class utils.FastCDC: Performs FastCDC on an InputStream and returns the chunks
getCIDs() - Method in class repository.Directory: Recursively retrieves all CIDs that are in use by this directory
getCIDUsingName(String) - Method in class wrappers.IPFSClusterConnector: Retrieves a CID based on the pin name If there are multiple pins
GetData(IPFSProxyConnector, IPFSClusterConnector, Encryption, Gson, String, String) - Constructor for record class repository.Repository.GetData: Creates an instance of a GetData record class.
getFile(String) - Method in class wrappers.IPFSProxyConnector: Gets a file with the specified CID and returns the pure bytes See get
getFileHash(SHA256Digest, byte[], byte[]) - Static method in class utils.FileUtils: Returns the hash of the bytes passed to it
getID() - Method in class wrappers.IPFSProxyConnector
getMinFreeSpace() - Method in class wrappers.IPFSClusterConnector
getRecursiveHash(File) - Static method in class utils.FileUtils: Unpacks a file tree into a list, calculates the files, adds them together and returns it
getSize(int) - Method in class repository.Repository: Gets the size of the snapshot with the specified index
getSnapshotCreationData() - Method in class repository.Snapshot: Returns the data at which the snapshot was created
getUsedSpace(File) - Static method in class utils.FileUtils: Gets the amount of used spaces by a file and its sub-files (recursively) in bytes
gson() - Method in record class repository.Repository.GetData: Returns the value of the gson record component.
gson() - Method in record class repository.Repository.PutData: Returns the value of the gson record component.
gson() - Method in record class repository.Snapshot.CreateSnapshotData: Returns the value of the gson record component.

H

hashCode() - Method in record class other.AllocationsRecord: Returns a hash code value for this object.
hashCode() - Method in record class other.ChunkingData: Returns a hash code value for this object.
hashCode() - Method in record class other.FreespaceMetric: Returns a hash code value for this object.
hashCode() - Method in record class repository.Block: Returns a hash code value for this object.
hashCode() - Method in record class repository.Repository.GetData: Returns a hash code value for this object.
hashCode() - Method in record class repository.Repository.PutData: Returns a hash code value for this object.
hashCode() - Method in record class repository.Repository.RepositoryGet: Returns a hash code value for this object.
hashCode() - Method in record class repository.Snapshot.CreateSnapshotData: Returns a hash code value for this object.
headers - Variable in class commands.other.WrapperBaseCommand
Host - Class in other
Host(String) - Constructor for class other.Host: Attempts to create a host object
Host(String, int) - Constructor for class other.Host: Attempts to create a host object with an ip and a port
HostConverter - Class in commands.other
HostConverter() - Constructor for class commands.other.HostConverter

I

index - Variable in class commands.RestoreCommand
init(String, String) - Method in class wrappers.IPFSBackupMethods: Initializes a repository with the given name and password
InitCommand - Class in commands
InitCommand() - Constructor for class commands.InitCommand
Instance - Static variable in class logger.LoggingHandler
IPFSBackupMethods - Class in wrappers: Provides wrapper methods that run the low level IPFS wrappers to execute backup use cases.
IPFSBackupMethods(Host, Host) - Constructor for class wrappers.IPFSBackupMethods: Initializes the wrapper and creates a proxy as well as a cluster connector
IPFSClusterConnector - Class in wrappers: Low level wrapper for the IPFS Cluster API.
IPFSClusterConnector(Host) - Constructor for class wrappers.IPFSClusterConnector
IPFSException - Exception Class in exceptions
IPFSException(String) - Constructor for exception class exceptions.IPFSException
IPFSException(String, Exception) - Constructor for exception class exceptions.IPFSException
IPFSProxyConnector - Class in wrappers: REST API Wrapper for the IPFS Cluster Proxy.
IPFSProxyConnector(Host) - Constructor for class wrappers.IPFSProxyConnector
IPFSRequestException - Exception Class in exceptions
IPFSRequestException(String, Response) - Constructor for exception class exceptions.IPFSRequestException
IPFSUtils - Class in utils
IPFSUtils() - Constructor for class utils.IPFSUtils

J

JavaDocMover - Class in Unnamed Package
JavaDocMover() - Constructor for class JavaDocMover
JsonUtils - Class in utils
JsonUtils() - Constructor for class utils.JsonUtils

K

keep - Variable in class commands.PruneCommand
Key() - Method in record class repository.Block: Returns the value of the Key record component.

L

last - Variable in class commands.ListCommand
list(String, String, int) - Method in class wrappers.IPFSBackupMethods: Lists meta information of all snapshots
ListCommand - Class in commands
ListCommand() - Constructor for class commands.ListCommand
log(String, LoggingLevel) - Method in class logger.LoggingHandler
logFile - Variable in class commands.CleanupCommand
LogFileException - Exception Class in exceptions
LogFileException(String) - Constructor for exception class exceptions.LogFileException
logger - package logger
LoggingHandler - Class in logger
LoggingHandler(LoggingLevel) - Constructor for class logger.LoggingHandler
loggingLevel - Variable in class commands.other.WrapperBaseCommand
LoggingLevel - Enum Class in logger

M

main(String[]) - Static method in class JavaDocMover
Main - Class in Unnamed Package
Main() - Constructor for class Main
max() - Method in record class other.ChunkingData: Returns the value of the max record component.
min() - Method in record class other.ChunkingData: Returns the value of the min record component.

N

name - Variable in class other.TempFile
name - Variable in class repository.Directory: The name of the directory.
name() - Method in record class other.AllocationsRecord: Returns the value of the name record component.
newBlocks() - Method in record class repository.Snapshot.CreateSnapshotData: Returns the value of the newBlocks record component.
normal() - Method in record class other.ChunkingData: Returns the value of the normal record component.

O

other - package other

P

parseJsonSequence(InputStream, Gson, Class) - Static method in class utils.JsonUtils: Parses the provided input stream consisting of multiple json objects into a list of the provided class
password - Variable in class commands.other.WrapperBaseCommand
password() - Method in record class repository.Repository.GetData: Returns the value of the password record component.
proxyHost - Variable in class commands.other.WrapperBaseCommand
prune(int) - Method in class repository.Repository: Based on the amount to keep returns the CIDs that are unique to the snapshots with an index higher or equal to amountToKeep
prune(String, String, int) - Method in class wrappers.IPFSBackupMethods: Executes a prune operation on the repository
PruneCommand - Class in commands
PruneCommand() - Constructor for class commands.PruneCommand
publish(String) - Method in class wrappers.IPFSProxyConnector
put(Repository.PutData) - Static method in class repository.Repository: Converts the repository file to utf 8 bytes and uploads it as a whole to ipfs.
PutData(Repository, IPFSClusterConnector, Encryption, Gson, String) - Constructor for record class repository.Repository.PutData: Creates an instance of a PutData record class.

Q

QUIET - Enum constant in enum class logger.LoggingLevel

R

repoName() - Method in record class repository.Repository.GetData: Returns the value of the repoName record component.
repoName() - Method in record class repository.Repository.PutData: Returns the value of the repoName record component.
repository - package repository
repository - Variable in class commands.other.WrapperBaseCommand
repository() - Method in record class repository.Repository.PutData: Returns the value of the repository record component.
repository() - Method in record class repository.Repository.RepositoryGet: Returns the value of the repository record component.
repository() - Method in record class repository.Snapshot.CreateSnapshotData: Returns the value of the repository record component.
Repository - Class in repository
Repository(ChunkingData) - Constructor for class repository.Repository
Repository.GetData - Record Class in repository
Repository.PutData - Record Class in repository
Repository.RepositoryGet - Record Class in repository
RepositoryGet(Repository, String) - Constructor for record class repository.Repository.RepositoryGet: Creates an instance of a RepositoryGet record class.
restore(String, String, File, int) - Method in class wrappers.IPFSBackupMethods: Executes a restore operation on the provided repository
RestoreCommand - Class in commands
RestoreCommand() - Constructor for class commands.RestoreCommand
rmBlock(String, boolean) - Method in class wrappers.IPFSProxyConnector: Removes a block based on the given CID See block/rm
run(String...) - Static method in class Main

S

Size() - Method in record class repository.Block: Returns the value of the Size record component.
Snapshot - Class in repository
Snapshot() - Constructor for class repository.Snapshot
Snapshot.CreateSnapshotData - Record Class in repository: Wrapper that holds data for the creation of a snapshot
snapshots - Variable in class repository.Repository: A list to store the snapshots
source() - Method in record class repository.Snapshot.CreateSnapshotData: Returns the value of the source record component.

T

targetFolder - Variable in class commands.RestoreCommand
TempFile - Class in other: Creates a file with a specified prefix and the current local date time
TempFile(String) - Constructor for class other.TempFile
timestamp() - Method in record class other.AllocationsRecord: Returns the value of the timestamp record component.
toString() - Method in record class other.AllocationsRecord: Returns a string representation of this record class.
toString() - Method in record class other.ChunkingData: Returns a string representation of this record class.
toString() - Method in record class other.FreespaceMetric: Returns a string representation of this record class.
toString() - Method in record class repository.Block: Returns a string representation of this record class.
toString() - Method in record class repository.Repository.GetData: Returns a string representation of this record class.
toString() - Method in record class repository.Repository.PutData: Returns a string representation of this record class.
toString() - Method in record class repository.Repository.RepositoryGet: Returns a string representation of this record class.
toString() - Method in record class repository.Snapshot.CreateSnapshotData: Returns a string representation of this record class.

U

unpin(String) - Method in class wrappers.IPFSClusterConnector: Deletes a pin from the specified CID
utils - package utils

V

value - Variable in enum class logger.LoggingLevel
value() - Method in record class other.FreespaceMetric: Returns the value of the value record component.
valueOf(String) - Static method in enum class logger.LoggingLevel: Returns the enum constant of this class with the specified name.
values() - Static method in enum class logger.LoggingLevel: Returns an array containing the constants of this enum class, in the order they are declared.
VERBOSE - Enum constant in enum class logger.LoggingLevel

W

WrapperBaseCommand - Class in commands.other
WrapperBaseCommand() - Constructor for class commands.other.WrapperBaseCommand
wrappers - package wrappers

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form