com.obs.services.model.fs

Class ObsFSFile

java.lang.Object

com.obs.services.internal.InternalHeaderResponse

com.obs.services.model.HeaderResponse

com.obs.services.model.PutObjectResult

com.obs.services.model.fs.ObsFSFolder

com.obs.services.model.fs.ObsFSFile

public class ObsFSFile
extends ObsFSFolder

Files in a bucket that supports the file interface

Field Summary

Fields inherited from class com.obs.services.model.fs.ObsFSFolder

innerClient

Fields inherited from class com.obs.services.internal.InternalHeaderResponse

responseHeaders, statusCode

Constructor Summary

Constructors

Constructor and Description
ObsFSFile(String bucketName, String objectKey, String etag, String versionId, StorageClassEnum storageClass, String objectUrl)

Method Summary

Methods

Modifier and Type	Method and Description
ObsFSFile	append(File file) Append data to a file.
ObsFSFile	append(InputStream input) Append data to a file.
ObsFSAttribute	attribute() Obtains file properties.
DropFileResult	drop() Delete a file.
ReadFileResult	read() Obtain the file content.
ReadFileResult	read(long rangeStart, long rangeEnd) Obtain the file content.
RenameResult	rename(String newName) Rename a file.
TruncateFileResult	truncate(long newLength) Truncate a file.
ObsFSFile	write(File file) Write data to a file.
ObsFSFile	write(File file, long position) Write data to a file.
ObsFSFile	write(InputStream input) Write data to a file.
ObsFSFile	write(InputStream input, long position) Write data to a file.

Methods inherited from class com.obs.services.model.fs.ObsFSFolder

checkInternalClient, dropFolder, finalize

Methods inherited from class com.obs.services.model.PutObjectResult

getBucketName, getEtag, getObjectKey, getObjectStorageClass, getObjectUrl, getVersionId, toString

Methods inherited from class com.obs.services.model.HeaderResponse

getRequestId, getResponseHeaders, getStatusCode

Methods inherited from class com.obs.services.internal.InternalHeaderResponse

setResponseHeaders, setStatusCode

Methods inherited from class java.lang.Object

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

Constructor Detail

ObsFSFile

public ObsFSFile(String bucketName,
         String objectKey,
         String etag,
         String versionId,
         StorageClassEnum storageClass,
         String objectUrl)

Method Detail

attribute

public ObsFSAttribute attribute()
                         throws ObsException

Obtains file properties.

Overrides:

attribute in class ObsFSFolder

Returns:

File properties

Throws:

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

read

public ReadFileResult read()
                    throws ObsException

Obtain 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

read

public ReadFileResult read(long rangeStart,
                  long rangeEnd)
                    throws ObsException

Obtain the file content.

Parameters:

rangeStart - Start position for reading file content

rangeEnd - End position for reading file content

Returns:

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

Throws:

ObsException

write

public ObsFSFile write(File file,
              long position)
                throws ObsException

Write data to a file.

Parameters:

file - Local path to the file

position - Start position 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

write

public ObsFSFile write(File file)
                throws ObsException

Write data to a file.

Parameters:

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

write

public ObsFSFile write(InputStream input,
              long position)
                throws ObsException

Write data to a file.

Parameters:

input - Data stream to be uploaded

position - Start position 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

append

public ObsFSFile append(File file)
                 throws ObsException

Append data to a file.

Parameters:

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

append

public ObsFSFile append(InputStream input)
                 throws ObsException

Append data to a file.

Parameters:

input - Data stream to be uploaded

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

write

public ObsFSFile write(InputStream input)
                throws ObsException

Write data to a file.

Parameters:

input - Data stream to be uploaded

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

rename

public RenameResult rename(String newName)
                    throws ObsException

Rename a file.

Overrides:

rename in class ObsFSFolder

Parameters:

newName - New file name

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

truncate

public TruncateFileResult truncate(long newLength)
                            throws ObsException

Truncate a file.

Parameters:

newLength - File size after the truncation

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

drop

public DropFileResult drop()
                    throws ObsException

Delete 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