com.celarli.commons.vfs.provider.google

Class GcsFileObject

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

com.celarli.commons.vfs.provider.google.GcsFileObject

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<org.apache.commons.vfs2.FileObject>, Iterable<org.apache.commons.vfs2.FileObject>, org.apache.commons.vfs2.FileObject

public class GcsFileObject
extends org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

This class is in charge of bridging the gap between commons vfs and GCS

Field Summary

Fields

Modifier and Type	Field and Description
static int	COPY_BUFFER_SIZE
static String	PATH_DELIMITER

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

DEFAULT_BUFFER_SIZE

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

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
boolean	canRenameTo(org.apache.commons.vfs2.FileObject fileObject) Returns false to reply on copyFrom method in case moving/copying file within same google storage project
void	copyFrom(org.apache.commons.vfs2.FileObject file, org.apache.commons.vfs2.FileSelector selector)
void	copyFrom(org.apache.commons.vfs2.FileObject file, org.apache.commons.vfs2.FileSelector selector, org.apache.commons.net.io.CopyStreamListener copyStreamListener) This method help to copy blob server side if source and destination location belongs to same project.
void	createFolder() Used for creating folders.
protected void	doAttach()
protected void	doCreateFolder() Callback for handling create folder requests.
protected void	doDelete()
protected long	doGetContentSize()
protected InputStream	doGetInputStream()
protected long	doGetLastModifiedTime() Callback for handling the getLastModifiedTime() Commons VFS API call.
protected OutputStream	doGetOutputStream(boolean bAppend)
protected org.apache.commons.vfs2.FileType	doGetType()
protected String[]	doListChildren()
protected boolean	doSetLastModifiedTime(long modtime) We must override this method because the parent one throws exception.
boolean	exists()
org.apache.commons.vfs2.FileObject[]	getChildren() Returns the file's list of children.
URL	signedURL(long duration) Generate signed url to directly access file.

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

childrenChanged, close, compareTo, createFile, delete, delete, deleteAll, doCreateFileContent, doDetach, doGetAttributes, doGetCertificates, doGetInputStream, doGetRandomAccessContent, doIsExecutable, doIsHidden, doIsReadable, doIsSameFile, doIsSymbolicLink, doIsWriteable, doListChildrenResolved, doRemoveAttribute, doRename, doSetAttribute, doSetExecutable, doSetReadable, doSetWritable, endOutput, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isSymbolicLink, isWriteable, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, setExecutable, setReadable, setWritable, 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

getPath, getURI

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

COPY_BUFFER_SIZE

public static int COPY_BUFFER_SIZE

PATH_DELIMITER

public static final String PATH_DELIMITER

See Also:

Constant Field Values

Method Detail

doSetLastModifiedTime

protected boolean doSetLastModifiedTime(long modtime)

We must override this method because the parent one throws exception.

Overrides:

doSetLastModifiedTime in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

Parameters:

modtime - the last modified time.

Returns:

true if successfully modified, false otherwise.

doGetType

@Nonnull
protected org.apache.commons.vfs2.FileType doGetType()

Specified by:

doGetType in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

doListChildren

@Nonnull
protected String[] doListChildren()
                                    throws Exception

Specified by:

doListChildren in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

Throws:

Exception

exists

public boolean exists()
               throws org.apache.commons.vfs2.FileSystemException

Specified by:

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

Overrides:

exists in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

Throws:

org.apache.commons.vfs2.FileSystemException

doGetContentSize

protected long doGetContentSize()

Specified by:

doGetContentSize in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

doGetInputStream

@Nonnull
protected InputStream doGetInputStream()

Overrides:

doGetInputStream in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

doGetOutputStream

@Nonnull
protected OutputStream doGetOutputStream(boolean bAppend)

Overrides:

doGetOutputStream in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

doCreateFolder

protected void doCreateFolder()

Callback for handling create folder requests. Since there are no folders in GCS this call is ignored.

Overrides:

doCreateFolder in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

createFolder

public void createFolder()

Used for creating folders. It's not used since GCS does not have the concept of folders.

Specified by:

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

Overrides:

createFolder in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

doAttach

protected void doAttach()

Overrides:

doAttach in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

doDelete

protected void doDelete()

Overrides:

doDelete in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

getChildren

public org.apache.commons.vfs2.FileObject[] getChildren()
                                                 throws org.apache.commons.vfs2.FileSystemException

Returns the file's list of children.

Specified by:

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

Overrides:

getChildren in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

Returns:

The list of children

Throws:

org.apache.commons.vfs2.FileSystemException - If there was a problem listing children

See Also:

AbstractFileObject.getChildren()

doGetLastModifiedTime

protected long doGetLastModifiedTime()
                              throws Exception

Callback for handling the getLastModifiedTime() Commons VFS API call.

Overrides:

doGetLastModifiedTime in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

Returns:

Time since the file has last been modified

Throws:

Exception

copyFrom

public void copyFrom(org.apache.commons.vfs2.FileObject file,
                     org.apache.commons.vfs2.FileSelector selector)
              throws org.apache.commons.vfs2.FileSystemException

Specified by:

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

Overrides:

copyFrom in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

Throws:

org.apache.commons.vfs2.FileSystemException

copyFrom

public void copyFrom(org.apache.commons.vfs2.FileObject file,
                     org.apache.commons.vfs2.FileSelector selector,
                     org.apache.commons.net.io.CopyStreamListener copyStreamListener)
              throws org.apache.commons.vfs2.FileSystemException

This method help to copy blob server side if source and destination location belongs to same project. It also takes listener to report progress of file/folder being copied.

Throws:

org.apache.commons.vfs2.FileSystemException

canRenameTo

public boolean canRenameTo(org.apache.commons.vfs2.FileObject fileObject)

Returns false to reply on copyFrom method in case moving/copying file within same google storage project

Specified by:

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

Overrides:

canRenameTo in class org.apache.commons.vfs2.provider.AbstractFileObject<GcsFileSystem>

signedURL

public URL signedURL(long duration)

Generate signed url to directly access file.