org.apache.sshd.common.util.io

Class IoUtils

java.lang.Object

org.apache.sshd.common.util.io.IoUtils

public final class IoUtils
extends Object

TODO Add javadoc

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COPY_SIZE
static CopyOption[]	EMPTY_COPY_OPTIONS
static LinkOption[]	EMPTY_LINK_OPTIONS
static OpenOption[]	EMPTY_OPEN_OPTIONS
static List<String>	WINDOWS_EXECUTABLE_EXTENSIONS

Method Summary

Modifier and Type	Method and Description
static Boolean	checkFileExists(Path path, LinkOption... options) Checks if a file exists - Note: according to the Java tutorial - Checking a File or Directory:
static void	closeQuietly(Closeable... closeables)
static long	copy(InputStream source, OutputStream sink)
static long	copy(InputStream source, OutputStream sink, int bufferSize)
static Path	ensureDirectory(Path path, LinkOption... options)
static boolean	followLinks(LinkOption... options)
static LinkOption[]	getLinkOptions(boolean followLinks)
static Set<PosixFilePermission>	getPermissions(Path path, LinkOption... options) If the "posix" view is supported, then it returns Files.getPosixFilePermissions(Path, LinkOption...), otherwise uses the getPermissionsFromFile(File) method
static Set<PosixFilePermission>	getPermissionsFromFile(File f)
static boolean	isWindowsExecutable(String fileName)
static int	read(InputStream input, byte[] buffer) Read as many bytes as possible until EOF or achieved required length
static int	read(InputStream input, byte[] buffer, int offset, int length) Read as many bytes as possible until EOF or achieved required length
static void	readFully(InputStream input, byte[] buffer) Read the requested number of bytes or fail if there are not enough left.
static void	readFully(InputStream input, byte[] buffer, int offset, int length) Read the requested number of bytes or fail if there are not enough left.
static void	setPermissions(Path path, Set<PosixFilePermission> perms) If the "posix" view is supported, then it invokes Files.setPosixFilePermissions(Path, Set), otherwise uses the setPermissionsToFile(File, Collection) method
static void	setPermissionsToFile(File f, Collection<PosixFilePermission> perms)
static PosixFilePermission	validateExcludedPermissions(Collection<PosixFilePermission> perms, Collection<PosixFilePermission> excluded)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_OPEN_OPTIONS

public static final OpenOption[] EMPTY_OPEN_OPTIONS

EMPTY_COPY_OPTIONS

public static final CopyOption[] EMPTY_COPY_OPTIONS

EMPTY_LINK_OPTIONS

public static final LinkOption[] EMPTY_LINK_OPTIONS

WINDOWS_EXECUTABLE_EXTENSIONS

public static final List<String> WINDOWS_EXECUTABLE_EXTENSIONS

DEFAULT_COPY_SIZE

public static final int DEFAULT_COPY_SIZE

See Also:

Constant Field Values

Method Detail

getLinkOptions

public static LinkOption[] getLinkOptions(boolean followLinks)

copy

public static long copy(InputStream source,
                        OutputStream sink)
                 throws IOException

Throws:

IOException

copy

public static long copy(InputStream source,
                        OutputStream sink,
                        int bufferSize)
                 throws IOException

Throws:

IOException

closeQuietly

public static void closeQuietly(Closeable... closeables)

isWindowsExecutable

public static boolean isWindowsExecutable(String fileName)

Parameters:

fileName - The file name to be evaluated - ignored if null/empty

Returns:

true if the file ends in one of the WINDOWS_EXECUTABLE_EXTENSIONS

getPermissions

public static Set<PosixFilePermission> getPermissions(Path path,
                                                      LinkOption... options)
                                               throws IOException

If the "posix" view is supported, then it returns Files.getPosixFilePermissions(Path, LinkOption...), otherwise uses the getPermissionsFromFile(File) method

Parameters:

path - The Path

options - The LinkOptions to use when querying the permissions

Returns:

A Set of PosixFilePermission

Throws:

IOException - If failed to access the file system in order to retrieve the permissions

getPermissionsFromFile

public static Set<PosixFilePermission> getPermissionsFromFile(File f)

