Package 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	Description
static String	ACL_VIEW_ATTR
static String	CREATE_TIME_VIEW_ATTR
static int	DEFAULT_COPY_SIZE	Size of preferred work buffer when reading / writing data to / from streams
static String	DIRECTORY_VIEW_ATTR
static CopyOption[]	EMPTY_COPY_OPTIONS
static FileAttribute<?>[]	EMPTY_FILE_ATTRIBUTES
static LinkOption[]	EMPTY_LINK_OPTIONS
static OpenOption[]	EMPTY_OPEN_OPTIONS
static String	EOL	The local O/S line separator
static String	EXECUTABLE_VIEW_ATTR
static String	EXTENDED_VIEW_ATTR
static String	FILEKEY_VIEW_ATTR
static String	GROUP_VIEW_ATTR
static String	GROUPID_VIEW_ATTR
static String	LASTACC_TIME_VIEW_ATTR
static String	LASTMOD_TIME_VIEW_ATTR
static String	NUMLINKS_VIEW_ATTR
static String	OTHERFILE_VIEW_ATTR
static String	OWNER_VIEW_ATTR
static String	PERMISSIONS_VIEW_ATTR
static String	REGFILE_VIEW_ATTR
static String	SIZE_VIEW_ATTR
static String	SYMLINK_VIEW_ATTR
static String	USERID_VIEW_ATTR
static List<String>	WINDOWS_EXECUTABLE_EXTENSIONS
static Set<StandardOpenOption>	WRITEABLE_OPEN_OPTIONS	A Set of StandardOpenOption-s that indicate an intent to create/modify a file

Method Summary

Modifier and Type	Method	Description
static String	appendPathComponent(String prefix, String component)
static Boolean	checkFileExists(Path path, LinkOption... options)	Checks if a file exists - Note: according to the Java tutorial - Checking a File or Directory:
static IOException	closeQuietly(Closeable c)	Closes the specified Closeable resource
static IOException	closeQuietly(Closeable... closeables)	Closes a bunch of resources suppressing any IOExceptions their Closeable.close() method may have thrown
static IOException	closeQuietly(Collection<? extends Closeable> closeables)	Closes a bunch of resources suppressing any IOExceptions their Closeable.close() method may have thrown
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 byte[]	getEOLBytes()
static String	getFileOwner(Path path, LinkOption... options)	Get file owner.
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	isExecutable(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 List<String>	readAllLines(BufferedReader reader)	Reads all lines until no more available
static List<String>	readAllLines(BufferedReader reader, int lineCountHint)	Reads all lines until no more available
static List<String>	readAllLines(InputStream stream)	Reads all lines until no more available
static List<String>	readAllLines(Reader reader)
static List<String>	readAllLines(URL url)	Reads all lines until no more available
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 byte[]	toByteArray(InputStream inStream)
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

EMPTY_FILE_ATTRIBUTES

public static final FileAttribute<?>[] EMPTY_FILE_ATTRIBUTES

WINDOWS_EXECUTABLE_EXTENSIONS

public static final List<String> WINDOWS_EXECUTABLE_EXTENSIONS

REGFILE_VIEW_ATTR

public static final String REGFILE_VIEW_ATTR

See Also:

Constant Field Values

DIRECTORY_VIEW_ATTR

public static final String DIRECTORY_VIEW_ATTR

See Also:

Constant Field Values

SYMLINK_VIEW_ATTR

public static final String SYMLINK_VIEW_ATTR

See Also:

Constant Field Values

NUMLINKS_VIEW_ATTR

public static final String NUMLINKS_VIEW_ATTR

See Also:

Constant Field Values

OTHERFILE_VIEW_ATTR

public static final String OTHERFILE_VIEW_ATTR

See Also:

Constant Field Values

EXECUTABLE_VIEW_ATTR

public static final String EXECUTABLE_VIEW_ATTR

See Also:

Constant Field Values

SIZE_VIEW_ATTR

public static final String SIZE_VIEW_ATTR

See Also:

Constant Field Values

OWNER_VIEW_ATTR

public static final String OWNER_VIEW_ATTR

See Also:

Constant Field Values

GROUP_VIEW_ATTR

public static final String GROUP_VIEW_ATTR

See Also:

Constant Field Values

USERID_VIEW_ATTR

public static final String USERID_VIEW_ATTR

See Also:

Constant Field Values

GROUPID_VIEW_ATTR

public static final String GROUPID_VIEW_ATTR

See Also:

Constant Field Values

PERMISSIONS_VIEW_ATTR

public static final String PERMISSIONS_VIEW_ATTR

See Also:

Constant Field Values

ACL_VIEW_ATTR

public static final String ACL_VIEW_ATTR

See Also:

Constant Field Values

FILEKEY_VIEW_ATTR

public static final String FILEKEY_VIEW_ATTR

See Also:

Constant Field Values

CREATE_TIME_VIEW_ATTR

public static final String CREATE_TIME_VIEW_ATTR

See Also:

Constant Field Values

LASTMOD_TIME_VIEW_ATTR

public static final String LASTMOD_TIME_VIEW_ATTR

See Also:

Constant Field Values

LASTACC_TIME_VIEW_ATTR

public static final String LASTACC_TIME_VIEW_ATTR

See Also:

Constant Field Values

EXTENDED_VIEW_ATTR

public static final String EXTENDED_VIEW_ATTR

See Also:

Constant Field Values

DEFAULT_COPY_SIZE

public static final int DEFAULT_COPY_SIZE

Size of preferred work buffer when reading / writing data to / from streams

See Also:

Constant Field Values

EOL

public static final String EOL

The local O/S line separator

WRITEABLE_OPEN_OPTIONS

public static final Set<StandardOpenOption> WRITEABLE_OPEN_OPTIONS

A Set of StandardOpenOption-s that indicate an intent to create/modify a file

Method Detail

getEOLBytes

public static byte[] getEOLBytes()

Returns:

The local platform line separator bytes as UTF-8. Note: each call returns a new instance in order to avoid inadvertent changes in shared objects

See Also:

EOL

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 IOException closeQuietly(Closeable... closeables)

Closes a bunch of resources suppressing any IOExceptions their Closeable.close() method may have thrown

Parameters:

closeables - The Closeables to close

Returns:

The first IOException that occurred during closing of a resource - null if not exception. If more than one exception occurred, they are added as suppressed exceptions to the first one

See Also:

Throwable.getSuppressed()

closeQuietly

public static IOException closeQuietly(Closeable c)

Closes the specified Closeable resource

Parameters:

c - The resource to close - ignored if null

Returns:

The thrown IOException when close() was called - null if no exception was thrown (or no resource to close to begin with)

closeQuietly

public static IOException closeQuietly(Collection<? extends Closeable> closeables)

Closes a bunch of resources suppressing any IOExceptions their Closeable.close() method may have thrown

Parameters:

closeables - The Closeables to close

Returns:

The first IOException that occurred during closing of a resource - null if not exception. If more than one exception occurred, they are added as suppressed exceptions to the first one

See Also:

Throwable.getSuppressed()

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)

isExecutable

public static boolean isExecutable(File f)

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

getFileOwner

public static String getFileOwner(Path path,
                                  LinkOption... options)
                           throws IOException

Get file owner.

Parameters:

path - The Path

options - The LinkOptions to use when querying the owner

Returns:

Owner of the file or null if unsupported. Note: for Windows it strips any prepended domain or group name

Throws:

IOException - If failed to access the file system

See Also:

Files.getOwner(Path, LinkOption...)

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)

appendPathComponent

public static String appendPathComponent(String prefix,
                                         String component)

toByteArray

public static byte[] toByteArray(InputStream inStream)
                          throws IOException

Throws:

IOException

readAllLines

public static List<String> readAllLines(URL url)
                                 throws IOException

Reads all lines until no more available

Parameters:

url - The URL to read from

Returns:

The List of lines in the same order as it was read

Throws:

IOException - If failed to read the lines

See Also:

readAllLines(InputStream)

readAllLines

public static List<String> readAllLines(InputStream stream)
                                 throws IOException

Reads all lines until no more available

Parameters:

stream - The InputStream - Note: assumed to contain UTF-8 encoded data

Returns:

The List of lines in the same order as it was read

Throws:

IOException - If failed to read the lines

See Also:

readAllLines(Reader)

readAllLines

public static List<String> readAllLines(Reader reader)
                                 throws IOException

Throws:

IOException

readAllLines

public static List<String> readAllLines(BufferedReader reader)
                                 throws IOException

Reads all lines until no more available

Parameters:

reader - The BufferedReader to read all lines

Returns:

The List of lines in the same order as it was read

Throws:

IOException - If failed to read the lines

See Also:

readAllLines(BufferedReader, int)

readAllLines

public static List<String> readAllLines(BufferedReader reader,
                                        int lineCountHint)
                                 throws IOException

Reads all lines until no more available

Parameters:

reader - The BufferedReader to read all lines

lineCountHint - A hint as to the expected number of lines - non-positive means unknown - in which case some initial default value will be used to initialize the list used to accumulate the lines.

Returns:

The List of lines in the same order as it was read

Throws:

IOException - If failed to read the lines