org.apache.hadoop.fs.swift.util

Class SwiftUtils

java.lang.Object

org.apache.hadoop.fs.swift.util.SwiftUtils

public final class SwiftUtils
extends Object

Various utility classes for SwiftFS support

Field Summary

Fields

Modifier and Type	Field and Description
static String	READ

Constructor Summary

Constructors

Constructor and Description
SwiftUtils()

Method Summary

Modifier and Type	Method and Description
static void	debug(org.apache.commons.logging.Log log, String text, Object... args) Sprintf() to the log iff the log is at debug level.
static void	debugEx(org.apache.commons.logging.Log log, String text, Exception ex) Log an exception (in text and trace) iff the log is at debug
static String	fileStatsToString(FileStatus[] stats, String separator) Take an array of filestats and convert to a string (prefixed w/ a [01] counter
static boolean	isDirectory(FileStatus fileStatus) This test contains the is-directory logic for Swift, so if changed there is only one place for it.
static boolean	isFilePretendingToBeDirectory(FileStatus fileStatus) Test for the entry being a file that is treated as if it is a directory
static boolean	isRootDir(SwiftObjectPath swiftObject) Predicate: Is a swift object referring to the root direcory?
static String	joinPaths(String path1, String path2) Join two (non null) paths, inserting a forward slash between them if needed
static String	ls(FileSystem fileSystem, Path path) List a a path to string
static String	partitionFilenameFromNumber(int partNumber) Given a partition number, calculate the partition value.
static void	trace(org.apache.commons.logging.Log log, String text, Object... args) Sprintf() to the log iff the log is at trace level.
static void	validateReadArgs(byte[] buffer, int off, int len) Verify that the basic args to a read operation are valid; throws an exception if not -with meaningful text includeing

Methods inherited from class java.lang.Object

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

Field Detail

READ

public static final String READ

See Also:

Constant Field Values

Constructor Detail

SwiftUtils

public SwiftUtils()

Method Detail

joinPaths

public static String joinPaths(String path1,
                               String path2)

Join two (non null) paths, inserting a forward slash between them if needed

Parameters:

path1 - first path

path2 - second path

Returns:

the combined path

isDirectory

public static boolean isDirectory(FileStatus fileStatus)

This test contains the is-directory logic for Swift, so if changed there is only one place for it.

Parameters:

fileStatus - status to examine

Returns:

true if we consider this status to be representative of a directory.

isFilePretendingToBeDirectory

public static boolean isFilePretendingToBeDirectory(FileStatus fileStatus)

Test for the entry being a file that is treated as if it is a directory

Parameters:

fileStatus - status

Returns:

true if it meets the rules for being a directory

isRootDir

public static boolean isRootDir(SwiftObjectPath swiftObject)

Predicate: Is a swift object referring to the root direcory?

Parameters:

swiftObject - object to probe

Returns:

true iff the object refers to the root

debug

public static void debug(org.apache.commons.logging.Log log,
                         String text,
                         Object... args)

Sprintf() to the log iff the log is at debug level. If the log is not at debug level, the printf operation is skipped, so no time is spent generating the string.

Parameters:

log - log to use

text - text message

args - args arguments to the print statement

debugEx

public static void debugEx(org.apache.commons.logging.Log log,
                           String text,
                           Exception ex)

Log an exception (in text and trace) iff the log is at debug

Parameters:

log - Log to use

text - text message

ex - exception

trace

public static void trace(org.apache.commons.logging.Log log,
                         String text,
                         Object... args)

Sprintf() to the log iff the log is at trace level. If the log is not at trace level, the printf operation is skipped, so no time is spent generating the string.

Parameters:

log - log to use

text - text message

args - args arguments to the print statement

partitionFilenameFromNumber

public static String partitionFilenameFromNumber(int partNumber)

Given a partition number, calculate the partition value. This is used in the SwiftNativeOutputStream, and is placed here for tests to be able to calculate the filename of a partition.

Parameters:

partNumber - part number

Returns:

a string to use as the filename

ls

public static String ls(FileSystem fileSystem,
                        Path path)
                 throws IOException

List a a path to string

Parameters:

fileSystem - filesystem

path - directory

Returns:

a listing of the filestatuses of elements in the directory, one to a line, precedeed by the full path of the directory

Throws:

IOException - connectivity problems

fileStatsToString

public static String fileStatsToString(FileStatus[] stats,
                                       String separator)

Take an array of filestats and convert to a string (prefixed w/ a [01] counter

Parameters:

stats - array of stats

separator - separator after every entry

Returns:

a stringified set

validateReadArgs

public static void validateReadArgs(byte[] buffer,
                                    int off,
                                    int len)

Verify that the basic args to a read operation are valid; throws an exception if not -with meaningful text includeing

Parameters:

buffer - destination buffer

off - offset

len - number of bytes to read

Throws:

NullPointerException - null buffer

IndexOutOfBoundsException - on any invalid range.