org.gridgain.grid.kernal.processors.ggfs

Class GridGgfsMetaManager

java.lang.Object

org.gridgain.grid.kernal.processors.ggfs.GridGgfsManager

org.gridgain.grid.kernal.processors.ggfs.GridGgfsMetaManager

public class GridGgfsMetaManager
extends GridGgfsManager

Cache based structure (meta data) manager.

Field Summary

Fields inherited from class org.gridgain.grid.kernal.processors.ggfs.GridGgfsManager

ggfsCtx

Constructor Summary

Constructors

Constructor and Description
GridGgfsMetaManager()

Method Summary

Methods

Modifier and Type	Method and Description
GridGgfsSecondaryOutputStreamDescriptor	appendDual(org.apache.hadoop.fs.FileSystem fs, org.gridgain.grid.ggfs.GridGgfsPath path, int bufSize) Append to a file in DUAL mode.
GridGgfsSecondaryOutputStreamDescriptor	createDual(org.apache.hadoop.fs.FileSystem fs, org.gridgain.grid.ggfs.GridGgfsPath path, boolean simpleCreate, org.apache.hadoop.fs.permission.FsPermission perm, boolean overwrite, int bufSize, short replication, long blockSize, org.gridgain.grid.GridUuid affKey) Create the file in DUAL mode.
boolean	deleteDual(org.apache.hadoop.fs.FileSystem fs, org.gridgain.grid.ggfs.GridGgfsPath path, boolean recursive) Delete path in DUAL mode.
Map<String,GridGgfsListingEntry>	directoryListing(org.gridgain.grid.GridUuid fileId) List child files for specified file ID.
boolean	exists(org.gridgain.grid.GridUuid fileId) Ensure that entry with the given ID exists in meta cache.
GridGgfsFileInfo	fileForFragmentizer(Collection<org.gridgain.grid.GridUuid> exclude) Gets first available file info for fragmentizer.
org.gridgain.grid.GridUuid	fileId(org.gridgain.grid.ggfs.GridGgfsPath path) Gets file ID for specified path.
org.gridgain.grid.GridUuid	fileId(org.gridgain.grid.GridUuid parentId, String fileName) Gets file ID by its name from parent directory listing.
List<org.gridgain.grid.GridUuid>	fileIds(org.gridgain.grid.ggfs.GridGgfsPath path) Gets all file IDs for components of specified path.
GridGgfsFileInfo	info(org.gridgain.grid.GridUuid fileId) Gets file info by its ID.
Map<org.gridgain.grid.GridUuid,GridGgfsFileInfo>	infos(Collection<org.gridgain.grid.GridUuid> fileIds) Gets files details by their IDs.
GridGgfsFileInfo	lock(org.gridgain.grid.GridUuid fileId) Lock the file explicitly outside of transaction.
GridGgfsFileInfo	lockInfo(GridGgfsFileInfo info) Set lock on file info.
boolean	mkdirsDual(org.apache.hadoop.fs.FileSystem fs, org.gridgain.grid.ggfs.GridGgfsPath path, Map<String,String> props) Create directory in DUAL mode.
void	move(org.gridgain.grid.GridUuid fileId, String srcFileName, org.gridgain.grid.GridUuid srcParentId, String destFileName, org.gridgain.grid.GridUuid destParentId) Move or rename file.
protected void	onKernalStart0()
protected void	onKernalStop0(boolean cancel)
GridGgfsSecondaryInputStreamDescriptor	openDual(org.apache.hadoop.fs.FileSystem fs, org.gridgain.grid.ggfs.GridGgfsPath path, int bufSize) Open file in DUAL mode.
Collection<org.gridgain.grid.GridUuid>	pendingDeletes() Check whether there are any pending deletes and return collection of pending delete entry IDs.
GridGgfsFileInfo	putIfAbsent(org.gridgain.grid.GridUuid parentId, String fileName, GridGgfsFileInfo newFileInfo) Add file into file system structure.
GridGgfsFileInfo	removeIfEmpty(org.gridgain.grid.GridUuid parentId, String fileName, org.gridgain.grid.GridUuid fileId, org.gridgain.grid.ggfs.GridGgfsPath path, boolean rmvLocked) Remove file from the file system structure.
boolean	renameDual(org.apache.hadoop.fs.FileSystem fs, org.gridgain.grid.ggfs.GridGgfsPath src, org.gridgain.grid.ggfs.GridGgfsPath dest) Rename path in DUAL mode.
Boolean	sampling() Get sampling flag state.
boolean	sampling(Boolean val) Set sampling flag.
protected void	start0() Start manager implementation.
GridGgfsFileInfo	synchronizeFileDual(org.apache.hadoop.fs.FileSystem fs, org.gridgain.grid.ggfs.GridGgfsPath path) Synchronizes with secondary file system.
void	unlock(GridGgfsFileInfo info, long modificationTime) Remove explicit lock on file held by the current thread.
GridGgfsFileInfo	updateDual(org.apache.hadoop.fs.FileSystem fs, org.gridgain.grid.ggfs.GridGgfsPath path, Map<String,String> props) Update path in DUAL mode.
GridGgfsFileInfo	updateInfo(org.gridgain.grid.GridUuid fileId, org.gridgain.grid.lang.GridClosure<GridGgfsFileInfo,GridGgfsFileInfo> c) Update file info in cache.
void	updateParentListingAsync(org.gridgain.grid.GridUuid parentId, org.gridgain.grid.GridUuid fileId, String fileName, long lenDelta, long modificationTime) Asynchronously updates record in parent listing.
GridGgfsFileInfo	updateProperties(org.gridgain.grid.GridUuid parentId, org.gridgain.grid.GridUuid fileId, String fileName, Map<String,String> props) Update file info (file properties) in cache.
void	updateTimes(org.gridgain.grid.GridUuid parentId, org.gridgain.grid.GridUuid fileId, String fileName, long accessTime, long modificationTime) Updates last access and last modification times.

