com.obs.services.model.fs

Class ObsFSBucket

java.lang.Object

com.obs.services.model.fs.ObsFSBucket

public class ObsFSBucket
extends Object

Buckets that support the file interface

Field Summary

Fields

Modifier and Type	Field and Description
protected ObsClient	innerClient

Constructor Summary

Constructors

Constructor and Description
ObsFSBucket(String bucketName, String location)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkInternalClient()
protected void	finalize()
String	getBucketName() Obtain the bucket name.
String	getLocation() Obtain the bucket location.
ObsFSFile	newFile(String fileName, File file) Create a file.
ObsFSFile	newFile(String fileName, File file, ObjectMetadata metadata) Create a file.
ObsFSFile	newFile(String fileName, InputStream input) Create a file.
ObsFSFile	newFile(String fileName, InputStream input, ObjectMetadata metadata) Create a file.
ObsFSFolder	newFolder(String folderName) Create a folder.
HeaderResponse	setFSStatus(FSStatusEnum status) Set status of the file gateway feature for a bucket.

Methods inherited from class java.lang.Object

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

Field Detail

innerClient

protected ObsClient innerClient

Constructor Detail

ObsFSBucket

public ObsFSBucket(String bucketName,
           String location)

Method Detail

setFSStatus

public HeaderResponse setFSStatus(FSStatusEnum status)
                           throws ObsException

Set status of the file gateway feature for a bucket.

Parameters:

status - Status of the file gateway feature

Returns:

Response to the request for setting status of the file gateway feature for the bucket

Throws:

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

newFolder

public ObsFSFolder newFolder(String folderName)
                      throws ObsException

Create a folder.

Parameters:

folderName - Folder name

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

newFile

public ObsFSFile newFile(String fileName,
                InputStream input,
                ObjectMetadata metadata)
                  throws ObsException

Create a file.

Parameters:

fileName - File name

input - File input stream

metadata - File properties

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

newFile

public ObsFSFile newFile(String fileName,
                InputStream input)
                  throws ObsException

Create a file.

Parameters:

fileName - File name

input - File input stream

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

newFile

public ObsFSFile newFile(String fileName,
                File file,
                ObjectMetadata metadata)
                  throws ObsException

Create a file.

Parameters:

fileName - File name

file - Local path to the file

metadata - File properties

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

newFile

public ObsFSFile newFile(String fileName,
                File file)
                  throws ObsException

Create a file.

Parameters:

fileName - File name

file - Local path to the 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

getBucketName

public String getBucketName()

Obtain the bucket name.

Returns:

Bucket name

getLocation

public String getLocation()

Obtain the bucket location.

Returns:

Bucket location

checkInternalClient

protected void checkInternalClient()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable