com.foxless.godfs.api

Interface GodfsApiClient

All Known Implementing Classes:

GodfsApiClientImpl

public interface GodfsApiClient

godfs api client. for file upload, file download, file query etc.

Version:

1.0

Author:

hehety

Method Summary

Modifier and Type	Method and Description
void	download(String path, IReader byteReceiver)
void	download(String path, long start, long offset, IReader byteReceiver) download file using file path which pattern like 'G01/001/S/<md5>'
FileEntity	query(String pathOrMd5) query file info from tracker server.
String	upload(File file) upload local file.
String	upload(File file, String group, IMonitor<MonitorProgressBean> monitor) upload local file.
String	upload(javax.servlet.http.HttpServletRequest request) streaming api for uploading file. NOTE: this way needs storage server enable http upload.
String	upload(javax.servlet.http.HttpServletRequest request, String group, IMonitor<MonitorProgressBean> monitor, String protocol) streaming api for uploading file. NOTE: this way needs storage server enable http upload.
String	upload(InputStream ips, long fileSize) upload file in stream mode.
String	upload(InputStream ips, long fileSize, String group, IMonitor<MonitorProgressBean> monitor) upload file in stream mode.

Method Detail

query

FileEntity query(String pathOrMd5)
          throws Exception

query file info from tracker server.

Parameters:

pathOrMd5 - path like "G01/001/90234afcbba2314123112390234afcbb" or just a file md5

Throws:

Exception

upload

String upload(InputStream ips,
              long fileSize,
              String group,
              IMonitor<MonitorProgressBean> monitor)
       throws Exception

upload file in stream mode.

Parameters:

ips -

fileSize -

group - the group of the file

monitor - upload progress monitor

Returns:

file id like "G01/001/90234afcbba2314123112390234afcbb"

Throws:

Exception

upload

String upload(InputStream ips,
              long fileSize)
       throws Exception

upload file in stream mode.

Parameters:

ips -

fileSize -

Returns:

file id like "G01/001/90234afcbba2314123112390234afcbb"

Throws:

Exception

upload

String upload(File file,
              String group,
              IMonitor<MonitorProgressBean> monitor)
       throws Exception

upload local file.

Parameters:

file - the file to be uploaded

group - the group of the file

monitor - upload progress monitor

Returns:

file id like "G01/001/90234afcbba2314123112390234afcbb"

Throws:

Exception

upload

String upload(File file)
       throws Exception

upload local file.

Parameters:

file - the file to be uploaded

Returns:

file id like "G01/001/90234afcbba2314123112390234afcbb"

Throws:

Exception

upload

String upload(javax.servlet.http.HttpServletRequest request,
              String group,
              IMonitor<MonitorProgressBean> monitor,
              String protocol)
       throws Exception

streaming api for uploading file.
NOTE: this way needs storage server enable http upload.

Parameters:

request - the http request, if you are using spring ---------------------------

group - the group of the file

monitor - upload progress monitor

protocol - only http or https, default is http.

Returns:

Throws:

Exception

upload

String upload(javax.servlet.http.HttpServletRequest request)
       throws Exception

streaming api for uploading file.
NOTE: this way needs storage server enable http upload.

Parameters:

request - the http request, if you are using spring ---------------------------

Returns:

Throws:

Exception

download

void download(String path,
              long start,
              long offset,
              IReader byteReceiver)
       throws Exception

download file using file path which pattern like 'G01/001/S/<md5>'

Parameters:

path - file path which pattern like 'G01/001/S/<md5>'

start - download file start position.

offset - download bytes offset, -1 represents the end of the file.

byteReceiver - byte receiver handling download file bytes.

Throws:

Exception

download

void download(String path,
              IReader byteReceiver)
       throws Exception

Throws:

Exception

See Also:

download(String, long, long, IReader)