Class IPFSClusterConnector

java.lang.Object

wrappers.IPFSClusterConnector

public class IPFSClusterConnector
extends Object

Low level wrapper for the IPFS Cluster API. See IPFS Cluster API Docs

Constructor Summary

Constructors

Constructor	Description
IPFSClusterConnector(Host host)

Method Summary

Modifier and Type	Method	Description
void	add(InputStream stream, String pinName)	Adds a file to ipfs through the cluster, meaning its automatically pinned Due to not needing the CID, nothing is returned
String	getCIDUsingName(String name)	Retrieves a CID based on the pin name If there are multiple pins
long	getMinFreeSpace()
void	unpin(String CID)	Deletes a pin from the specified CID

Methods inherited from class Object

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

Constructor Details

IPFSClusterConnector

public IPFSClusterConnector(Host host)

Method Details

getCIDUsingName

public String getCIDUsingName(String name)
                       throws IOException,
IPFSException

Retrieves a CID based on the pin name If there are multiple pins

Parameters:

name - The pin name

Returns:

The CID

Throws:

IOException

IPFSException

add

public void add(InputStream stream,
 String pinName)
         throws IOException,
IPFSException

Adds a file to ipfs through the cluster, meaning its automatically pinned Due to not needing the CID, nothing is returned

Parameters:

stream - The input stream containing the data to be uploaded

pinName - The name of the pin

Throws:

IOException

IPFSException

unpin

public void unpin(String CID)
           throws IOException,
IPFSException

Deletes a pin from the specified CID

Parameters:

CID - The CID to remove the pin from

Throws:

IOException

IPFSException

getMinFreeSpace

public long getMinFreeSpace()
                     throws IOException,
IPFSException

Throws:

IOException

IPFSException