org.csource.fastdfs

Class StorageClient

java.lang.Object

org.csource.fastdfs.StorageClient

Direct Known Subclasses:

StorageClient1

public class StorageClient
extends Object

Storage client for 2 fields file id: group name and filename

Version:

Version 1.24

Author:

Happy Fish / YuQing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StorageClient.UploadBuff Upload file by file buff

Field Summary

Fields

Modifier and Type	Field and Description
static Base64	base64
protected byte	errno
protected StorageServer	storageServer
protected TrackerServer	trackerServer

Constructor Summary

Constructors

Constructor and Description
StorageClient() constructor using global settings in class ClientGlobal
StorageClient(TrackerServer trackerServer, StorageServer storageServer) constructor with tracker server and storage server

Method Summary

Modifier and Type	Method and Description
int	append_file(String group_name, String appender_filename, byte[] file_buff) append file to storage server (by file buff)
int	append_file(String group_name, String appender_filename, byte[] file_buff, int offset, int length) append file to storage server (by file buff)
int	append_file(String group_name, String appender_filename, long file_size, UploadCallback callback) append file to storage server (by callback)
int	append_file(String group_name, String appender_filename, String local_filename) append file to storage server (by file name)
int	delete_file(String group_name, String remote_filename) delete file from storage server
protected int	do_append_file(String group_name, String appender_filename, long file_size, UploadCallback callback) append file to storage server
protected int	do_modify_file(String group_name, String appender_filename, long file_offset, long modify_size, UploadCallback callback) modify appender file to storage server
protected String[]	do_upload_file(byte cmd, String group_name, String master_filename, String prefix_name, String file_ext_name, long file_size, UploadCallback callback, NameValuePair[] meta_list) upload file to storage server
byte[]	download_file(String group_name, String remote_filename) download file from storage server
int	download_file(String group_name, String remote_filename, DownloadCallback callback) download file from storage server
byte[]	download_file(String group_name, String remote_filename, long file_offset, long download_bytes) download file from storage server
int	download_file(String group_name, String remote_filename, long file_offset, long download_bytes, DownloadCallback callback) download file from storage server
int	download_file(String group_name, String remote_filename, long file_offset, long download_bytes, String local_filename) download file from storage server
int	download_file(String group_name, String remote_filename, String local_filename) download file from storage server
FileInfo	get_file_info(String group_name, String remote_filename) get file info decoded from the filename, fetch from the storage if necessary
NameValuePair[]	get_metadata(String group_name, String remote_filename) get all metadata items from storage server
byte	getErrorCode() get the error code of last call
int	modify_file(String group_name, String appender_filename, long file_offset, byte[] file_buff) modify appender file to storage server (by file buff)
int	modify_file(String group_name, String appender_filename, long file_offset, byte[] file_buff, int buffer_offset, int buffer_length) modify appender file to storage server (by file buff)
int	modify_file(String group_name, String appender_filename, long file_offset, long modify_size, UploadCallback callback) modify appender file to storage server (by callback)
int	modify_file(String group_name, String appender_filename, long file_offset, String local_filename) modify appender file to storage server (by file name)
protected boolean	newReadableStorageConnection(String group_name, String remote_filename) check storage socket, if null create a new connection
protected boolean	newUpdatableStorageConnection(String group_name, String remote_filename) check storage socket, if null create a new connection
protected boolean	newWritableStorageConnection(String group_name) check storage socket, if null create a new connection
FileInfo	query_file_info(String group_name, String remote_filename) get file info from storage server
protected void	send_download_package(String group_name, String remote_filename, long file_offset, long download_bytes) send package to storage server
protected void	send_package(byte cmd, String group_name, String remote_filename) send package to storage server
int	set_metadata(String group_name, String remote_filename, NameValuePair[] meta_list, byte op_flag) set metadata items to storage server
int	truncate_file(String group_name, String appender_filename) truncate appender file to size 0 from storage server
int	truncate_file(String group_name, String appender_filename, long truncated_file_size) truncate appender file from storage server
String[]	upload_appender_file(byte[] file_buff, int offset, int length, String file_ext_name, NameValuePair[] meta_list) upload appender file to storage server (by file buff)
String[]	upload_appender_file(byte[] file_buff, String file_ext_name, NameValuePair[] meta_list) upload appender file to storage server (by file buff)
String[]	upload_appender_file(String group_name, byte[] file_buff, int offset, int length, String file_ext_name, NameValuePair[] meta_list) upload appender file to storage server (by file buff)
String[]	upload_appender_file(String group_name, byte[] file_buff, String file_ext_name, NameValuePair[] meta_list) upload appender file to storage server (by file buff)
String[]	upload_appender_file(String group_name, long file_size, UploadCallback callback, String file_ext_name, NameValuePair[] meta_list) upload appender file to storage server (by callback)
String[]	upload_appender_file(String local_filename, String file_ext_name, NameValuePair[] meta_list) upload appender file to storage server (by file name)
protected String[]	upload_appender_file(String group_name, String local_filename, String file_ext_name, NameValuePair[] meta_list) upload appender file to storage server (by file name)
String[]	upload_file(byte[] file_buff, int offset, int length, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file buff)
String[]	upload_file(byte[] file_buff, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file buff)
protected String[]	upload_file(byte cmd, String group_name, String local_filename, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file name)
String[]	upload_file(String group_name, byte[] file_buff, int offset, int length, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file buff)
String[]	upload_file(String group_name, byte[] file_buff, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file buff)
String[]	upload_file(String group_name, long file_size, UploadCallback callback, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by callback)
String[]	upload_file(String local_filename, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file name)
String[]	upload_file(String group_name, String master_filename, String prefix_name, byte[] file_buff, int offset, int length, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file buff, slave file mode)
String[]	upload_file(String group_name, String master_filename, String prefix_name, byte[] file_buff, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file buff, slave file mode)
String[]	upload_file(String group_name, String master_filename, String prefix_name, long file_size, UploadCallback callback, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by callback, slave file mode)
protected String[]	upload_file(String group_name, String local_filename, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file name)
String[]	upload_file(String group_name, String master_filename, String prefix_name, String local_filename, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file name, slave file mode)

