net.maidsafe.api

Class IData

java.lang.Object

net.maidsafe.api.IData

public class IData
extends java.lang.Object

Exposes API for Immutable Data operations

Constructor Summary

Constructors

Constructor and Description
IData(net.maidsafe.api.AppHandle appHandle) Initialises a new instance of the IData class

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<byte[]>	close(NativeHandle writerHandle, NativeHandle cipherOptHandle) Closes the self encryptor and write the Immutable Data to the network
java.util.concurrent.CompletableFuture<NativeHandle>	getReader(byte[] address) Get self encryptor reader for existent data on the network
java.util.concurrent.CompletableFuture<java.lang.Long>	getSerialisedSize(byte[] address) Deprecated. This method will be removed
java.util.concurrent.CompletableFuture<java.lang.Long>	getSize(NativeHandle readerHandle) Get the data size from the self encryptor
java.util.concurrent.CompletableFuture<NativeHandle>	getWriter() Initialises a new self encryptor writer handle
java.util.concurrent.CompletableFuture<byte[]>	read(NativeHandle readerHandle, long position, long length) Read data from the self encryptor
java.util.concurrent.CompletableFuture<java.lang.Void>	write(NativeHandle writerHandle, byte[] data) Write data to the self encryptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

IData

public IData(net.maidsafe.api.AppHandle appHandle)

Initialises a new instance of the IData class

Parameters:

appHandle - App handle

Method Detail

getWriter

public java.util.concurrent.CompletableFuture<NativeHandle> getWriter()

Initialises a new self encryptor writer handle

Returns:

New Self encryptor NativeHandle instance

write

public java.util.concurrent.CompletableFuture<java.lang.Void> write(NativeHandle writerHandle,
                                                                    byte[] data)

Write data to the self encryptor. Data will be written to the network once the close is invoked.

Parameters:

writerHandle - Self encryptor handle as NativeHandle

data - Data to be self encrypted

close

public java.util.concurrent.CompletableFuture<byte[]> close(NativeHandle writerHandle,
                                                            NativeHandle cipherOptHandle)

Closes the self encryptor and write the Immutable Data to the network

Parameters:

writerHandle - Self encryptor handle as NativeHandle

cipherOptHandle - Cipher options as NativeHandle

Returns:

Address of the Immutable Data as byte array

getReader

public java.util.concurrent.CompletableFuture<NativeHandle> getReader(byte[] address)

Get self encryptor reader for existent data on the network

Parameters:

address - Address of the data as byte array

Returns:

New Self encryptor NativeHandle

read

public java.util.concurrent.CompletableFuture<byte[]> read(NativeHandle readerHandle,
                                                           long position,
                                                           long length)

Read data from the self encryptor

Parameters:

readerHandle - Self encryptor reader as NativeHandle

position - Position from which data is to be read

length - Length of the data to be read

Returns:

Data as byte array

getSize

public java.util.concurrent.CompletableFuture<java.lang.Long> getSize(NativeHandle readerHandle)

Get the data size from the self encryptor

Parameters:

readerHandle - Self encryptor reader as NativeHandle

Returns:

Size of the data

getSerialisedSize

@Deprecated
public java.util.concurrent.CompletableFuture<java.lang.Long> getSerialisedSize(byte[] address)

Deprecated. This method will be removed

Get size of the serialised Immutable Data

Parameters:

address - Address of the Immutable Data

Returns:

Size of the serialised Immutable Data