Module com.github.robtimus.filesystems.sftp

Package com.github.robtimus.filesystems.sftp

Class DefaultFileSystemExceptionFactory

java.lang.Object

com.github.robtimus.filesystems.sftp.DefaultFileSystemExceptionFactory

All Implemented Interfaces:

FileSystemExceptionFactory

public class DefaultFileSystemExceptionFactory
extends Object
implements FileSystemExceptionFactory

A default FileSystemExceptionFactory that will return a NoSuchFileException if the id of the SftpException is ChannelSftp.SSH_FX_NO_SUCH_FILE, an AccessDeniedException if it's ChannelSftp.SSH_FX_PERMISSION_DENIED, or a FileSystemException otherwise, unless specified otherwise.

Author:

Rob Spoor

Constructor Summary

Constructors

Constructor	Description
DefaultFileSystemExceptionFactory()

Method Summary

Modifier and Type	Method	Description
FileSystemException	createChangeWorkingDirectoryException(String directory, SftpException exception)	Creates a FileSystemException that indicates a directory cannot be used as the current working directory.
FileSystemException	createCopyException(String file, String other, SftpException exception)	Creates a FileSystemException that indicates a file or directory cannot be copied.
FileSystemException	createCreateDirectoryException(String directory, SftpException exception)	Creates a FileSystemException that indicates a directory cannot be created.
FileSystemException	createDeleteException(String file, SftpException exception, boolean isDirectory)	Creates a FileSystemException that indicates a file or directory cannot be deleted.
FileSystemException	createGetFileException(String file, SftpException exception)	Creates a FileSystemException that indicates a file or directory cannot be retrieved.
FileSystemException	createListFilesException(String directory, SftpException exception)	Creates a FileSystemException that indicates the contents of a directory cannot be retrieved.
FileSystemException	createMoveException(String file, String other, SftpException exception)	Creates a FileSystemException that indicates a file or directory cannot be moved.
FileSystemException	createNewInputStreamException(String file, SftpException exception)	Creates a FileSystemException that indicates a file cannot be opened for reading.
FileSystemException	createNewOutputStreamException(String file, SftpException exception, Collection<? extends OpenOption> options)	Creates a FileSystemException that indicates a file cannot be opened for writing.
FileSystemException	createReadLinkException(String link, SftpException exception)	Creates a FileSystemException that indicates a symbolic link cannot be read.
FileSystemException	createSetGroupException(String file, SftpException exception)	Creates a FileSystemException that indicates the group of a file or directory cannot be set.
FileSystemException	createSetModificationTimeException(String file, SftpException exception)	Creates a FileSystemException that indicates the modification time of a file or directory cannot be set.
FileSystemException	createSetOwnerException(String file, SftpException exception)	Creates a FileSystemException that indicates the owner of a file or directory cannot be set.
FileSystemException	createSetPermissionsException(String file, SftpException exception)	Creates a FileSystemException that indicates the permissions of a file or directory cannot be set.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFileSystemExceptionFactory

public DefaultFileSystemExceptionFactory()

Method Detail

createGetFileException

public FileSystemException createGetFileException(String file,
                                                  SftpException exception)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates a file or directory cannot be retrieved.

Specified by:

createGetFileException in interface FileSystemExceptionFactory

Parameters:

file - A string identifying the file or directory.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.

createReadLinkException

public FileSystemException createReadLinkException(String link,
                                                   SftpException exception)

Creates a FileSystemException that indicates a symbolic link cannot be read.

If the id of the SftpException is not ChannelSftp.SSH_FX_NO_SUCH_FILE or ChannelSftp.SSH_FX_PERMISSION_DENIED, this default implementation does not return a FileSystemException, but a NotLinkException instead.

Specified by:

createReadLinkException in interface FileSystemExceptionFactory

Parameters:

link - A string identifying the symbolic link.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.

createListFilesException

public FileSystemException createListFilesException(String directory,
                                                    SftpException exception)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates the contents of a directory cannot be retrieved.