Parameters:

f - The File to be checked

Returns:

A Set of PosixFilePermissions based on whether the file is readable/writable/executable. If so, then all the relevant permissions are set (i.e., owner, group and others)

setPermissions

public static void setPermissions(Path path,
                                  Set<PosixFilePermission> perms)
                           throws IOException

If the "posix" view is supported, then it invokes Files.setPosixFilePermissions(Path, Set), otherwise uses the setPermissionsToFile(File, Collection) method

Parameters:

path - The Path

perms - The Set of PosixFilePermissions

Throws:

IOException - If failed to access the file system

setPermissionsToFile

public static void setPermissionsToFile(File f,
                                        Collection<PosixFilePermission> perms)

Parameters:

f - The File

perms - A Collection of PosixFilePermissions to set on it. Note: the file is set to readable/writable/executable not only by the owner if any of relevant the owner/group/others permission is set

checkFileExists

public static Boolean checkFileExists(Path path,
                                      LinkOption... options)

Checks if a file exists - Note: according to the Java tutorial - Checking a File or Directory:

 The methods in the Path class are syntactic, meaning that they operate
 on the Path instance. But eventually you must access the file system
 to verify that a particular Path exists, or does not exist. You can do
 so with the exists(Path, LinkOption...) and the notExists(Path, LinkOption...)
 methods. Note that !Files.exists(path) is not equivalent to Files.notExists(path).
 When you are testing a file's existence, three results are possible:

 - The file is verified to exist.
 - The file is verified to not exist.
 - The file's status is unknown.

 This result can occur when the program does not have access to the file.
 If both exists and notExists return false, the existence of the file cannot
 be verified.
 

Parameters:

path - The Path to be tested

options - The LinkOptions to use

Returns:

Boolean.TRUE/Boolean.FALSE or null according to the file status as explained above

readFully

public static void readFully(InputStream input,
                             byte[] buffer)
                      throws IOException

Read the requested number of bytes or fail if there are not enough left.

Parameters:

input - where to read input from

buffer - destination

Throws:

IOException - if there is a problem reading the file

EOFException - if the number of bytes read was incorrect

readFully

public static void readFully(InputStream input,
                             byte[] buffer,
                             int offset,
                             int length)
                      throws IOException

Read the requested number of bytes or fail if there are not enough left.

Parameters:

input - where to read input from

buffer - destination

offset - initial offset into buffer

length - length to read, must be ≥ 0

Throws:

IOException - if there is a problem reading the file

EOFException - if the number of bytes read was incorrect

read

public static int read(InputStream input,
                       byte[] buffer)
                throws IOException

Read as many bytes as possible until EOF or achieved required length

Parameters:

input - where to read input from

buffer - destination

Returns:

actual length read; may be less than requested if EOF was reached

Throws:

IOException - if a read error occurs

read

public static int read(InputStream input,
                       byte[] buffer,
                       int offset,
                       int length)
                throws IOException

Read as many bytes as possible until EOF or achieved required length

Parameters:

input - where to read input from

buffer - destination

offset - initial offset into buffer

length - length to read - ignored if non-positive

Returns:

actual length read; may be less than requested if EOF was reached

Throws:

IOException - if a read error occurs

validateExcludedPermissions

public static PosixFilePermission validateExcludedPermissions(Collection<PosixFilePermission> perms,
                                                              Collection<PosixFilePermission> excluded)

Parameters:

perms - The current PosixFilePermissions - ignored if null/empty

excluded - The permissions not allowed to exist - ignored if null/empty

Returns:

The violating PosixFilePermission - null if no violating permission found

ensureDirectory

public static Path ensureDirectory(Path path,
                                   LinkOption... options)

Parameters:

path - The Path to check

options - The LinkOptions to use when checking if path is a directory

Returns:

The same input path if it is a directory

Throws:

UnsupportedOperationException - if input path not a directory

followLinks

public static boolean followLinks(LinkOption... options)

Parameters:

options - The LinkOptions - OK if null/empty

Returns:

true if the link options are null/empty or do not contain LinkOption.NOFOLLOW_LINKS, false otherwise (i.e., the array is not empty and contains the special value)