Class IPFSProxyConnector

java.lang.Object

wrappers.IPFSProxyConnector

public class IPFSProxyConnector
extends Object

REST API Wrapper for the IPFS Cluster Proxy. Works with Kubo as well, but needs to be used with the cluster in order for the backups to be replicated. See IPFS Cluster Proxy Docs

Constructor Summary

Constructors

Constructor	Description
IPFSProxyConnector(Host proxyHost)

Method Summary

Modifier and Type	Method	Description
String	add(InputStream file)	Adds a file to IPFS.
Block	addBlock(InputStream block)	Puts a block on to IPFS.
InputStream	getBlock(String CID)	Retrieves the block with the given CID See block/get
byte[]	getFile(String CID)	Gets a file with the specified CID and returns the pure bytes See get
String	getID()
void	publish(String CID)
void	rmBlock(String CID, boolean ignoreNonExistent)	Removes a block based on the given CID See block/rm

Methods inherited from class Object

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

Constructor Details

IPFSProxyConnector

public IPFSProxyConnector(Host proxyHost)

Method Details

addBlock

public Block addBlock(InputStream block)
               throws IOException,
NullPointerException,
IPFSException

Puts a block on to IPFS. See Kubo Block Put

Parameters:

block - The bytes to put

Returns:

The CID

Throws:

IOException - is thrown if the http request fails

NullPointerException

IPFSException

add

public String add(InputStream file)
           throws IOException,
NullPointerException,
IPFSException

Adds a file to IPFS. See add

Parameters:

file - The file to add

Returns:

The CID of the newly uploaded File

Throws:

IOException - for issues with the http request

NullPointerException - if the response body is null

IPFSException - if the request fails

publish

public void publish(String CID)
             throws IOException,
IPFSException

Throws:

IOException

IPFSException

getBlock

public InputStream getBlock(String CID)
                     throws IOException,
NullPointerException,
IPFSException

Retrieves the block with the given CID See block/get

Parameters:

CID - The CID of the block to get

Returns:

The bytes of the block (Still encrypted)

Throws:

IOException - is thrown when the http request fails

NullPointerException

IPFSException

getFile

public byte[] getFile(String CID)
               throws IOException,
NullPointerException,
IPFSException

Gets a file with the specified CID and returns the pure bytes See get

Parameters:

CID - The CID of the File

Returns:

The file as bytes

Throws:

IOException

NullPointerException

IPFSException

getID

public String getID()
             throws IOException,
IPFSException

Throws:

IOException

IPFSException

rmBlock

public void rmBlock(String CID,
 boolean ignoreNonExistent)
             throws IOException,
IPFSException

Removes a block based on the given CID See block/rm

Parameters:

CID - the CID of the block to remove

Throws:

IOException - is thrown if an error with the Response occurs

IPFSException