Package com.sshtools.common.files

Interface AbstractFile

All Known Implementing Classes:

AbstractDirectFile, AbstractFileAdapter, AbstractFileImpl, DirectFile, DirectFileJava7, NioFile, ReadOnlyFileFactory.ReadOnlyAbstractFile

public interface AbstractFile

Method Summary

Modifier and Type	Method	Description
default void	copyFrom(AbstractFile src)
boolean	createFolder()
boolean	createNewFile()
boolean	delete(boolean recursive)
boolean	exists()
default boolean	existsNoFollowLinks()
String	getAbsolutePath()
SftpFileAttributes	getAttributes()
default SftpFileAttributes	getAttributesNoFollowLinks()
String	getCanonicalPath()
List<AbstractFile>	getChildren()
AbstractFileFactory<? extends AbstractFile>	getFileFactory()
InputStream	getInputStream()
String	getName()
OutputStream	getOutputStream()
OutputStream	getOutputStream(boolean append)
AbstractFile	getParentFile()
default FileVolume	getVolume()
boolean	isDirectory()
boolean	isFile()
boolean	isHidden()
boolean	isReadable()
boolean	isWritable()
long	lastModified()
long	length()
default void	linkFrom(String target)
default void	linkTo(String target)	Deprecated, for removal: This API element is subject to removal in a future version.
default void	moveTo(AbstractFile target)
default OpenFile	open(com.sshtools.common.util.UnsignedInteger32 flags, Optional<com.sshtools.common.util.UnsignedInteger32> accessFlags, byte[] handle)
AbstractFileRandomAccess	openFile(boolean writeAccess)
default String	readSymbolicLink()
void	refresh()
AbstractFile	resolveFile(String child)
void	setAttributes(SftpFileAttributes attrs)
default MultipartTransfer	startMultipartUpload(AbstractFile targetFile)
default boolean	supportsMultipartTransfers()
boolean	supportsRandomAccess()
default void	symlinkFrom(String target)
default void	symlinkTo(String target)	Deprecated, for removal: This API element is subject to removal in a future version.
void	truncate()

Method Details

getName

String getName()

getInputStream

InputStream getInputStream()
                    throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

exists

boolean exists()
        throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

existsNoFollowLinks

default boolean existsNoFollowLinks()
                             throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

getChildren

List<AbstractFile> getChildren()
                        throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

getAbsolutePath

String getAbsolutePath()
                throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

getParentFile

AbstractFile getParentFile()
                    throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

isDirectory

boolean isDirectory()
             throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

isFile

boolean isFile()
        throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

getOutputStream

OutputStream getOutputStream()
                      throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

isHidden

boolean isHidden()
          throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

createFolder

boolean createFolder()
              throws PermissionDeniedException,
IOException

Throws:

PermissionDeniedException

IOException

isReadable

boolean isReadable()
            throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

delete

boolean delete(boolean recursive)
        throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

getAttributes

SftpFileAttributes getAttributes()
                          throws FileNotFoundException,
IOException,
PermissionDeniedException

Throws:

FileNotFoundException

IOException

PermissionDeniedException

getAttributesNoFollowLinks

default SftpFileAttributes getAttributesNoFollowLinks()
                                               throws FileNotFoundException,
IOException,
PermissionDeniedException

Throws:

FileNotFoundException

IOException

PermissionDeniedException

refresh

void refresh()

lastModified

long lastModified()
           throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

length

long length()
     throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

isWritable

boolean isWritable()
            throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

createNewFile

boolean createNewFile()
               throws PermissionDeniedException,
IOException

Throws:

PermissionDeniedException

IOException

truncate

void truncate()
       throws PermissionDeniedException,
IOException

Throws:

PermissionDeniedException

IOException

setAttributes

void setAttributes(SftpFileAttributes attrs)
            throws IOException

Throws:

IOException

getCanonicalPath

String getCanonicalPath()
                 throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

supportsRandomAccess

boolean supportsRandomAccess()

open

default OpenFile open(com.sshtools.common.util.UnsignedInteger32 flags,
 Optional<com.sshtools.common.util.UnsignedInteger32> accessFlags,
 byte[] handle)
               throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

openFile

AbstractFileRandomAccess openFile(boolean writeAccess)
                           throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

getOutputStream

OutputStream getOutputStream(boolean append)
                      throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

resolveFile

AbstractFile resolveFile(String child)
                  throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

getFileFactory

AbstractFileFactory<? extends AbstractFile> getFileFactory()

symlinkTo

@Deprecated(since="3.1.0",
            forRemoval=true)
default void symlinkTo(String target)
                throws IOException,
PermissionDeniedException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

PermissionDeniedException

symlinkFrom

default void symlinkFrom(String target)
                  throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

linkTo

@Deprecated(since="3.1.0",
            forRemoval=true)
default void linkTo(String target)
             throws IOException,
PermissionDeniedException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

PermissionDeniedException

linkFrom

default void linkFrom(String target)
               throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

readSymbolicLink

default String readSymbolicLink()
                         throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

supportsMultipartTransfers

default boolean supportsMultipartTransfers()

startMultipartUpload

default MultipartTransfer startMultipartUpload(AbstractFile targetFile)
                                        throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

copyFrom

default void copyFrom(AbstractFile src)
               throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

moveTo

default void moveTo(AbstractFile target)
             throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

getVolume

default FileVolume getVolume()
                      throws IOException

Throws:

IOException