net.maidsafe.api

Class NFS

java.lang.Object

net.maidsafe.api.NFS

public class NFS
extends java.lang.Object

Network File System emulation API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NFS.OpenMode The different modes of opening a file in NFS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<java.lang.Long>	deleteFile(MDataInfo parentInfo, java.lang.String fileName, long version) Deletes a file that exists on the network
java.util.concurrent.CompletableFuture<File>	fileClose(NativeHandle fileContextHandle) Write the content to the network and close the file.
java.util.concurrent.CompletableFuture<NativeHandle>	fileOpen(MDataInfo parentInfo, File file, NFS.OpenMode openMode) Open a file for reading or writing
java.util.concurrent.CompletableFuture<byte[]>	fileRead(NativeHandle fileContextHandle, long position, long length) Read the data from a file
java.util.concurrent.CompletableFuture	fileWrite(NativeHandle fileContextHandle, byte[] data) Write data to a file
java.util.concurrent.CompletableFuture<NFSFileMetadata>	getFileMetadata(MDataInfo parentInfo, java.lang.String fileName) Get the metadata for the requested file
java.util.concurrent.CompletableFuture<java.lang.Long>	getSize(NativeHandle fileContextHandle) Get the size of a file that has been opened
java.util.concurrent.CompletableFuture	insertFile(MDataInfo parentInfo, java.lang.String fileName, File file) Insert the file into the underlying Mutable Data.
java.util.concurrent.CompletableFuture<java.lang.Long>	updateFile(MDataInfo parentInfo, java.lang.String fileName, File file, long version) Update an existing file on the network.

Methods inherited from class java.lang.Object

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

Constructor Detail

NFS

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

Method Detail

getFileMetadata

public java.util.concurrent.CompletableFuture<NFSFileMetadata> getFileMetadata(MDataInfo parentInfo,
                                                                               java.lang.String fileName)

Get the metadata for the requested file

Parameters:

parentInfo - Parent Mutable Data info as MDataInfo

fileName - File name

Returns:

File metadata as NFSFileMetadata

insertFile

public java.util.concurrent.CompletableFuture insertFile(MDataInfo parentInfo,
                                                         java.lang.String fileName,
                                                         File file)

Insert the file into the underlying Mutable Data. Directly commit to the network.

Parameters:

parentInfo - Parent Mutable Data info

fileName - File name

file - File to be inserted

updateFile

public java.util.concurrent.CompletableFuture<java.lang.Long> updateFile(MDataInfo parentInfo,
                                                                         java.lang.String fileName,
                                                                         File file,
                                                                         long version)

Update an existing file on the network.

Parameters:

parentInfo - Parent Mutable Data info

fileName - File name

file - The updated file to be stored

version - The next version of the file

Returns:

Returns the next version of the file

deleteFile

public java.util.concurrent.CompletableFuture<java.lang.Long> deleteFile(MDataInfo parentInfo,
                                                                         java.lang.String fileName,
                                                                         long version)

Deletes a file that exists on the network

Parameters:

parentInfo - Parent Mutable Data info

fileName - File name

version - The next version of the file

Returns:

Returns the next version of the file

fileOpen

public java.util.concurrent.CompletableFuture<NativeHandle> fileOpen(MDataInfo parentInfo,
                                                                     File file,
                                                                     NFS.OpenMode openMode)

Open a file for reading or writing

Parameters:

parentInfo - Parent Mutable Data info

file - File object

openMode - File opening mode

Returns:

File handle as NativeHandle

getSize

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

Get the size of a file that has been opened

Parameters:

fileContextHandle - File handle as NativeHandle

Returns:

Size of the file

fileRead

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

Read the data from a file

Parameters:

fileContextHandle - File handle as NativeHandle

position - Start position

length - Length of the data to be read

Returns:

File content as byte array

fileWrite

public java.util.concurrent.CompletableFuture fileWrite(NativeHandle fileContextHandle,
                                                        byte[] data)

Write data to a file

Parameters:

fileContextHandle - File handle as NativeHandle

data - Data to be written

fileClose

public java.util.concurrent.CompletableFuture<File> fileClose(NativeHandle fileContextHandle)

Write the content to the network and close the file.

Parameters:

fileContextHandle - File handle as NativeHandle

Returns:

File object