org.csource.fastdfs

Class StorageClient1

java.lang.Object

org.csource.fastdfs.StorageClient

org.csource.fastdfs.StorageClient1

public class StorageClient1
extends StorageClient

Storage client for 1 field file id: combined group name and filename

Version:

Version 1.21

Author:

Happy Fish / YuQing

Nested Class Summary

Nested classes/interfaces inherited from class org.csource.fastdfs.StorageClient

StorageClient.UploadBuff

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPLIT_GROUP_NAME_AND_FILENAME_SEPERATOR

Fields inherited from class org.csource.fastdfs.StorageClient

base64, errno, storageServer, trackerServer

Constructor Summary

Constructors

Constructor and Description
StorageClient1() constructor
StorageClient1(TrackerServer trackerServer, StorageServer storageServer) constructor

Method Summary

Modifier and Type	Method and Description
int	append_file1(String appender_file_id, byte[] file_buff) append file to storage server (by file buff)
int	append_file1(String appender_file_id, byte[] file_buff, int offset, int length) append file to storage server (by file buff)
int	append_file1(String appender_file_id, long file_size, UploadCallback callback) append file to storage server (by callback)
int	append_file1(String appender_file_id, String local_filename) append file to storage server (by file name)
int	delete_file1(String file_id) delete file from storage server
byte[]	download_file1(String file_id) download file from storage server
int	download_file1(String file_id, DownloadCallback callback) download file from storage server
byte[]	download_file1(String file_id, long file_offset, long download_bytes) download file from storage server
int	download_file1(String file_id, long file_offset, long download_bytes, DownloadCallback callback) download file from storage server
int	download_file1(String file_id, long file_offset, long download_bytes, String local_filename) download file from storage server
int	download_file1(String file_id, String local_filename) download file from storage server
FileInfo	get_file_info1(String file_id) get file info decoded from filename
NameValuePair[]	get_metadata1(String file_id) get all metadata items from storage server
int	modify_file1(String appender_file_id, long file_offset, byte[] file_buff) modify appender file to storage server (by file buff)
int	modify_file1(String appender_file_id, long file_offset, byte[] file_buff, int buffer_offset, int buffer_length) modify appender file to storage server (by file buff)
int	modify_file1(String appender_file_id, long file_offset, long modify_size, UploadCallback callback) modify appender file to storage server (by callback)
int	modify_file1(String appender_file_id, long file_offset, String local_filename) modify appender file to storage server (by file name)
FileInfo	query_file_info1(String file_id) get file info from storage server
int	set_metadata1(String file_id, NameValuePair[] meta_list, byte op_flag) set metadata items to storage server
static byte	split_file_id(String file_id, String[] results)
int	truncate_file1(String appender_file_id) truncate appender file to size 0 from storage server
int	truncate_file1(String appender_file_id, long truncated_file_size) truncate appender file from storage server
String	upload_appender_file1(byte[] file_buff, String file_ext_name, NameValuePair[] meta_list) upload appender file to storage server (by file buff)
String	upload_appender_file1(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_file1(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_file1(String local_filename, String file_ext_name, NameValuePair[] meta_list) upload appender file to storage server (by file name)
String	upload_appender_file1(String group_name, String local_filename, String file_ext_name, NameValuePair[] meta_list) upload appender file to storage server (by file name)
String	upload_file1(byte[] file_buff, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file buff)
String	upload_file1(String group_name, byte[] file_buff, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file buff)
String	upload_file1(String group_name, long file_size, UploadCallback callback, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by callback)
String	upload_file1(String master_file_id, 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_file1(String master_file_id, 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_file1(String master_file_id, String prefix_name, long file_size, UploadCallback callback, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by callback)
String	upload_file1(String local_filename, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file name)
String	upload_file1(String group_name, String local_filename, String file_ext_name, NameValuePair[] meta_list) upload file to storage server (by file name)
String	upload_file1(String master_file_id, 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 org.csource.fastdfs.StorageClient

append_file, append_file, append_file, append_file, delete_file, do_append_file, do_modify_file, do_upload_file, download_file, download_file, download_file, download_file, download_file, download_file, get_file_info, get_metadata, getErrorCode, modify_file, modify_file, modify_file, modify_file, newReadableStorageConnection, newUpdatableStorageConnection, newWritableStorageConnection, query_file_info, send_download_package, send_package, set_metadata, truncate_file, truncate_file, upload_appender_file, upload_appender_file, upload_appender_file, upload_appender_file, upload_appender_file, upload_appender_file, upload_appender_file, upload_file, upload_file, upload_file, upload_file, upload_file, upload_file, upload_file, upload_file, upload_file, upload_file, upload_file, upload_file

Methods inherited from class java.lang.Object

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

Field Detail

SPLIT_GROUP_NAME_AND_FILENAME_SEPERATOR

public static final String SPLIT_GROUP_NAME_AND_FILENAME_SEPERATOR

See Also:

Constant Field Values

Constructor Detail

StorageClient1

public StorageClient1()

constructor

StorageClient1

public StorageClient1(TrackerServer trackerServer,
                      StorageServer storageServer)

constructor

Parameters:

trackerServer - the tracker server, can be null

storageServer - the storage server, can be null

Method Detail

split_file_id

public static byte split_file_id(String file_id,
                                 String[] results)

upload_file1

public String upload_file1(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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_file1

public String upload_file1(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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_file1

public String upload_file1(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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_file1

public String upload_file1(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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_file1

public String upload_file1(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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_appender_file1

public String upload_appender_file1(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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_appender_file1

public String upload_appender_file1(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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_appender_file1

public String upload_appender_file1(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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_appender_file1

public String upload_appender_file1(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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_appender_file1

public String upload_appender_file1(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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_file1

public String upload_file1(String master_file_id,
                           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:

master_file_id - the master file id 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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_file1

public String upload_file1(String master_file_id,
                           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:

master_file_id - the master file id 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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_file1

public String upload_file1(String master_file_id,
                           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:

master_file_id - the master file id 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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

upload_file1

public String upload_file1(String master_file_id,
                           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)

Parameters:

master_file_id - the master file id 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:

file id(including group name and filename) if success,
return null if fail

Throws:

IOException

FsException

append_file1

public int append_file1(String appender_file_id,
                        String local_filename)
                 throws IOException,
                        FsException

append file to storage server (by file name)

Parameters:

appender_file_id - the appender file id

local_filename - local filename to append

Returns:

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

Throws:

IOException

FsException

append_file1

public int append_file1(String appender_file_id,
                        byte[] file_buff)
                 throws IOException,
                        FsException

append file to storage server (by file buff)

Parameters:

appender_file_id - the appender file id

file_buff - file content/buff

Returns:

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

Throws:

IOException

FsException

append_file1

public int append_file1(String appender_file_id,
                        byte[] file_buff,
                        int offset,
                        int length)
                 throws IOException,
                        FsException

append file to storage server (by file buff)

Parameters:

appender_file_id - the appender file id

file_buff - file content/buffer

offset - start offset of the buffer

length - the length of the buffer to append

Returns:

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

Throws:

IOException

FsException

append_file1

public int append_file1(String appender_file_id,
                        long file_size,
                        UploadCallback callback)
                 throws IOException,
                        FsException

append file to storage server (by callback)

Parameters:

appender_file_id - the appender file id

file_size - the file size

callback - the write data callback object

Returns:

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

Throws:

IOException

FsException

modify_file1

public int modify_file1(String appender_file_id,
                        long file_offset,
                        String local_filename)
                 throws IOException,
                        FsException

modify appender file to storage server (by file name)

Parameters:

appender_file_id - the appender file id

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_file1

public int modify_file1(String appender_file_id,
                        long file_offset,
                        byte[] file_buff)
                 throws IOException,
                        FsException

modify appender file to storage server (by file buff)

Parameters:

appender_file_id - the appender file id

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_file1

public int modify_file1(String appender_file_id,
                        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:

appender_file_id - the appender file id

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_file1

public int modify_file1(String appender_file_id,
                        long file_offset,
                        long modify_size,
                        UploadCallback callback)
                 throws IOException,
                        FsException

modify appender file to storage server (by callback)

Parameters:

appender_file_id - the appender file id

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

delete_file1

public int delete_file1(String file_id)
                 throws IOException,
                        FsException

delete file from storage server

Parameters:

file_id - the file id(including group name and filename)

Returns:

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

Throws:

IOException

FsException

truncate_file1

public int truncate_file1(String appender_file_id)
                   throws IOException,
                          FsException

truncate appender file to size 0 from storage server

Parameters:

appender_file_id - the appender file id

Returns:

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

Throws:

IOException

FsException

truncate_file1

public int truncate_file1(String appender_file_id,
                          long truncated_file_size)
                   throws IOException,
                          FsException

truncate appender file from storage server

Parameters:

appender_file_id - the appender file id

truncated_file_size - truncated file size

Returns:

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

Throws:

IOException

FsException

download_file1

public byte[] download_file1(String file_id)
                      throws IOException,
                             FsException

download file from storage server

Parameters:

file_id - the file id(including group name and filename)

Returns:

file content/buffer, return null if fail

Throws:

IOException

FsException

download_file1

public byte[] download_file1(String file_id,
                             long file_offset,
                             long download_bytes)
                      throws IOException,
                             FsException

download file from storage server

Parameters:

file_id - the file id(including group name and filename)

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_file1

public int download_file1(String file_id,
                          String local_filename)
                   throws IOException,
                          FsException

download file from storage server

Parameters:

file_id - the file id(including group name and filename)

local_filename - the filename on local

Returns:

0 success, return none zero errno if fail

Throws:

IOException

FsException

download_file1

public int download_file1(String file_id,
                          long file_offset,
                          long download_bytes,
                          String local_filename)
                   throws IOException,
                          FsException

download file from storage server

Parameters:

file_id - the file id(including group name and filename)

file_offset - the start offset of the file

download_bytes - download bytes, 0 for remain bytes from offset

local_filename - the filename on local

Returns:

0 success, return none zero errno if fail

Throws:

IOException

FsException

download_file1

public int download_file1(String file_id,
                          DownloadCallback callback)
                   throws IOException,
                          FsException

download file from storage server

Parameters:

file_id - the file id(including group name and filename)

callback - the callback object, will call callback.recv() when data arrive

Returns:

0 success, return none zero errno if fail

Throws:

IOException

FsException

download_file1

public int download_file1(String file_id,
                          long file_offset,
                          long download_bytes,
                          DownloadCallback callback)
                   throws IOException,
                          FsException

download file from storage server

Parameters:

file_id - the file id(including group name and filename)

file_offset - the start offset of the file

download_bytes - download bytes, 0 for remain bytes from offset

callback - the callback object, will call callback.recv() when data arrive

Returns:

0 success, return none zero errno if fail

Throws:

IOException

FsException

get_metadata1

public NameValuePair[] get_metadata1(String file_id)
                              throws IOException,
                                     FsException

get all metadata items from storage server

Parameters:

file_id - the file id(including group name and filename)

Returns:

meta info array, return null if fail

Throws:

IOException

FsException

set_metadata1

public int set_metadata1(String file_id,
                         NameValuePair[] meta_list,
                         byte op_flag)
                  throws IOException,
                         FsException

set metadata items to storage server

Parameters:

file_id - the file id(including group name and filename)

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

query_file_info1

public FileInfo query_file_info1(String file_id)
                          throws IOException,
                                 FsException

get file info from storage server

Parameters:

file_id - the file id(including group name and filename)

Returns:

FileInfo object for success, return null for fail

Throws:

IOException

FsException

get_file_info1

public FileInfo get_file_info1(String file_id)
                        throws IOException,
                               FsException

get file info decoded from filename

Parameters:

file_id - the file id(including group name and filename)

Returns:

FileInfo object for success, return null for fail

Throws:

IOException

FsException