Methods inherited from class org.gridgain.grid.kernal.processors.ggfs.GridGgfsManager

kernalStartInfo, kernalStopInfo, onKernalStart, onKernalStop, start, startInfo, stop, stop0, stopInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

GridGgfsMetaManager

public GridGgfsMetaManager()

Method Detail

start0

protected void start0()
               throws org.gridgain.grid.GridException

Start manager implementation.

Overrides:

start0 in class GridGgfsManager

Throws:

org.gridgain.grid.GridException

onKernalStart0

protected void onKernalStart0()
                       throws org.gridgain.grid.GridException

Overrides:

onKernalStart0 in class GridGgfsManager

Throws:

org.gridgain.grid.GridException - If failed.

onKernalStop0

protected void onKernalStop0(boolean cancel)

Overrides:

onKernalStop0 in class GridGgfsManager

fileId

@Nullable
public org.gridgain.grid.GridUuid fileId(org.gridgain.grid.ggfs.GridGgfsPath path)
                                  throws org.gridgain.grid.GridException

Gets file ID for specified path.

Parameters:

path - Path.

Returns:

File ID for specified path or null if such file doesn't exist.

Throws:

org.gridgain.grid.GridException - If failed.

fileId

@Nullable
public org.gridgain.grid.GridUuid fileId(org.gridgain.grid.GridUuid parentId,
                                         String fileName)
                                  throws org.gridgain.grid.GridException

Gets file ID by its name from parent directory listing.

Parameters:

parentId - Parent directory ID to get child ID for.

fileName - File name in parent listing to get file ID for.

Returns:

File ID.

Throws:

org.gridgain.grid.GridException - If failed.

fileIds

public List<org.gridgain.grid.GridUuid> fileIds(org.gridgain.grid.ggfs.GridGgfsPath path)
                                         throws org.gridgain.grid.GridException

Gets all file IDs for components of specified path. Result cannot be empty - there is at least root element. But each element (except the first) can be null if such files don't exist.

Parameters:

path - Path.

Returns:

Collection of file IDs for components of specified path.

