com.obs.services

Interface IFSClient

All Known Implementing Classes:

ObsClient, OefClient, SecretFlexibleObsClient

public interface IFSClient

Gateway interface for OBS files

Method Summary

Methods

Modifier and Type	Method and Description
ObsFSFile	appendFile(WriteFileRequest request) Append data to a file.
void	close() Disable ObsClient and release connection resources.
DropFileResult	dropFile(DropFileRequest request) Delete a file.
TaskProgressStatus	dropFolder(DropFolderRequest request) Delete a folder.
ObsFSAttribute	getAttribute(GetAttributeRequest request) Obtain file or folder properties.
GetBucketFSStatusResult	getBucketFSStatus(GetBucketFSStatusRequest request) Check whether the file gateway feature is enabled for the bucket.
ObsFSBucket	newBucket(NewBucketRequest request) Create a bucket.
ObsFSFile	newFile(NewFileRequest request) Create a file.
ObsFSFolder	newFolder(NewFolderRequest request) Create a folder.
ReadFileResult	readFile(ReadFileRequest request) Obtain the file content.
RenameResult	renameFile(RenameRequest request) Rename a file.
RenameResult	renameFolder(RenameRequest request) Rename a folder.
HeaderResponse	setBucketFSStatus(SetBucketFSStatusRequest request) Specify whether to enable the file gateway feature for the bucket.
TruncateFileResult	truncateFile(TruncateFileRequest request) Truncate a file.
ObsFSFile	writeFile(WriteFileRequest request) Write data to a file.

Method Detail

close

void close()
           throws IOException

Disable ObsClient and release connection resources.

Throws:

IOException

newBucket

ObsFSBucket newBucket(NewBucketRequest request)
                      throws ObsException

Create a bucket.

Parameters:

request - Request parameters for creating a bucket

Returns:

Bucket supporting the file interface

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketFSStatus

HeaderResponse setBucketFSStatus(SetBucketFSStatusRequest request)
                                 throws ObsException

Specify whether to enable the file gateway feature for the bucket.

Parameters:

request - Request parameters for specifying whether to enable the file gateway feature for the bucket

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketFSStatus

GetBucketFSStatusResult getBucketFSStatus(GetBucketFSStatusRequest request)
                                          throws ObsException

Check whether the file gateway feature is enabled for the bucket.

Parameters:

request - Request parameters for checking whether the file gateway feature is enabled for the bucket

Returns:

Response to the check of whether the file gateway feature is enabled for the bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

newFile

ObsFSFile newFile(NewFileRequest request)
                  throws ObsException

Create a file.

Parameters:

request - Request parameters for creating a file

Returns:

Files in the bucket that supports the file interface

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

newFolder

ObsFSFolder newFolder(NewFolderRequest request)
                      throws ObsException

Create a folder.

Parameters:

request - Request parameters for creating a folder

Returns:

Folders in the bucket that supports the file interface

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getAttribute

ObsFSAttribute getAttribute(GetAttributeRequest request)
                            throws ObsException

Obtain file or folder properties.

Parameters:

request - Request parameters for obtaining filer or folder properties

Returns:

File or folder properties

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

readFile

ReadFileResult readFile(ReadFileRequest request)
                        throws ObsException

Obtain the file content.

Parameters:

request - Request parameters for obtaining the file content

Returns:

Response to the request for obtaining file content

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

writeFile

ObsFSFile writeFile(WriteFileRequest request)
                    throws ObsException

Write data to a file.

Parameters:

request - Request parameters for writing data to a file

Returns:

Files in the bucket that supports the file interface

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

appendFile

ObsFSFile appendFile(WriteFileRequest request)
                     throws ObsException

Append data to a file.

Parameters:

request - Request parameters for writing data to a file

Returns:

Files in the bucket that supports the file interface

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

renameFile

RenameResult renameFile(RenameRequest request)
                        throws ObsException

Rename a file.

Parameters:

request - Request parameters for renaming a file

Returns:

Response to the request for renaming a file

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

renameFolder

RenameResult renameFolder(RenameRequest request)
                          throws ObsException

Rename a folder.

Parameters:

request - Request parameters for renaming a folder

Returns:

Response to the request for renaming a folder

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

truncateFile

TruncateFileResult truncateFile(TruncateFileRequest request)
                                throws ObsException

Truncate a file.

Parameters:

request - Request parameters for truncating a file

Returns:

Response to the request for truncating a file

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

dropFile

DropFileResult dropFile(DropFileRequest request)
                        throws ObsException

Delete a file.

Parameters:

request - Request parameters for deleting a file

Returns:

Response to the request for deleting a file

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

dropFolder

TaskProgressStatus dropFolder(DropFolderRequest request)
                              throws ObsException

Delete a folder.

Parameters:

request - Request parameters for deleting a folder

Returns:

Batch task execution status

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails