com.lf.vfslib.s3

Class S3FileObject

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileObject

com.lf.vfslib.s3.S3FileObject

All Implemented Interfaces:

org.apache.commons.vfs2.FileObject

public class S3FileObject
extends org.apache.commons.vfs2.provider.AbstractFileObject
implements org.apache.commons.vfs2.FileObject

Represents a Amazon S3 file or folder.

Since:

1.6

Version:

$Revision: 1.13 $, $Date: 2016/01/01 15:43:02 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	attributes The attributes specific for cloud file systems (e.g.
protected S3FileSystem	fileSystem The underlying file system.
protected boolean	inRefresh Helper to avoid multiple refreshing.
protected java.lang.String	relPath The relative path on the Amazon S3 server without leading slash, folders end with '/'.
protected com.amazonaws.services.s3.model.Bucket	s3Bucket The underlying Amazon S3 parent container.
protected com.amazonaws.services.s3.model.S3ObjectInputStream	s3InputStream Input streams are recycled by the S3 API, implement workaround for this.
protected com.amazonaws.services.s3.model.S3Object	s3Object The underlying Amazon S3 object, null for folders.

Constructor Summary

Constructors

Constructor and Description
S3FileObject(org.apache.commons.vfs2.provider.AbstractFileName name, S3FileSystem filesystem) Constructor method.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doCreateFolder() Creates this file as a folder.
protected void	doDelete() Deletes the file.
protected void	doDetach() Detach from the file system.
protected java.util.Map<java.lang.String,java.lang.Object>	doGetAttributes() Returns the attributes specific for cloud file systems (e.g.
protected long	doGetContentSize() Returns the size of the file content (in bytes).
protected java.io.InputStream	doGetInputStream() Creates an input stream to read the file content from.
protected long	doGetLastModifiedTime() Gets the last modification date and time.
protected java.io.OutputStream	doGetOutputStream(boolean append) Creates an output stream to write the file content to.
protected org.apache.commons.vfs2.RandomAccessContent	doGetRandomAccessContent(org.apache.commons.vfs2.util.RandomAccessMode mode) Provides the instance to model random access for files.
protected org.apache.commons.vfs2.FileType	doGetType() Determines the type of this file, returns null if the file does not exist.
protected java.lang.String[]	doListChildren() Lists the children of this file.
protected org.apache.commons.vfs2.FileObject[]	doListChildrenResolved() Lists the children of this file.
protected void	doRename(org.apache.commons.vfs2.FileObject newfile) Rename the file.
protected void	doSetAttribute(java.lang.String attrName, java.lang.Object value) Sets an attribute of this cloud file.
protected boolean	doSetLastModifiedTime(long modtime) Sets the last modified time of this file (not supported by Amazon S3).
protected void	finalize() Clean-up method to help the gc.
VFSLib	getVFSLib() Provides the VFSLib instance for this filesystem.
protected void	onChange() Called when the type or content of this file changes.
void	refresh() Refresh this file.
protected void	statSelf() Determines the type of this file.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject

canRenameTo, childrenChanged, close, copyFrom, createFile, createFolder, delete, delete, doAttach, doCreateFileContent, doGetCertificates, doIsHidden, doIsReadable, doIsSameFile, doIsWriteable, doRemoveAttribute, endOutput, exists, findFiles, findFiles, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getName, getOutputStream, getOutputStream, getParent, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isHidden, isReadable, isSameFile, isWriteable, moveTo, notifyAllStreamsClosed, onChildrenChanged, resolveFile, resolveFile, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.vfs2.FileObject

canRenameTo, close, copyFrom, createFile, createFolder, delete, delete, exists, findFiles, findFiles, getChild, getChildren, getContent, getFileOperations, getFileSystem, getName, getParent, getType, getURL, isAttached, isContentOpen, isHidden, isReadable, isWriteable, moveTo, resolveFile, resolveFile

Field Detail

fileSystem

protected final S3FileSystem fileSystem

The underlying file system.

relPath

protected java.lang.String relPath

The relative path on the Amazon S3 server without leading slash, folders end with '/'.

inRefresh

protected boolean inRefresh

Helper to avoid multiple refreshing.

s3Bucket

protected com.amazonaws.services.s3.model.Bucket s3Bucket

The underlying Amazon S3 parent container.

s3Object

protected com.amazonaws.services.s3.model.S3Object s3Object

The underlying Amazon S3 object, null for folders.

attributes

protected java.util.Map<java.lang.String,java.lang.Object> attributes

The attributes specific for cloud file systems (e.g. "Content-Length" for proper upload).

s3InputStream

protected com.amazonaws.services.s3.model.S3ObjectInputStream s3InputStream

Input streams are recycled by the S3 API, implement workaround for this.

Constructor Detail

S3FileObject

public S3FileObject(org.apache.commons.vfs2.provider.AbstractFileName name,
            S3FileSystem filesystem)
             throws org.apache.commons.vfs2.FileSystemException

Constructor method.

Parameters:

name - The file name

filesystem - The file system

Throws:

java.lang.NullPointerException - If a parameter is null

org.apache.commons.vfs2.FileSystemException - If something goes wrong

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class org.apache.commons.vfs2.provider.AbstractFileObject

Throws:

java.lang.Throwable - Error indication

Since:

1.6

doDetach

protected void doDetach()
                 throws java.lang.Exception

Detach from the file system.

Overrides:

doDetach in class org.apache.commons.vfs2.provider.AbstractFileObject

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

refresh

public void refresh()
             throws org.apache.commons.vfs2.FileSystemException

Refresh this file.

Specified by:

refresh in interface org.apache.commons.vfs2.FileObject

Overrides:

refresh in class org.apache.commons.vfs2.provider.AbstractFileObject

Throws:

org.apache.commons.vfs2.FileSystemException - If something goes wrong

Since:

1.6

doGetType

protected org.apache.commons.vfs2.FileType doGetType()
                                              throws java.lang.Exception

Determines the type of this file, returns null if the file does not exist.

Specified by:

doGetType in class org.apache.commons.vfs2.provider.AbstractFileObject

Returns:

The file type

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

statSelf

protected void statSelf()
                 throws java.lang.Exception

Determines the type of this file.

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

onChange

protected void onChange()
                 throws java.lang.Exception

Called when the type or content of this file changes.

Overrides:

onChange in class org.apache.commons.vfs2.provider.AbstractFileObject

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

doCreateFolder

protected void doCreateFolder()
                       throws java.lang.Exception

Creates this file as a folder.

Overrides:

doCreateFolder in class org.apache.commons.vfs2.provider.AbstractFileObject

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

doGetLastModifiedTime

protected long doGetLastModifiedTime()
                              throws java.lang.Exception

Gets the last modification date and time.

Overrides:

doGetLastModifiedTime in class org.apache.commons.vfs2.provider.AbstractFileObject

Returns:

The last modification time in milliseconds

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

doSetLastModifiedTime

protected boolean doSetLastModifiedTime(long modtime)
                                 throws java.lang.Exception

Sets the last modified time of this file (not supported by Amazon S3).

Overrides:

doSetLastModifiedTime in class org.apache.commons.vfs2.provider.AbstractFileObject

Parameters:

modtime - Last modification time in milliseconds

Returns:

Successful?

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

doDelete

protected void doDelete()
                 throws java.lang.Exception

Deletes the file.

Overrides:

doDelete in class org.apache.commons.vfs2.provider.AbstractFileObject

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

doRename

protected void doRename(org.apache.commons.vfs2.FileObject newfile)
                 throws java.lang.Exception

Rename the file.

Renaming is not currently supported by Amazon S3, so let's do the copy-and-delete thing for files. Remember that renaming folders is currently not possible for Amazon S3 at all. The S3 Management Console does not support it and neither does VFSLib.

Overrides:

doRename in class org.apache.commons.vfs2.provider.AbstractFileObject

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

doListChildrenResolved

protected org.apache.commons.vfs2.FileObject[] doListChildrenResolved()
                                                               throws java.lang.Exception

Lists the children of this file.

Overrides:

doListChildrenResolved in class org.apache.commons.vfs2.provider.AbstractFileObject

Returns:

The list of children, may be empty

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

doListChildren

protected java.lang.String[] doListChildren()
                                     throws java.lang.Exception

Lists the children of this file.

Specified by:

doListChildren in class org.apache.commons.vfs2.provider.AbstractFileObject

Returns:

The list of children, may be empty

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

doGetContentSize

protected long doGetContentSize()
                         throws java.lang.Exception

Returns the size of the file content (in bytes).

Specified by:

doGetContentSize in class org.apache.commons.vfs2.provider.AbstractFileObject

Returns:

The size, -1 if not available

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

doGetRandomAccessContent

protected org.apache.commons.vfs2.RandomAccessContent doGetRandomAccessContent(org.apache.commons.vfs2.util.RandomAccessMode mode)
                                                                        throws java.lang.Exception

Provides the instance to model random access for files.

Overrides:

doGetRandomAccessContent in class org.apache.commons.vfs2.provider.AbstractFileObject

Returns:

The instance

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

doGetInputStream

protected java.io.InputStream doGetInputStream()
                                        throws java.lang.Exception

Creates an input stream to read the file content from.

Specified by:

doGetInputStream in class org.apache.commons.vfs2.provider.AbstractFileObject

Returns:

The input stream

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

doGetOutputStream

protected java.io.OutputStream doGetOutputStream(boolean append)
                                          throws java.lang.Exception

Creates an output stream to write the file content to.

Overrides:

doGetOutputStream in class org.apache.commons.vfs2.provider.AbstractFileObject

Parameters:

append - Not supported currently, always created freshly

Returns:

The output stream

Throws:

java.lang.Exception - If something goes wrong

Since:

1.6

getVFSLib

public VFSLib getVFSLib()

Provides the VFSLib instance for this filesystem.

Returns:

The instance

Since:

1.6

doGetAttributes

protected java.util.Map<java.lang.String,java.lang.Object> doGetAttributes()
                                                                    throws java.lang.Exception

Returns the attributes specific for cloud file systems (e.g. "Content-Length" for proper upload)

Overrides:

doGetAttributes in class org.apache.commons.vfs2.provider.AbstractFileObject

Returns:

The map

Throws:

java.lang.Exception

Since:

1.6

doSetAttribute

protected void doSetAttribute(java.lang.String attrName,
                  java.lang.Object value)
                       throws java.lang.Exception

Sets an attribute of this cloud file.

Overrides:

doSetAttribute in class org.apache.commons.vfs2.provider.AbstractFileObject

Parameters:

attrName - The name (ATTR_CONTENT_LENGTH|...)

value - The value

Throws:

java.lang.Exception

Since:

1.6