org.csource.fastdfs
Class StorageClient1

java.lang.Object
  extended by org.csource.fastdfs.StorageClient
      extended by 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
static java.lang.String SPLIT_GROUP_NAME_AND_FILENAME_SEPERATOR
           
 
Fields inherited from class org.csource.fastdfs.StorageClient
base64, errno, storageServer, trackerServer
 
Constructor Summary
StorageClient1()
          constructor
StorageClient1(TrackerServer trackerServer, StorageServer storageServer)
          constructor
 
Method Summary
 int append_file1(java.lang.String appender_file_id, byte[] file_buff)
          append file to storage server (by file buff)
 int append_file1(java.lang.String appender_file_id, byte[] file_buff, int offset, int length)
          append file to storage server (by file buff)
 int append_file1(java.lang.String appender_file_id, long file_size, UploadCallback callback)
          append file to storage server (by callback)
 int append_file1(java.lang.String appender_file_id, java.lang.String local_filename)
          append file to storage server (by file name)
 int delete_file1(java.lang.String file_id)
          delete file from storage server
 byte[] download_file1(java.lang.String file_id)
          download file from storage server
 int download_file1(java.lang.String file_id, DownloadCallback callback)
          download file from storage server
 byte[] download_file1(java.lang.String file_id, long file_offset, long download_bytes)
          download file from storage server
 int download_file1(java.lang.String file_id, long file_offset, long download_bytes, DownloadCallback callback)
          download file from storage server
 int download_file1(java.lang.String file_id, long file_offset, long download_bytes, java.lang.String local_filename)
          download file from storage server
 int download_file1(java.lang.String file_id, java.lang.String local_filename)
          download file from storage server
 FileInfo get_file_info1(java.lang.String file_id)
          get file info decoded from filename
 NameValuePair[] get_metadata1(java.lang.String file_id)
          get all metadata items from storage server
 int modify_file1(java.lang.String appender_file_id, long file_offset, byte[] file_buff)
          modify appender file to storage server (by file buff)
 int modify_file1(java.lang.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(java.lang.String appender_file_id, long file_offset, long modify_size, UploadCallback callback)
          modify appender file to storage server (by callback)
 int modify_file1(java.lang.String appender_file_id, long file_offset, java.lang.String local_filename)
          modify appender file to storage server (by file name)
 FileInfo query_file_info1(java.lang.String file_id)
          get file info from storage server
 int set_metadata1(java.lang.String file_id, NameValuePair[] meta_list, byte op_flag)
          set metadata items to storage server
static byte split_file_id(java.lang.String file_id, java.lang.String[] results)
           
 int truncate_file1(java.lang.String appender_file_id)
          truncate appender file to size 0 from storage server
 int truncate_file1(java.lang.String appender_file_id, long truncated_file_size)
          truncate appender file from storage server
 java.lang.String upload_appender_file1(byte[] file_buff, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload appender file to storage server (by file buff)
 java.lang.String upload_appender_file1(java.lang.String group_name, byte[] file_buff, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload appender file to storage server (by file buff)
 java.lang.String upload_appender_file1(java.lang.String group_name, long file_size, UploadCallback callback, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload appender file to storage server (by callback)
 java.lang.String upload_appender_file1(java.lang.String local_filename, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload appender file to storage server (by file name)
 java.lang.String upload_appender_file1(java.lang.String group_name, java.lang.String local_filename, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload appender file to storage server (by file name)
 java.lang.String upload_file1(byte[] file_buff, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload file to storage server (by file buff)
 java.lang.String upload_file1(java.lang.String group_name, byte[] file_buff, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload file to storage server (by file buff)
 java.lang.String upload_file1(java.lang.String group_name, long file_size, UploadCallback callback, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload file to storage server (by callback)
 java.lang.String upload_file1(java.lang.String master_file_id, java.lang.String prefix_name, byte[] file_buff, int offset, int length, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload file to storage server (by file buff, slave file mode)
 java.lang.String upload_file1(java.lang.String master_file_id, java.lang.String prefix_name, byte[] file_buff, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload file to storage server (by file buff, slave file mode)
 java.lang.String upload_file1(java.lang.String master_file_id, java.lang.String prefix_name, long file_size, UploadCallback callback, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload file to storage server (by callback)
 java.lang.String upload_file1(java.lang.String local_filename, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload file to storage server (by file name)
 java.lang.String upload_file1(java.lang.String group_name, java.lang.String local_filename, java.lang.String file_ext_name, NameValuePair[] meta_list)
          upload file to storage server (by file name)
 java.lang.String upload_file1(java.lang.String master_file_id, java.lang.String prefix_name, java.lang.String local_filename, java.lang.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 java.lang.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(java.lang.String file_id,
                                 java.lang.String[] results)

upload_file1

public java.lang.String upload_file1(java.lang.String local_filename,
                                     java.lang.String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws java.io.IOException,
                                     MyException
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:
java.io.IOException
MyException

upload_file1

public java.lang.String upload_file1(java.lang.String group_name,
                                     java.lang.String local_filename,
                                     java.lang.String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws java.io.IOException,
                                     MyException
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:
java.io.IOException
MyException

upload_file1

public java.lang.String upload_file1(byte[] file_buff,
                                     java.lang.String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws java.io.IOException,
                                     MyException
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:
java.io.IOException
MyException

upload_file1

public java.lang.String upload_file1(java.lang.String group_name,
                                     byte[] file_buff,
                                     java.lang.String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws java.io.IOException,
                                     MyException
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:
java.io.IOException
MyException

upload_file1

public java.lang.String upload_file1(java.lang.String group_name,
                                     long file_size,
                                     UploadCallback callback,
                                     java.lang.String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws java.io.IOException,
                                     MyException
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:
java.io.IOException
MyException

upload_appender_file1

public java.lang.String upload_appender_file1(java.lang.String local_filename,
                                              java.lang.String file_ext_name,
                                              NameValuePair[] meta_list)
                                       throws java.io.IOException,
                                              MyException
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:
java.io.IOException
MyException

upload_appender_file1

public java.lang.String upload_appender_file1(java.lang.String group_name,
                                              java.lang.String local_filename,
                                              java.lang.String file_ext_name,
                                              NameValuePair[] meta_list)
                                       throws java.io.IOException,
                                              MyException
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:
java.io.IOException
MyException

upload_appender_file1

public java.lang.String upload_appender_file1(byte[] file_buff,
                                              java.lang.String file_ext_name,
                                              NameValuePair[] meta_list)
                                       throws java.io.IOException,
                                              MyException
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:
java.io.IOException
MyException

upload_appender_file1

public java.lang.String upload_appender_file1(java.lang.String group_name,
                                              byte[] file_buff,
                                              java.lang.String file_ext_name,
                                              NameValuePair[] meta_list)
                                       throws java.io.IOException,
                                              MyException
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:
java.io.IOException
MyException

upload_appender_file1

public java.lang.String upload_appender_file1(java.lang.String group_name,
                                              long file_size,
                                              UploadCallback callback,
                                              java.lang.String file_ext_name,
                                              NameValuePair[] meta_list)
                                       throws java.io.IOException,
                                              MyException
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:
java.io.IOException
MyException

upload_file1

public java.lang.String upload_file1(java.lang.String master_file_id,
                                     java.lang.String prefix_name,
                                     java.lang.String local_filename,
                                     java.lang.String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws java.io.IOException,
                                     MyException
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:
java.io.IOException
MyException

upload_file1

public java.lang.String upload_file1(java.lang.String master_file_id,
                                     java.lang.String prefix_name,
                                     byte[] file_buff,
                                     java.lang.String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws java.io.IOException,
                                     MyException
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:
java.io.IOException
MyException

upload_file1

public java.lang.String upload_file1(java.lang.String master_file_id,
                                     java.lang.String prefix_name,
                                     byte[] file_buff,
                                     int offset,
                                     int length,
                                     java.lang.String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws java.io.IOException,
                                     MyException
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:
java.io.IOException
MyException

upload_file1

public java.lang.String upload_file1(java.lang.String master_file_id,
                                     java.lang.String prefix_name,
                                     long file_size,
                                     UploadCallback callback,
                                     java.lang.String file_ext_name,
                                     NameValuePair[] meta_list)
                              throws java.io.IOException,
                                     MyException
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:
java.io.IOException
MyException

append_file1

public int append_file1(java.lang.String appender_file_id,
                        java.lang.String local_filename)
                 throws java.io.IOException,
                        MyException
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:
java.io.IOException
MyException

append_file1

public int append_file1(java.lang.String appender_file_id,
                        byte[] file_buff)
                 throws java.io.IOException,
                        MyException
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:
java.io.IOException
MyException

append_file1

public int append_file1(java.lang.String appender_file_id,
                        byte[] file_buff,
                        int offset,
                        int length)
                 throws java.io.IOException,
                        MyException
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:
java.io.IOException
MyException

append_file1

public int append_file1(java.lang.String appender_file_id,
                        long file_size,
                        UploadCallback callback)
                 throws java.io.IOException,
                        MyException
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:
java.io.IOException
MyException

modify_file1

public int modify_file1(java.lang.String appender_file_id,
                        long file_offset,
                        java.lang.String local_filename)
                 throws java.io.IOException,
                        MyException
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:
java.io.IOException
MyException

modify_file1

public int modify_file1(java.lang.String appender_file_id,
                        long file_offset,
                        byte[] file_buff)
                 throws java.io.IOException,
                        MyException
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:
java.io.IOException
MyException

modify_file1

public int modify_file1(java.lang.String appender_file_id,
                        long file_offset,
                        byte[] file_buff,
                        int buffer_offset,
                        int buffer_length)
                 throws java.io.IOException,
                        MyException
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:
java.io.IOException
MyException

modify_file1

public int modify_file1(java.lang.String appender_file_id,
                        long file_offset,
                        long modify_size,
                        UploadCallback callback)
                 throws java.io.IOException,
                        MyException
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:
java.io.IOException
MyException

delete_file1

public int delete_file1(java.lang.String file_id)
                 throws java.io.IOException,
                        MyException
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:
java.io.IOException
MyException

truncate_file1

public int truncate_file1(java.lang.String appender_file_id)
                   throws java.io.IOException,
                          MyException
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:
java.io.IOException
MyException

truncate_file1

public int truncate_file1(java.lang.String appender_file_id,
                          long truncated_file_size)
                   throws java.io.IOException,
                          MyException
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:
java.io.IOException
MyException

download_file1

public byte[] download_file1(java.lang.String file_id)
                      throws java.io.IOException,
                             MyException
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:
java.io.IOException
MyException

download_file1

public byte[] download_file1(java.lang.String file_id,
                             long file_offset,
                             long download_bytes)
                      throws java.io.IOException,
                             MyException
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:
java.io.IOException
MyException

download_file1

public int download_file1(java.lang.String file_id,
                          java.lang.String local_filename)
                   throws java.io.IOException,
                          MyException
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:
java.io.IOException
MyException

download_file1

public int download_file1(java.lang.String file_id,
                          long file_offset,
                          long download_bytes,
                          java.lang.String local_filename)
                   throws java.io.IOException,
                          MyException
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:
java.io.IOException
MyException

download_file1

public int download_file1(java.lang.String file_id,
                          DownloadCallback callback)
                   throws java.io.IOException,
                          MyException
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:
java.io.IOException
MyException

download_file1

public int download_file1(java.lang.String file_id,
                          long file_offset,
                          long download_bytes,
                          DownloadCallback callback)
                   throws java.io.IOException,
                          MyException
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:
java.io.IOException
MyException

get_metadata1

public NameValuePair[] get_metadata1(java.lang.String file_id)
                              throws java.io.IOException,
                                     MyException
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:
java.io.IOException
MyException

set_metadata1

public int set_metadata1(java.lang.String file_id,
                         NameValuePair[] meta_list,
                         byte op_flag)
                  throws java.io.IOException,
                         MyException
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:
java.io.IOException
MyException

query_file_info1

public FileInfo query_file_info1(java.lang.String file_id)
                          throws java.io.IOException,
                                 MyException
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:
java.io.IOException
MyException

get_file_info1

public FileInfo get_file_info1(java.lang.String file_id)
                        throws java.io.IOException,
                               MyException
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:
java.io.IOException
MyException