net.maidsafe.api

Class MData

java.lang.Object

net.maidsafe.api.MData

public final class MData
extends java.lang.Object

Exposes API for Mutable Data operations

Constructor Summary

Constructors

Constructor and Description
MData(net.maidsafe.api.AppHandle appHandle)

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<byte[]>	decrypt(MDataInfo mDataInfo, byte[] value) Decrypts an MData entry key/value
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteUserPermission(NativeHandle publicSignKey, MDataInfo mDataInfo, long version) Deletes the permissions given to a particular user
java.util.concurrent.CompletableFuture<MDataInfo>	deserialise(byte[] serialisedMData) Deserialises Mutable Data info
java.util.concurrent.CompletableFuture<byte[]>	encodeMetadata(MetadataResponse metadataResponse) Serialises metadata of the Mutable data
java.util.concurrent.CompletableFuture<byte[]>	encryptEntryKey(MDataInfo mDataInfo, byte[] key) Encrypts an MData entry key
java.util.concurrent.CompletableFuture<byte[]>	encryptEntryValue(MDataInfo mDataInfo, byte[] value) Encrypts MData entry value
java.util.concurrent.CompletableFuture<NativeHandle>	getEntriesHandle(MDataInfo mDataInfo) Gets Mutable Data entries handle
java.util.concurrent.CompletableFuture<java.util.List<MDataKey>>	getKeys(MDataInfo mDataInfo) Retrieves the list of keys in the Mutable Data
java.util.concurrent.CompletableFuture<NativeHandle>	getPermission(MDataInfo mDataInfo) Fetches the permissions handle for the Mutable Data
java.util.concurrent.CompletableFuture<PermissionSet>	getPermissionForUser(NativeHandle publicSignKey, MDataInfo mDataInfo) Gets the permissions given for the user
java.util.concurrent.CompletableFuture<MDataInfo>	getPrivateMData(byte[] name, long typeTag, byte[] secretKey, byte[] nonce) Creates a new Mutable data with the defined name and type tag
java.util.concurrent.CompletableFuture<MDataInfo>	getRandomPrivateMData(long typeTag) Generates private Mutable Data at a random XOR address
java.util.concurrent.CompletableFuture<MDataInfo>	getRandomPublicMData(long typeTag) Generates public Mutable Data at a random XOR address
java.util.concurrent.CompletableFuture<java.lang.Long>	getSerialisedSize(MDataInfo mDataInfo) Returns the size of the serialised Mutable Data info
java.util.concurrent.CompletableFuture<MDataValue>	getValue(MDataInfo mDataInfo, byte[] key) Returns the value for the entry for the given key
java.util.concurrent.CompletableFuture<java.util.List<MDataValue>>	getValues(MDataInfo mDataInfo) Retrieves the list of values in the Mutable data
java.util.concurrent.CompletableFuture<java.lang.Long>	getVersion(MDataInfo mDataInfo) Returns the version of the Mutable Data shell
java.util.concurrent.CompletableFuture<java.lang.Void>	mutateEntries(MDataInfo mDataInfo, NativeHandle actionHandle) Mutates the existing Mutable Data on the network
java.util.concurrent.CompletableFuture<java.lang.Void>	put(MDataInfo mDataInfo, NativeHandle permissionHandle, NativeHandle entriesHandle) Commit the Mutable data on the network
java.util.concurrent.CompletableFuture<byte[]>	serialise(MDataInfo mDataInfo) Serialises the Mutable data info as byte array
java.util.concurrent.CompletableFuture<java.lang.Void>	setUserPermission(NativeHandle publicSignKey, MDataInfo mDataInfo, PermissionSet permissionSet, long version) Sets the permissions for a user

Methods inherited from class java.lang.Object

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

Constructor Detail

MData

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

Method Detail

getPrivateMData

public java.util.concurrent.CompletableFuture<MDataInfo> getPrivateMData(byte[] name,
                                                                         long typeTag,
                                                                         byte[] secretKey,
                                                                         byte[] nonce)

Creates a new Mutable data with the defined name and type tag

Parameters:

name - Name(address) of the Mutable Data

typeTag - Mutable data type tag

secretKey - Secret key of the MData owner

nonce - A unique nonce

Returns:

Mutable data info as MDataInfo

getRandomPrivateMData

public java.util.concurrent.CompletableFuture<MDataInfo> getRandomPrivateMData(long typeTag)

Generates private Mutable Data at a random XOR address

Parameters:

typeTag - MData type tag

Returns:

New MDataInfo instance

getRandomPublicMData

public java.util.concurrent.CompletableFuture<MDataInfo> getRandomPublicMData(long typeTag)

Generates public Mutable Data at a random XOR address

Parameters:

typeTag - MData type tag

Returns:

New MDataInfo instance

encryptEntryKey

public java.util.concurrent.CompletableFuture<byte[]> encryptEntryKey(MDataInfo mDataInfo,
                                                                      byte[] key)

Encrypts an MData entry key

Parameters:

mDataInfo - Mutable data info as MDataInfo

key - Key to be encrypted as byte array

Returns:

Encrypted key as byte array

encryptEntryValue

public java.util.concurrent.CompletableFuture<byte[]> encryptEntryValue(MDataInfo mDataInfo,
                                                                        byte[] value)

Encrypts MData entry value

Parameters:

mDataInfo - Mutable data info as MDataInfo

value - Value to be encrypted as byte array

Returns:

Encrypted value as byte array

decrypt

public java.util.concurrent.CompletableFuture<byte[]> decrypt(MDataInfo mDataInfo,
                                                              byte[] value)

Decrypts an MData entry key/value

Parameters:

mDataInfo - Mutable data info as MDataInfo

value - Encrypted key/value

Returns:

Decrypted key/value as byte array

serialise

public java.util.concurrent.CompletableFuture<byte[]> serialise(MDataInfo mDataInfo)

Serialises the Mutable data info as byte array

Parameters:

mDataInfo - Mutable data info as MDataInfo

Returns:

Serialised MDataInfo as byte array

deserialise

public java.util.concurrent.CompletableFuture<MDataInfo> deserialise(byte[] serialisedMData)

Deserialises Mutable Data info

Parameters:

serialisedMData - Serialised mDataInfo

Returns:

New MDataInfo instance

put

public java.util.concurrent.CompletableFuture<java.lang.Void> put(MDataInfo mDataInfo,
                                                                  NativeHandle permissionHandle,
                                                                  NativeHandle entriesHandle)

Commit the Mutable data on the network

Parameters:

mDataInfo - Mutable data info as MDataInfo

permissionHandle - Permission handle as NativeHandle. To commit the data without permissions use Constants.MD_PERMISSION_EMPTY

entriesHandle - Entries handle as NativeHandle. To commit the data without entries use Constants.MD_ENTRIES_EMPTY

getVersion

public java.util.concurrent.CompletableFuture<java.lang.Long> getVersion(MDataInfo mDataInfo)

Returns the version of the Mutable Data shell

Parameters:

mDataInfo - Mutable data info as MDataInfo

Returns:

The version of the Mutable Data shell

getSerialisedSize

public java.util.concurrent.CompletableFuture<java.lang.Long> getSerialisedSize(MDataInfo mDataInfo)

Returns the size of the serialised Mutable Data info

Parameters:

mDataInfo - Mutable data info as MDataInfo

Returns:

Serialised size of the mDataInfo

getValue

public java.util.concurrent.CompletableFuture<MDataValue> getValue(MDataInfo mDataInfo,
                                                                   byte[] key)

Returns the value for the entry for the given key

Parameters:

mDataInfo - Mutable data info as MDataInfo

key - Key of the Mutable Data entry

Returns:

Value of the Mutable Data as MDataValue

getEntriesHandle

public java.util.concurrent.CompletableFuture<NativeHandle> getEntriesHandle(MDataInfo mDataInfo)

Gets Mutable Data entries handle

Parameters:

mDataInfo - Mutable data info as MDataInfo

Returns:

New Mutable Data Entries NativeHandle instance

getKeys

public java.util.concurrent.CompletableFuture<java.util.List<MDataKey>> getKeys(MDataInfo mDataInfo)

Retrieves the list of keys in the Mutable Data

Parameters:

mDataInfo - Mutable Data info as MDataInfo

Returns:

List of keys in the Mutable Data as List<MDataKey>

getValues

public java.util.concurrent.CompletableFuture<java.util.List<MDataValue>> getValues(MDataInfo mDataInfo)

Retrieves the list of values in the Mutable data

Parameters:

mDataInfo - Mutable data info as MDataInfo

Returns:

List of values in the Mutable Data as List<MDataValue>

mutateEntries

public java.util.concurrent.CompletableFuture<java.lang.Void> mutateEntries(MDataInfo mDataInfo,
                                                                            NativeHandle actionHandle)

Mutates the existing Mutable Data on the network

Parameters:

mDataInfo - Mutable Data info as MDataInfo

actionHandle - Mutable Data actions handle

getPermission

public java.util.concurrent.CompletableFuture<NativeHandle> getPermission(MDataInfo mDataInfo)

Fetches the permissions handle for the Mutable Data

Parameters:

mDataInfo - Mutable Data info as MDataInfo

Returns:

New Permissions NativeHandle instance

getPermissionForUser

public java.util.concurrent.CompletableFuture<PermissionSet> getPermissionForUser(NativeHandle publicSignKey,
                                                                                  MDataInfo mDataInfo)

Gets the permissions given for the user

Parameters:

publicSignKey - Public sign key of the user

mDataInfo - Mutable data info as MDataInfo

Returns:

New PermissionSet instance

setUserPermission

public java.util.concurrent.CompletableFuture<java.lang.Void> setUserPermission(NativeHandle publicSignKey,
                                                                                MDataInfo mDataInfo,
                                                                                PermissionSet permissionSet,
                                                                                long version)

Sets the permissions for a user

Parameters:

publicSignKey - Public sign key of the user as NativeHandle

mDataInfo - Mutable data info as MDataInfo

permissionSet - PermissionSet for the user

version - The next version of the Mutable Data shell

deleteUserPermission

public java.util.concurrent.CompletableFuture<java.lang.Void> deleteUserPermission(NativeHandle publicSignKey,
                                                                                   MDataInfo mDataInfo,
                                                                                   long version)

Deletes the permissions given to a particular user

Parameters:

publicSignKey - Public sign key of the user as NativeHandle

mDataInfo - Mutable data info as MDataInfo

version - The next version of the Mutable Data shell

encodeMetadata

public java.util.concurrent.CompletableFuture<byte[]> encodeMetadata(MetadataResponse metadataResponse)

Serialises metadata of the Mutable data

Parameters:

metadataResponse - Metadata of the Mutable data as MetadataResponse

Returns:

Serialised metadata of the Mutable Data as byte array