org.gridgain.grid.persistentstore.snapshot.file.remote

Class VFS2SnapshotPath

java.lang.Object

org.gridgain.grid.persistentstore.snapshot.file.remote.VFS2SnapshotPath

All Implemented Interfaces:

org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

public class VFS2SnapshotPath
extends Object
implements org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Commons-vfs2 file wrapper. Doesn't actually store file objects, but only means to obtain and use them for operations.

Constructor Summary

Constructors

Constructor and Description
VFS2SnapshotPath(org.apache.commons.vfs2.impl.StandardFileSystemManager manager, org.apache.commons.vfs2.FileObject fileObject) Constructor.

Method Summary

Modifier and Type	Method and Description
void	copyFrom(Path srcFile) Copies file from local destination with two phase copy pattern.
boolean	createDirectories() Creates directories.
void	createNewFile() Creates new file.
boolean	delete() Deletes file.
void	deleteIfEmpty() Deletes file/folder if empty.
boolean	exists() Checks that file exists.
String	getAbsolutePath() Gets absolute path.
Collection<org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath>	getEntries() Gets files and folders in this folder.
String	getName() Gets file name.
org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath	getParent() Gets parent.
InputStream	inputStream() Opens input stream for this file.
boolean	isDirectory() Checks that this is a folder.
boolean	isEmptyDirectory() Checks that directory is empty.
boolean	isFile() Checks that this is a file.
long	length() Gets file length.
OutputStream	outputStream() Opens output stream for this file.
org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath	resolve(String name) Resolves subfile.
@Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath	resolveRegularOrCompressed(String name) Resolves regular or compressed file (zip, zstd, lz4, etc).
org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath	resolveSibling(String fileName) Resolves file in parent folder.
void	sync() Tries to sync this file.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VFS2SnapshotPath

public VFS2SnapshotPath(org.apache.commons.vfs2.impl.StandardFileSystemManager manager,
                        org.apache.commons.vfs2.FileObject fileObject)

Constructor.

Method Detail

length

public long length()

Gets file length.

Specified by:

length in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

File length.

exists

public boolean exists()

Checks that file exists.

Specified by:

exists in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

File existence.

delete

public boolean delete()

Deletes file.

Specified by:

delete in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

true if and only if the file or directory is successfully deleted, false otherwise.

deleteIfEmpty

public void deleteIfEmpty()

Deletes file/folder if empty.

Specified by:

deleteIfEmpty in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

createNewFile

public void createNewFile()

Creates new file.

Specified by:

createNewFile in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

getParent

public org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath getParent()

Gets parent.

Specified by:

getParent in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

parent, or null if this is root.

createDirectories

public boolean createDirectories()

Creates directories.

Specified by:

createDirectories in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

true if created

resolve

public org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath resolve(String name)

Resolves subfile.

Specified by:

resolve in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Parameters:

name - Subfile name.

Returns:

Subfile wrapper.

resolveRegularOrCompressed

@Nullable
public @Nullable org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath resolveRegularOrCompressed(String name)

Resolves regular or compressed file (zip, zstd, lz4, etc).

Specified by:

resolveRegularOrCompressed in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Parameters:

name - File name.

Returns:

Resolved file wrapper.

isFile

public boolean isFile()

Checks that this is a file.

Specified by:

isFile in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

true only if it is a file.

isDirectory

public boolean isDirectory()

Checks that this is a folder.

Specified by:

isDirectory in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

true only if it is a folder.

isEmptyDirectory

public boolean isEmptyDirectory()

Checks that directory is empty.

Specified by:

isEmptyDirectory in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

true only if this is directory and it is empty.

resolveSibling

public org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath resolveSibling(String fileName)

Resolves file in parent folder.

Specified by:

resolveSibling in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Parameters:

fileName - File name.

Returns:

Resolved file.

outputStream

public OutputStream outputStream()

Opens output stream for this file.
Client must close stream.

Specified by:

outputStream in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

Output stream.

inputStream

public InputStream inputStream()

Opens input stream for this file.
Client must close stream.

Specified by:

inputStream in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

Input stream.

getName

public String getName()

Gets file name.

Specified by:

getName in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

File name.

getAbsolutePath

public String getAbsolutePath()

Gets absolute path.

Specified by:

getAbsolutePath in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

Absolute path.

getEntries

public Collection<org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath> getEntries()

Gets files and folders in this folder.

Specified by:

getEntries in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Returns:

Files and folders in this folder.

sync

public void sync()

Tries to sync this file.

Specified by:

sync in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

copyFrom

public void copyFrom(Path srcFile)
              throws IOException

Copies file from local destination with two phase copy pattern.

Specified by:

copyFrom in interface org.gridgain.grid.internal.processors.cache.database.snapshot.file.SnapshotPath

Parameters:

srcFile - Local file location.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object