Methods inherited from class java.lang.Object

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

Field Detail

base64

public static final Base64 base64

trackerServer

protected TrackerServer trackerServer

storageServer

protected StorageServer storageServer

errno

protected byte errno

Constructor Detail

StorageClient

public StorageClient()

constructor using global settings in class ClientGlobal

StorageClient

public StorageClient(TrackerServer trackerServer,
                     StorageServer storageServer)

constructor with tracker server and storage server

Parameters:

trackerServer - the tracker server, can be null

storageServer - the storage server, can be null

Method Detail

getErrorCode

public byte getErrorCode()

get the error code of last call

Returns:

the error code of last call

upload_file

public String[] upload_file(String local_filename,
                            String file_ext_name,
                            NameValuePair[] meta_list)
                     throws IOException,
                            FsException

upload file to storage server (by file name)

Parameters:

local_filename - local filename to upload

file_ext_name - file ext name, do not include dot(.), null to extract ext name from the local filename

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_file

protected String[] upload_file(String group_name,
                               String local_filename,
                               String file_ext_name,
                               NameValuePair[] meta_list)
                        throws IOException,
                               FsException

upload file to storage server (by file name)

Parameters:

group_name - the group name to upload file to, can be empty

local_filename - local filename to upload

file_ext_name - file ext name, do not include dot(.), null to extract ext name from the local filename

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_file

protected String[] upload_file(byte cmd,
                               String group_name,
                               String local_filename,
                               String file_ext_name,
                               NameValuePair[] meta_list)
                        throws IOException,
                               FsException

upload file to storage server (by file name)

Parameters:

cmd - the command

group_name - the group name to upload file to, can be empty

local_filename - local filename to upload

file_ext_name - file ext name, do not include dot(.), null to extract ext name from the local filename

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_file

public String[] upload_file(byte[] file_buff,
                            int offset,
                            int length,
                            String file_ext_name,
                            NameValuePair[] meta_list)
                     throws IOException,
                            FsException

upload file to storage server (by file buff)

Parameters:

file_buff - file content/buff

offset - start offset of the buff

length - the length of buff to upload

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_file

public String[] upload_file(String group_name,
                            byte[] file_buff,
                            int offset,
                            int length,
                            String file_ext_name,
                            NameValuePair[] meta_list)
                     throws IOException,
                            FsException

upload file to storage server (by file buff)

Parameters:

group_name - the group name to upload file to, can be empty

file_buff - file content/buff

offset - start offset of the buff

length - the length of buff to upload

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_file

public String[] upload_file(byte[] file_buff,
                            String file_ext_name,
                            NameValuePair[] meta_list)
                     throws IOException,
                            FsException

upload file to storage server (by file buff)

Parameters:

file_buff - file content/buff

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_file

public String[] upload_file(String group_name,
                            byte[] file_buff,
                            String file_ext_name,
                            NameValuePair[] meta_list)
                     throws IOException,
                            FsException

upload file to storage server (by file buff)

Parameters:

group_name - the group name to upload file to, can be empty

file_buff - file content/buff

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_file

public String[] upload_file(String group_name,
                            long file_size,
                            UploadCallback callback,
                            String file_ext_name,
                            NameValuePair[] meta_list)
                     throws IOException,
                            FsException

upload file to storage server (by callback)

Parameters:

group_name - the group name to upload file to, can be empty

file_size - the file size

callback - the write data callback object

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_file

public String[] upload_file(String group_name,
                            String master_filename,
                            String prefix_name,
                            String local_filename,
                            String file_ext_name,
                            NameValuePair[] meta_list)
                     throws IOException,
                            FsException

upload file to storage server (by file name, slave file mode)

Parameters:

group_name - the group name of master file

master_filename - the master file name to generate the slave file

prefix_name - the prefix name to generate the slave file

local_filename - local filename to upload

file_ext_name - file ext name, do not include dot(.), null to extract ext name from the local filename

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_file

public String[] upload_file(String group_name,
                            String master_filename,
                            String prefix_name,
                            byte[] file_buff,
                            String file_ext_name,
                            NameValuePair[] meta_list)
                     throws IOException,
                            FsException

upload file to storage server (by file buff, slave file mode)

Parameters:

group_name - the group name of master file

master_filename - the master file name to generate the slave file

prefix_name - the prefix name to generate the slave file

file_buff - file content/buff

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_file

public String[] upload_file(String group_name,
                            String master_filename,
                            String prefix_name,
                            byte[] file_buff,
                            int offset,
                            int length,
                            String file_ext_name,
                            NameValuePair[] meta_list)
                     throws IOException,
                            FsException

upload file to storage server (by file buff, slave file mode)

Parameters:

group_name - the group name of master file

master_filename - the master file name to generate the slave file

prefix_name - the prefix name to generate the slave file

file_buff - file content/buff

offset - start offset of the buff

length - the length of buff to upload

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_file

public String[] upload_file(String group_name,
                            String master_filename,
                            String prefix_name,
                            long file_size,
                            UploadCallback callback,
                            String file_ext_name,
                            NameValuePair[] meta_list)
                     throws IOException,
                            FsException

upload file to storage server (by callback, slave file mode)

Parameters:

group_name - the group name to upload file to, can be empty

master_filename - the master file name to generate the slave file

prefix_name - the prefix name to generate the slave file

file_size - the file size

callback - the write data callback object

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_appender_file

