org.apache.ignite.internal.processors.igfs

Class IgfsUtils

java.lang.Object

org.apache.ignite.internal.processors.igfs.IgfsUtils

public class IgfsUtils
extends Object

Common IGFS utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
static IgniteUuid	DELETE_LOCK_ID Lock Id used to lock files being deleted from TRASH.
static String	PROP_GROUP_NAME File property: group name.
static String	PROP_PERMISSION File property: permission.
static String	PROP_PREFER_LOCAL_WRITES File property: prefer writes to local node.
static String	PROP_USER_NAME File property: user name.
static IgniteUuid	ROOT_ID ID for the root directory.
static int	TRASH_CONCURRENCY Constant trash concurrency level.

Method Summary

Methods

Modifier and Type	Method and Description
static IgfsDirectoryInfo	createDirectory(IgniteUuid id) Create empty directory with the given ID.
static IgfsDirectoryInfo	createDirectory(IgniteUuid id, Map<String,IgfsListingEntry> listing, Map<String,String> props) Create directory.
static IgfsDirectoryInfo	createDirectory(IgniteUuid id, Map<String,IgfsListingEntry> listing, Map<String,String> props, long createTime, long modificationTime) Create directory.
static IgfsFileInfo	createFile(IgniteUuid id, int blockSize, long len, IgniteUuid affKey, IgniteUuid lockId, boolean evictExclude, Map<String,String> props, long accessTime, long modificationTime) Create file.
static <T> T	doInTransactionWithRetries(IgniteInternalCache cache, IgniteOutClosureX<T> clo) Performs an operation with transaction with retries.
static IgfsPath	extractOriginalPathFromTrash(String name) Parses the TRASH file name to extract the original path.
static String	fixUserName(String user) Provides non-null user name.
static boolean	isIgfsCache(IgniteConfiguration cfg, String cacheName)
static boolean	isRootId(IgniteUuid id) Check whether provided ID is root ID.
static boolean	isRootOrTrashId(IgniteUuid id) Check whether provided ID is either root ID or trash ID.
static IgfsException	newIgfsException(Class<? extends IgfsException> cls, String msg, Throwable cause) Construct new IGFS exception passing specified message and cause.
static void	prepareCacheConfiguration(IgniteConfiguration cfg, CacheConfiguration ccfg) Prepare cache configuration if this is IGFS meta or data cache.
static IgniteUuid	randomTrashId() Get random trash ID.
static IgfsListingEntry	readListingEntry(BinaryRawReader in) Read listing entry.
static IgfsListingEntry	readListingEntry(DataInput in) Read listing entry.
static Map<String,String>	readProperties(BinaryRawReader in) Read entry properties.
static Map<String,String>	readProperties(DataInput in) Read entry properties.
static void	sendEvents(GridKernalContext kernalCtx, IgfsPath path, IgfsPath newPath, int type) Sends a series of event.
static void	sendEvents(GridKernalContext kernalCtx, IgfsPath path, int type) Sends a series of event.
static IgfsException	toIgfsException(Exception err) Converts any passed exception to IGFS exception.
static IgniteUuid	trashId(int idx) Get trash ID for the given index.
static void	writeListingEntry(BinaryRawWriter out, IgfsListingEntry entry) Write listing entry.
static void	writeListingEntry(DataOutput out, IgfsListingEntry entry) Write listing entry.
static void	writeProperties(BinaryRawWriter out, Map<String,String> props) Write entry properties.
static void	writeProperties(DataOutput out, Map<String,String> props) Write entry properties.

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_ID

public static final IgniteUuid ROOT_ID

ID for the root directory.

DELETE_LOCK_ID

public static final IgniteUuid DELETE_LOCK_ID

Lock Id used to lock files being deleted from TRASH. This is a global constant.

TRASH_CONCURRENCY

public static final int TRASH_CONCURRENCY

Constant trash concurrency level.

See Also:

Constant Field Values

PROP_USER_NAME

public static final String PROP_USER_NAME

File property: user name.

See Also:

Constant Field Values

PROP_GROUP_NAME

public static final String PROP_GROUP_NAME

File property: group name.

See Also:

Constant Field Values

PROP_PERMISSION

public static final String PROP_PERMISSION

File property: permission.

See Also:

Constant Field Values

PROP_PREFER_LOCAL_WRITES

public static final String PROP_PREFER_LOCAL_WRITES

File property: prefer writes to local node.

See Also:

Constant Field Values

Method Detail

randomTrashId

public static IgniteUuid randomTrashId()

Get random trash ID.

Returns:

Trash ID.

trashId

public static IgniteUuid trashId(int idx)

Get trash ID for the given index.

Parameters:

idx - Index.

Returns:

Trahs ID.

isRootOrTrashId

public static boolean isRootOrTrashId(@Nullable
                      IgniteUuid id)

Check whether provided ID is either root ID or trash ID.

Parameters:

id - ID.

Returns:

True if this is root ID or trash ID.

isRootId

public static boolean isRootId(@Nullable
               IgniteUuid id)

Check whether provided ID is root ID.

Parameters:

id - ID.

Returns:

True if this is root ID.

toIgfsException

public static IgfsException toIgfsException(Exception err)

Converts any passed exception to IGFS exception.

Parameters:

err - Initial exception.

Returns:

Converted IGFS exception.

newIgfsException

public static IgfsException newIgfsException(Class<? extends IgfsException> cls,
                             String msg,
                             Throwable cause)