Throws:

org.gridgain.grid.GridException - If failed.

exists

public boolean exists(org.gridgain.grid.GridUuid fileId)
               throws org.gridgain.grid.GridException

Ensure that entry with the given ID exists in meta cache.

Parameters:

fileId - File id.

Returns:

True in case such entry exists.

Throws:

org.gridgain.grid.GridException - IF failed.

info

@Nullable
public GridGgfsFileInfo info(@Nullable
                             org.gridgain.grid.GridUuid fileId)
                      throws org.gridgain.grid.GridException

Gets file info by its ID.

Parameters:

fileId - File ID to get details for.

Returns:

File info.

Throws:

org.gridgain.grid.GridException - If failed.

infos

public Map<org.gridgain.grid.GridUuid,GridGgfsFileInfo> infos(Collection<org.gridgain.grid.GridUuid> fileIds)
                                                       throws org.gridgain.grid.GridException

Gets files details by their IDs.

Parameters:

fileIds - file IDs to get details for.

Returns:

Files details.

Throws:

org.gridgain.grid.GridException - If failed.

lock

public GridGgfsFileInfo lock(org.gridgain.grid.GridUuid fileId)
                      throws org.gridgain.grid.GridException

Lock the file explicitly outside of transaction.

Parameters:

fileId - File ID to lock.

Returns:

Locked file info or null if file cannot be locked or doesn't exist.

Throws:

org.gridgain.grid.GridException - If failed.

lockInfo

public GridGgfsFileInfo lockInfo(GridGgfsFileInfo info)
                          throws org.gridgain.grid.GridException

Set lock on file info.

Parameters:

info - File info.

Returns:

New file info with lock set.

Throws:

org.gridgain.grid.GridException - In case lock is already set on that file.

unlock

public void unlock(GridGgfsFileInfo info,
          long modificationTime)
            throws org.gridgain.grid.GridException

Remove explicit lock on file held by the current thread.

Parameters:

info - File info to unlock.

modificationTime - Modification time to write to file info.

Throws:

org.gridgain.grid.GridException - If failed.

directoryListing

public Map<String,GridGgfsListingEntry> directoryListing(org.gridgain.grid.GridUuid fileId)
                                                  throws org.gridgain.grid.GridException

List child files for specified file ID.

Parameters:

fileId - File to list child files for.

Returns:

Directory listing for the specified file.

Throws:

org.gridgain.grid.GridException - If failed.

fileForFragmentizer

public GridGgfsFileInfo fileForFragmentizer(Collection<org.gridgain.grid.GridUuid> exclude)
                                     throws org.gridgain.grid.GridException

Gets first available file info for fragmentizer.

Parameters:

exclude - File IDs to exclude from result.

Returns:

First qualified file info.

Throws:

org.gridgain.grid.GridException - If failed to get file for fragmentizer.

putIfAbsent

public GridGgfsFileInfo putIfAbsent(org.gridgain.grid.GridUuid parentId,
                           String fileName,
                           GridGgfsFileInfo newFileInfo)
                             throws org.gridgain.grid.GridException

Add file into file system structure.

Parameters:

parentId - Parent file ID.

fileName - File name in the parent's listing.

newFileInfo - File info to store in the parent's listing.

Returns:

File info already stored in meta cache or null if passed file info was stored.

Throws:

org.gridgain.grid.GridException - If failed.

move

public void move(org.gridgain.grid.GridUuid fileId,
        String srcFileName,
        org.gridgain.grid.GridUuid srcParentId,
        String destFileName,
        org.gridgain.grid.GridUuid destParentId)
          throws org.gridgain.grid.GridException

Move or rename file.

Parameters:

fileId - File ID to move or rename.

srcFileName - Original file name in the parent's listing.

srcParentId - Parent directory ID.

destFileName - New file name in the parent's listing after moving.

destParentId - New parent directory ID.

Throws:

org.gridgain.grid.GridException - If failed.

removeIfEmpty