Specified by:

createListFilesException in interface FileSystemExceptionFactory

Parameters:

directory - A string identifying the directory.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.

createChangeWorkingDirectoryException

public FileSystemException createChangeWorkingDirectoryException(String directory,
                                                                 SftpException exception)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates a directory cannot be used as the current working directory.

Specified by:

createChangeWorkingDirectoryException in interface FileSystemExceptionFactory

Parameters:

directory - A string identifying the directory.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.

createCreateDirectoryException

public FileSystemException createCreateDirectoryException(String directory,
                                                          SftpException exception)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates a directory cannot be created.

Specified by:

createCreateDirectoryException in interface FileSystemExceptionFactory

Parameters:

directory - A string identifying the directory.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.

createDeleteException

public FileSystemException createDeleteException(String file,
                                                 SftpException exception,
                                                 boolean isDirectory)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates a file or directory cannot be deleted.

Specified by:

createDeleteException in interface FileSystemExceptionFactory

Parameters:

file - A string identifying the file or directory.

exception - The SftpException that was thrown.

isDirectory - true if a directory cannot be deleted, or false if a file cannot be deleted.

Returns:

The created FileSystemException.

createNewInputStreamException

public FileSystemException createNewInputStreamException(String file,
                                                         SftpException exception)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates a file cannot be opened for reading.

Specified by:

createNewInputStreamException in interface FileSystemExceptionFactory

Parameters:

file - A string identifying the file.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.

createNewOutputStreamException

public FileSystemException createNewOutputStreamException(String file,
                                                          SftpException exception,
                                                          Collection<? extends OpenOption> options)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates a file cannot be opened for writing.

Specified by:

createNewOutputStreamException in interface FileSystemExceptionFactory

Parameters:

file - A string identifying the file.

exception - The SftpException that was thrown.

options - The open options used to open the file.

Returns:

The created FileSystemException.

createCopyException

public FileSystemException createCopyException(String file,
                                               String other,
                                               SftpException exception)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates a file or directory cannot be copied.

Specified by:

createCopyException in interface FileSystemExceptionFactory

Parameters:

file - A string identifying the file or directory to be copied.

other - A string identifying the file or directory to be copied to.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.

createMoveException

public FileSystemException createMoveException(String file,
                                               String other,
                                               SftpException exception)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates a file or directory cannot be moved.

Specified by:

createMoveException in interface FileSystemExceptionFactory

Parameters:

file - A string identifying the file or directory to be moved.

other - A string identifying the file or directory to be moved to.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.

createSetOwnerException

public FileSystemException createSetOwnerException(String file,
                                                   SftpException exception)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates the owner of a file or directory cannot be set.

Specified by:

createSetOwnerException in interface FileSystemExceptionFactory

Parameters:

file - A string identifying the file or directory to set the owner of.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.

createSetGroupException

public FileSystemException createSetGroupException(String file,
                                                   SftpException exception)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates the group of a file or directory cannot be set.

Specified by:

createSetGroupException in interface FileSystemExceptionFactory

Parameters:

file - A string identifying the file or directory to set the group of.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.

createSetPermissionsException

public FileSystemException createSetPermissionsException(String file,
                                                         SftpException exception)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates the permissions of a file or directory cannot be set.

Specified by:

createSetPermissionsException in interface FileSystemExceptionFactory

Parameters:

file - A string identifying the file or directory to set the permissions of.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.

createSetModificationTimeException

public FileSystemException createSetModificationTimeException(String file,
                                                              SftpException exception)

Description copied from interface: FileSystemExceptionFactory

Creates a FileSystemException that indicates the modification time of a file or directory cannot be set.

Specified by:

createSetModificationTimeException in interface FileSystemExceptionFactory

Parameters:

file - A string identifying the file or directory to set the modification time of.

exception - The SftpException that was thrown.

Returns:

The created FileSystemException.