Construct new IGFS exception passing specified message and cause.

Parameters:

cls - Class.

msg - Message.

cause - Cause.

Returns:

New IGFS exception.

fixUserName

public static String fixUserName(@Nullable
                 String user)

Provides non-null user name. If the user name is null or empty string, defaults to FileSystemConfiguration.DFLT_USER_NAME, which is the current process owner user.

Parameters:

user - a user name to be fixed.

Returns:

non-null interned user name.

doInTransactionWithRetries

public static <T> T doInTransactionWithRetries(IgniteInternalCache cache,
                               IgniteOutClosureX<T> clo)
                                    throws IgniteCheckedException

Performs an operation with transaction with retries.

Parameters:

cache - Cache to do the transaction on.

clo - Closure.

Returns:

Result of closure execution.

Throws:

IgniteCheckedException - If failed.

sendEvents

public static void sendEvents(GridKernalContext kernalCtx,
              IgfsPath path,
              int type)

Sends a series of event.

Parameters:

path - The path of the created file.

type - The type of event to send.

sendEvents

public static void sendEvents(GridKernalContext kernalCtx,
              IgfsPath path,
              IgfsPath newPath,
              int type)

Sends a series of event.

Parameters:

path - The path of the created file.

newPath - New path.

type - The type of event to send.

isIgfsCache

public static boolean isIgfsCache(IgniteConfiguration cfg,
                  @Nullable
                  String cacheName)

Parameters:

cfg - Grid configuration.

cacheName - Cache name.

Returns:

True in this is IGFS data or meta cache.

prepareCacheConfiguration

public static void prepareCacheConfiguration(IgniteConfiguration cfg,
                             CacheConfiguration ccfg)

Prepare cache configuration if this is IGFS meta or data cache.

Parameters:

cfg - Configuration.

ccfg - Cache configuration.

createDirectory

public static IgfsDirectoryInfo createDirectory(IgniteUuid id)

Create empty directory with the given ID.

Parameters:

id - ID.

Returns:

File info.

createDirectory

public static IgfsDirectoryInfo createDirectory(IgniteUuid id,
                                @Nullable
                                Map<String,IgfsListingEntry> listing,
                                @Nullable
                                Map<String,String> props)

Create directory.

Parameters:

id - ID.

listing - Listing.

props - Properties.

Returns:

File info.

createDirectory

public static IgfsDirectoryInfo createDirectory(IgniteUuid id,
                                @Nullable
                                Map<String,IgfsListingEntry> listing,
                                @Nullable
                                Map<String,String> props,
                                long createTime,
                                long modificationTime)

Create directory.

Parameters:

id - ID.

listing - Listing.

props - Properties.

createTime - Create time.

modificationTime - Modification time.

Returns:

File info.

createFile

public static IgfsFileInfo createFile(IgniteUuid id,
                      int blockSize,
                      long len,
                      @Nullable
                      IgniteUuid affKey,
                      @Nullable
                      IgniteUuid lockId,
                      boolean evictExclude,
                      @Nullable
                      Map<String,String> props,
                      long accessTime,
                      long modificationTime)

Create file.

Parameters:

id - File ID.

blockSize - Block size.

len - Length.

affKey - Affinity key.

lockId - Lock ID.

evictExclude - Evict exclude flag.

props - Properties.

accessTime - Access time.

modificationTime - Modification time.

Returns:

File info.

writeListingEntry

public static void writeListingEntry(BinaryRawWriter out,
                     @Nullable
                     IgfsListingEntry entry)

Write listing entry.

Parameters:

out - Writer.

entry - Entry.

readListingEntry

@Nullable
public static IgfsListingEntry readListingEntry(BinaryRawReader in)

Read listing entry.

Parameters:

in - Reader.

Returns:

Entry.

writeListingEntry

public static void writeListingEntry(DataOutput out,
                     @Nullable
                     IgfsListingEntry entry)
                              throws IOException

Write listing entry.

Parameters:

out - Writer.

entry - Entry.

Throws:

IOException - If failed.

readListingEntry

@Nullable
public static IgfsListingEntry readListingEntry(DataInput in)
                                         throws IOException

Read listing entry.

Parameters:

in - Reader.

Returns:

Entry.

Throws:

IOException

writeProperties

public static void writeProperties(BinaryRawWriter out,
                   @Nullable
                   Map<String,String> props)

Write entry properties. Rely on reference equality for well-known properties.

Parameters:

out - Writer.

props - Properties.

readProperties

@Nullable
public static Map<String,String> readProperties(BinaryRawReader in)

Read entry properties.

Parameters:

in - Reader.

Returns:

Properties.

writeProperties

public static void writeProperties(DataOutput out,
                   @Nullable
                   Map<String,String> props)
                            throws IOException

Write entry properties. Rely on reference equality for well-known properties.

Parameters:

out - Writer.

props - Properties.

Throws:

IOException - If failed.

readProperties

@Nullable
public static Map<String,String> readProperties(DataInput in)
                                         throws IOException

Read entry properties.

Parameters:

in - Reader.

Returns:

Properties.

Throws:

IOException - If failed.

extractOriginalPathFromTrash

public static IgfsPath extractOriginalPathFromTrash(String name)

Parses the TRASH file name to extract the original path.

Parameters:

name - The TRASH short (entry) name.

Returns:

The original path, or null in case of failure.