@Nullable
public GridGgfsFileInfo removeIfEmpty(org.gridgain.grid.GridUuid parentId,
                                      String fileName,
                                      org.gridgain.grid.GridUuid fileId,
                                      org.gridgain.grid.ggfs.GridGgfsPath path,
                                      boolean rmvLocked)
                               throws org.gridgain.grid.GridException

Remove file from the file system structure.

Parameters:

parentId - Parent file ID.

fileName - New file name in the parent's listing.

fileId - File ID to remove.

path - Path of the deleted file.

rmvLocked - Whether to remove this entry in case it is has explicit lock.

Returns:

The last actual file info or null if such file no more exist.

Throws:

org.gridgain.grid.GridException - If failed.

pendingDeletes

public Collection<org.gridgain.grid.GridUuid> pendingDeletes()
                                                      throws org.gridgain.grid.GridException

Check whether there are any pending deletes and return collection of pending delete entry IDs.

Returns:

Collection of entry IDs to be deleted.

Throws:

org.gridgain.grid.GridException - If operation failed.

updateProperties

@Nullable
public GridGgfsFileInfo updateProperties(@Nullable
                                         org.gridgain.grid.GridUuid parentId,
                                         org.gridgain.grid.GridUuid fileId,
                                         String fileName,
                                         Map<String,String> props)
                                  throws org.gridgain.grid.GridException

Update file info (file properties) in cache.

Parameters:

parentId - Parent ID (null if file is root).

fileName - To update listing.

fileId - File ID to update information for.

props - Properties to set for the file.

Returns:

Updated file info or null if such file ID not found.

Throws:

org.gridgain.grid.GridException - If operation failed.

updateParentListingAsync

public void updateParentListingAsync(org.gridgain.grid.GridUuid parentId,
                            org.gridgain.grid.GridUuid fileId,
                            String fileName,
                            long lenDelta,
                            long modificationTime)

Asynchronously updates record in parent listing.

Parameters:

parentId - Parent ID.

fileId - File ID.

fileName - File name.

lenDelta - Length delta.

modificationTime - Last modification time.

updateInfo

@Nullable
public GridGgfsFileInfo updateInfo(org.gridgain.grid.GridUuid fileId,
                                   org.gridgain.grid.lang.GridClosure<GridGgfsFileInfo,GridGgfsFileInfo> c)
                            throws org.gridgain.grid.GridException

Update file info in cache.

Parameters:

fileId - File ID to update information for.

c - Closure to update file's info inside transaction.

Returns:

Updated file info or null if such file ID not found.

Throws:

org.gridgain.grid.GridException - If failed.

sampling

public boolean sampling(Boolean val)
                 throws org.gridgain.grid.GridException

Set sampling flag.

Parameters:

val - Sampling flag state or null to clear sampling state and mark it as "not set".

Returns:

True if sampling mode was actually changed by this call.

Throws:

org.gridgain.grid.GridException - If failed.

sampling

public Boolean sampling()
                 throws org.gridgain.grid.GridException

Get sampling flag state.

Returns:

True in case sampling is enabled, false otherwise or null in case sampling is not set.

Throws:

org.gridgain.grid.GridException - If failed.

createDual

public GridGgfsSecondaryOutputStreamDescriptor createDual(org.apache.hadoop.fs.FileSystem fs,
                                                 org.gridgain.grid.ggfs.GridGgfsPath path,
                                                 boolean simpleCreate,
                                                 @Nullable
                                                 org.apache.hadoop.fs.permission.FsPermission perm,
                                                 boolean overwrite,
                                                 int bufSize,
                                                 short replication,
                                                 long blockSize,
                                                 org.gridgain.grid.GridUuid affKey)
                                                   throws org.gridgain.grid.GridException

Create the file in DUAL mode.

Parameters:

fs - File system.

path - Path.

simpleCreate - "Simple create" flag.

perm - Permission.

overwrite - Overwrite flag.

bufSize - Buffer size.

replication - Replication factor.

blockSize - Block size.

affKey - Affinity key.

Returns:

Output stream descriptor.

Throws:

org.gridgain.grid.GridException - If file creation failed.

appendDual

public GridGgfsSecondaryOutputStreamDescriptor appendDual(org.apache.hadoop.fs.FileSystem fs,
                                                 org.gridgain.grid.ggfs.GridGgfsPath path,
                                                 int bufSize)
                                                   throws org.gridgain.grid.GridException

Append to a file in DUAL mode.

Parameters:

fs - File system.

path - Path.

bufSize - Buffer size.

Returns:

Output stream descriptor.

Throws:

org.gridgain.grid.GridException - If output stream open for append has failed.

openDual

public GridGgfsSecondaryInputStreamDescriptor openDual(org.apache.hadoop.fs.FileSystem fs,
                                              org.gridgain.grid.ggfs.GridGgfsPath path,
                                              int bufSize)
                                                throws org.gridgain.grid.GridException

Open file in DUAL mode.

Parameters:

fs - Secondary file system.

path - Path to open.

bufSize - Buffer size.

Returns:

Input stream descriptor.

Throws:

org.gridgain.grid.GridException - If input stream open has failed.

synchronizeFileDual

@Nullable
public GridGgfsFileInfo synchronizeFileDual(org.apache.hadoop.fs.FileSystem fs,
                                            org.gridgain.grid.ggfs.GridGgfsPath path)
                                     throws org.gridgain.grid.GridException

Synchronizes with secondary file system.

Parameters:

fs - File system.

path - Path.

Returns:

File info or null if file not found.

Throws:

org.gridgain.grid.GridException - If sync task failed.

mkdirsDual

public boolean mkdirsDual(org.apache.hadoop.fs.FileSystem fs,
                 org.gridgain.grid.ggfs.GridGgfsPath path,
                 Map<String,String> props)
                   throws org.gridgain.grid.GridException

Create directory in DUAL mode.

Parameters:

fs - Secondary file system.

path - Path to create.

props - Properties to be applied.

Returns:

True in case rename was successful.

Throws:

org.gridgain.grid.GridException - If directory creation failed.

renameDual

public boolean renameDual(org.apache.hadoop.fs.FileSystem fs,
                 org.gridgain.grid.ggfs.GridGgfsPath src,
                 org.gridgain.grid.ggfs.GridGgfsPath dest)
                   throws org.gridgain.grid.GridException

Rename path in DUAL mode.

Parameters:

fs - Secondary file system.

src - Source path.

dest - Destination path.

Returns:

Operation result.

Throws:

org.gridgain.grid.GridException - If failed.

deleteDual

public boolean deleteDual(org.apache.hadoop.fs.FileSystem fs,
                 org.gridgain.grid.ggfs.GridGgfsPath path,
                 boolean recursive)
                   throws org.gridgain.grid.GridException

Delete path in DUAL mode.

Parameters:

fs - Secondary file system.

path - Path to update.

recursive - Recursive flag.

Returns:

Operation result.

Throws:

org.gridgain.grid.GridException - If delete failed.

updateDual

public GridGgfsFileInfo updateDual(org.apache.hadoop.fs.FileSystem fs,
                          org.gridgain.grid.ggfs.GridGgfsPath path,
                          Map<String,String> props)
                            throws org.gridgain.grid.GridException

Update path in DUAL mode.

Parameters:

fs - Secondary file system.

path - Path to update.

props - Properties to be applied.

Returns:

Update file info.

Throws:

org.gridgain.grid.GridException - If update failed.

updateTimes

public void updateTimes(org.gridgain.grid.GridUuid parentId,
               org.gridgain.grid.GridUuid fileId,
               String fileName,
               long accessTime,
               long modificationTime)
                 throws org.gridgain.grid.GridException

Updates last access and last modification times.

Parameters:

parentId - File parent ID.

fileId - File ID to update.

fileName - File name to update. Must match file ID.

accessTime - Access time to set. If -1, will not be updated.

modificationTime - Modification time to set. If -1, will not be updated.

Throws:

org.gridgain.grid.GridException - If update failed.