public String[] upload_appender_file(String local_filename,
                                     String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws IOException,
                                     FsException

upload appender file to storage server (by file name)

Parameters:

local_filename - local filename to upload

file_ext_name - file ext name, do not include dot(.), null to extract ext name from the local filename

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_appender_file

protected String[] upload_appender_file(String group_name,
                                        String local_filename,
                                        String file_ext_name,
                                        NameValuePair[] meta_list)
                                 throws IOException,
                                        FsException

upload appender file to storage server (by file name)

Parameters:

group_name - the group name to upload file to, can be empty

local_filename - local filename to upload

file_ext_name - file ext name, do not include dot(.), null to extract ext name from the local filename

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_appender_file

public String[] upload_appender_file(byte[] file_buff,
                                     int offset,
                                     int length,
                                     String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws IOException,
                                     FsException

upload appender file to storage server (by file buff)

Parameters:

file_buff - file content/buff

offset - start offset of the buff

length - the length of buff to upload

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_appender_file

public String[] upload_appender_file(String group_name,
                                     byte[] file_buff,
                                     int offset,
                                     int length,
                                     String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws IOException,
                                     FsException

upload appender file to storage server (by file buff)

Parameters:

group_name - the group name to upload file to, can be empty

file_buff - file content/buff

offset - start offset of the buff

length - the length of buff to upload

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_appender_file

public String[] upload_appender_file(byte[] file_buff,
                                     String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws IOException,
                                     FsException

upload appender file to storage server (by file buff)

Parameters:

file_buff - file content/buff

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_appender_file

public String[] upload_appender_file(String group_name,
                                     byte[] file_buff,
                                     String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws IOException,
                                     FsException

upload appender file to storage server (by file buff)

Parameters:

group_name - the group name to upload file to, can be empty

file_buff - file content/buff

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

upload_appender_file

public String[] upload_appender_file(String group_name,
                                     long file_size,
                                     UploadCallback callback,
                                     String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws IOException,
                                     FsException

upload appender file to storage server (by callback)

Parameters:

group_name - the group name to upload file to, can be empty

file_size - the file size

callback - the write data callback object

file_ext_name - file ext name, do not include dot(.)

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

append_file

public int append_file(String group_name,
                       String appender_filename,
                       String local_filename)
                throws IOException,
                       FsException

append file to storage server (by file name)

Parameters:

group_name - the group name of appender file

appender_filename - the appender filename

local_filename - local filename to append

Returns:

0 for success, != 0 for error (error no)

Throws:

IOException

FsException

append_file

public int append_file(String group_name,
                       String appender_filename,
                       byte[] file_buff)
                throws IOException,
                       FsException

append file to storage server (by file buff)

Parameters:

group_name - the group name of appender file

appender_filename - the appender filename

file_buff - file content/buff

Returns:

0 for success, != 0 for error (error no)

Throws:

IOException

FsException

append_file

public int append_file(String group_name,
                       String appender_filename,
                       byte[] file_buff,
                       int offset,
                       int length)
                throws IOException,
                       FsException

append file to storage server (by file buff)

Parameters:

group_name - the group name of appender file

appender_filename - the appender filename

file_buff - file content/buff

offset - start offset of the buff

length - the length of buff to append

Returns:

0 for success, != 0 for error (error no)

Throws:

IOException

FsException

append_file

public int append_file(String group_name,
                       String appender_filename,
                       long file_size,
                       UploadCallback callback)
                throws IOException,
                       FsException

append file to storage server (by callback)

Parameters:

group_name - the group name to append file to

appender_filename - the appender filename

file_size - the file size

callback - the write data callback object

Returns:

0 for success, != 0 for error (error no)

Throws:

IOException

FsException

modify_file

public int modify_file(String group_name,
                       String appender_filename,
                       long file_offset,
                       String local_filename)
                throws IOException,
                       FsException

modify appender file to storage server (by file name)

Parameters:

group_name - the group name of appender file

appender_filename - the appender filename

file_offset - the offset of appender file

local_filename - local filename to append

Returns:

0 for success, != 0 for error (error no)

Throws:

IOException

FsException

modify_file

public int modify_file(String group_name,
                       String appender_filename,
                       long file_offset,
                       byte[] file_buff)
                throws IOException,
                       FsException

modify appender file to storage server (by file buff)

Parameters:

group_name - the group name of appender file

appender_filename - the appender filename

file_offset - the offset of appender file

file_buff - file content/buff

Returns:

0 for success, != 0 for error (error no)

Throws:

IOException

FsException

modify_file

public int modify_file(String group_name,
                       String appender_filename,
                       long file_offset,
                       byte[] file_buff,
                       int buffer_offset,
                       int buffer_length)
                throws IOException,
                       FsException

modify appender file to storage server (by file buff)

Parameters:

group_name - the group name of appender file

appender_filename - the appender filename

file_offset - the offset of appender file

file_buff - file content/buff

buffer_offset - start offset of the buff

buffer_length - the length of buff to modify

Returns:

0 for success, != 0 for error (error no)

Throws:

IOException

FsException

modify_file

public int modify_file(String group_name,
                       String appender_filename,
                       long file_offset,
                       long modify_size,
                       UploadCallback callback)
                throws IOException,
                       FsException

modify appender file to storage server (by callback)

Parameters:

group_name - the group name to modify file to

appender_filename - the appender filename

file_offset - the offset of appender file

modify_size - the modify size

callback - the write data callback object

Returns:

0 for success, != 0 for error (error no)

Throws:

IOException

FsException

do_upload_file

protected String[] do_upload_file(byte cmd,
                                  String group_name,
                                  String master_filename,
                                  String prefix_name,
                                  String file_ext_name,
                                  long file_size,
                                  UploadCallback callback,
                                  NameValuePair[] meta_list)
                           throws IOException,
                                  FsException

upload file to storage server

Parameters:

cmd - the command code

group_name - the group name to upload file to, can be empty

master_filename - the master file name to generate the slave file

prefix_name - the prefix name to generate the slave file

file_ext_name - file ext name, do not include dot(.)

file_size - the file size

callback - the write data callback object

meta_list - meta info array

Returns:

2 elements string array if success:

• results[0]: the group name to store the file

• results[1]: the new created filename

return null if fail

Throws:

IOException

FsException

do_append_file

protected int do_append_file(String group_name,
                             String appender_filename,
                             long file_size,
                             UploadCallback callback)
                      throws IOException,
                             FsException

append file to storage server

Parameters:

group_name - the group name of appender file

appender_filename - the appender filename

file_size - the file size

callback - the write data callback object

Returns:

return true for success, false for fail

Throws:

IOException

FsException

do_modify_file

protected int do_modify_file(String group_name,
                             String appender_filename,
                             long file_offset,
                             long modify_size,
                             UploadCallback callback)
                      throws IOException,
                             FsException

modify appender file to storage server

Parameters:

group_name - the group name of appender file

appender_filename - the appender filename

file_offset - the offset of appender file

modify_size - the modify size

callback - the write data callback object

Returns:

return true for success, false for fail

Throws:

IOException

FsException

delete_file

public int delete_file(String group_name,
                       String remote_filename)
                throws IOException,
                       FsException

delete file from storage server

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

Returns:

0 for success, none zero for fail (error code)

Throws:

IOException

FsException

truncate_file

public int truncate_file(String group_name,
                         String appender_filename)
                  throws IOException,
                         FsException

truncate appender file to size 0 from storage server

Parameters:

group_name - the group name of storage server

appender_filename - the appender filename

Returns:

0 for success, none zero for fail (error code)

Throws:

IOException

FsException

truncate_file

public int truncate_file(String group_name,
                         String appender_filename,
                         long truncated_file_size)
                  throws IOException,
                         FsException

truncate appender file from storage server

Parameters:

group_name - the group name of storage server

appender_filename - the appender filename

truncated_file_size - truncated file size

Returns:

0 for success, none zero for fail (error code)

Throws:

IOException

FsException

download_file

public byte[] download_file(String group_name,
                            String remote_filename)
                     throws IOException,
                            FsException

download file from storage server

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

Returns:

file content/buff, return null if fail

Throws:

IOException

FsException

download_file

public byte[] download_file(String group_name,
                            String remote_filename,
                            long file_offset,
                            long download_bytes)
                     throws IOException,
                            FsException

download file from storage server

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

file_offset - the start offset of the file

download_bytes - download bytes, 0 for remain bytes from offset

Returns:

file content/buff, return null if fail

Throws:

IOException

FsException

download_file

public int download_file(String group_name,
                         String remote_filename,
                         String local_filename)
                  throws IOException,
                         FsException

download file from storage server

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

local_filename - filename on local

Returns:

0 success, return none zero errno if fail

Throws:

IOException

FsException

download_file

public int download_file(String group_name,
                         String remote_filename,
                         long file_offset,
                         long download_bytes,
                         String local_filename)
                  throws IOException,
                         FsException

download file from storage server

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

file_offset - the start offset of the file

download_bytes - download bytes, 0 for remain bytes from offset

local_filename - filename on local

Returns:

0 success, return none zero errno if fail

Throws:

IOException

FsException

download_file

public int download_file(String group_name,
                         String remote_filename,
                         DownloadCallback callback)
                  throws IOException,
                         FsException

download file from storage server

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

callback - call callback.recv() when data arrive

Returns:

0 success, return none zero errno if fail

Throws:

IOException

FsException

download_file

public int download_file(String group_name,
                         String remote_filename,
                         long file_offset,
                         long download_bytes,
                         DownloadCallback callback)
                  throws IOException,
                         FsException

download file from storage server

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

file_offset - the start offset of the file

download_bytes - download bytes, 0 for remain bytes from offset

callback - call callback.recv() when data arrive

Returns:

0 success, return none zero errno if fail

Throws:

IOException

FsException

get_metadata

public NameValuePair[] get_metadata(String group_name,
                                    String remote_filename)
                             throws IOException,
                                    FsException

get all metadata items from storage server

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

Returns:

meta info array, return null if fail

Throws:

IOException

FsException

set_metadata

public int set_metadata(String group_name,
                        String remote_filename,
                        NameValuePair[] meta_list,
                        byte op_flag)
                 throws IOException,
                        FsException

set metadata items to storage server

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

meta_list - meta item array

op_flag - flag, can be one of following values:

• ProtoCommon.STORAGE_SET_METADATA_FLAG_OVERWRITE: overwrite all old metadata items

• ProtoCommon.STORAGE_SET_METADATA_FLAG_MERGE: merge, insert when the metadata item not exist, otherwise update it

Returns:

0 for success, !=0 fail (error code)

Throws:

IOException

FsException

get_file_info

public FileInfo get_file_info(String group_name,
                              String remote_filename)
                       throws IOException,
                              FsException

get file info decoded from the filename, fetch from the storage if necessary

Parameters:

group_name - the group name

remote_filename - the filename

Returns:

FileInfo object for success, return null for fail

Throws:

IOException

FsException

query_file_info

public FileInfo query_file_info(String group_name,
                                String remote_filename)
                         throws IOException,
                                FsException

get file info from storage server

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

Returns:

FileInfo object for success, return null for fail

Throws:

IOException

FsException

newWritableStorageConnection

protected boolean newWritableStorageConnection(String group_name)
                                        throws IOException,
                                               FsException

check storage socket, if null create a new connection

Parameters:

group_name - the group name to upload file to, can be empty

Returns:

true if create a new connection

Throws:

IOException

FsException

newReadableStorageConnection

protected boolean newReadableStorageConnection(String group_name,
                                               String remote_filename)
                                        throws IOException,
                                               FsException

check storage socket, if null create a new connection

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

Returns:

true if create a new connection

Throws:

IOException

FsException

newUpdatableStorageConnection

protected boolean newUpdatableStorageConnection(String group_name,
                                                String remote_filename)
                                         throws IOException,
                                                FsException

check storage socket, if null create a new connection

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

Returns:

true if create a new connection

Throws:

IOException

FsException

send_package

protected void send_package(byte cmd,
                            String group_name,
                            String remote_filename)
                     throws IOException

send package to storage server

Parameters:

cmd - which command to send

group_name - the group name of storage server

remote_filename - filename on storage server

Throws:

IOException

send_download_package

protected void send_download_package(String group_name,
                                     String remote_filename,
                                     long file_offset,
                                     long download_bytes)
                              throws IOException

send package to storage server

Parameters:

group_name - the group name of storage server

remote_filename - filename on storage server

file_offset - the start offset of the file

download_bytes - download bytes

Throws:

IOException