public class SFTPFileSystem extends FileSystem
FileSystem.Statistics
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_BLOCK_SIZE |
static int |
DEFAULT_BUFFER_SIZE |
static String |
E_CREATE_DIR |
static String |
E_DIR_CREATE_FROMFILE |
static String |
E_DIR_NOTEMPTY |
static String |
E_DPATH_EXIST |
static String |
E_FAILED_DISCONNECT |
static String |
E_FAILED_GETHOME |
static String |
E_FILE_CHECK_FAILED |
static String |
E_FILE_EXIST |
static String |
E_FILE_NOTFOUND |
static String |
E_FILE_STATUS |
static String |
E_HOST_NULL |
static String |
E_MAKE_DIR_FORPATH |
static String |
E_NOT_SUPPORTED |
static String |
E_PATH_DIR |
static String |
E_SAME_DIRECTORY_ONLY |
static String |
E_SPATH_NOTEXIST |
static String |
E_USER_NULL |
static String |
FS_SFTP_CONNECTION_MAX |
static String |
FS_SFTP_HOST |
static String |
FS_SFTP_HOST_PORT |
static String |
FS_SFTP_KEYFILE |
static String |
FS_SFTP_PASSWORD_PREFIX |
static String |
FS_SFTP_USER_PREFIX |
static org.apache.commons.logging.Log |
LOG |
DEFAULT_FS, FS_DEFAULT_NAME_KEY, SHUTDOWN_HOOK_PRIORITY, statistics, TRASH_PREFIX
Constructor and Description |
---|
SFTPFileSystem() |
Modifier and Type | Method and Description |
---|---|
FSDataOutputStream |
append(Path f,
int bufferSize,
Progressable progress)
Append to an existing file (optional operation).
|
FSDataOutputStream |
create(Path f,
FsPermission permission,
boolean overwrite,
int bufferSize,
short replication,
long blockSize,
Progressable progress)
A stream obtained via this call must be closed before using other APIs of
this class or else the invocation will block.
|
boolean |
delete(Path f,
boolean recursive)
Delete a file.
|
FileStatus |
getFileStatus(Path f)
Return a file status object that represents the path.
|
Path |
getHomeDirectory()
Return the current user's home directory in this filesystem.
|
URI |
getUri()
Returns a URI whose scheme and authority identify this FileSystem.
|
Path |
getWorkingDirectory()
Get the current working directory for the given file system
|
void |
initialize(URI uriInfo,
Configuration conf)
Called after a new FileSystem instance is constructed.
|
FileStatus[] |
listStatus(Path f)
List the statuses of the files/directories in the given path if the path is
a directory.
|
boolean |
mkdirs(Path f,
FsPermission permission)
Make the given file and all non-existent parents into
directories.
|
FSDataInputStream |
open(Path f,
int bufferSize)
Opens an FSDataInputStream at the indicated Path.
|
boolean |
rename(Path src,
Path dst)
Renames Path src to Path dst.
|
void |
setWorkingDirectory(Path newDir)
Set the current working directory for the given file system.
|
addDelegationTokens, append, append, areSymlinksEnabled, cancelDeleteOnExit, canonicalizeUri, checkPath, clearStatistics, close, closeAll, closeAllForUGI, completeLocalOutput, concat, copyFromLocalFile, copyFromLocalFile, copyFromLocalFile, copyFromLocalFile, copyToLocalFile, copyToLocalFile, copyToLocalFile, create, create, create, create, create, create, create, create, create, create, create, create, createNewFile, createNonRecursive, createNonRecursive, createNonRecursive, createSnapshot, createSnapshot, createSymlink, delete, deleteOnExit, deleteSnapshot, enableSymlinks, exists, fixRelativePart, get, get, get, getAclStatus, getAllStatistics, getAllStoragePolicies, getBlockSize, getCanonicalServiceName, getCanonicalUri, getContentSummary, getDefaultBlockSize, getDefaultBlockSize, getDefaultPort, getDefaultReplication, getDefaultReplication, getDefaultUri, getFileBlockLocations, getFileBlockLocations, getFileChecksum, getFileChecksum, getFileLinkStatus, getFileSystemClass, getFSofPath, getGlobalStorageStatistics, getInitialWorkingDirectory, getLength, getLinkTarget, getLocal, getName, getNamed, getQuotaUsage, getReplication, getScheme, getServerDefaults, getServerDefaults, getStatistics, getStatistics, getStatus, getStatus, getStoragePolicy, getStorageStatistics, getTrashRoot, getTrashRoots, getUsed, getUsed, getXAttr, getXAttrs, getXAttrs, globStatus, globStatus, isDirectory, isFile, listCorruptFileBlocks, listFiles, listLocatedStatus, listLocatedStatus, listStatus, listStatus, listStatus, listStatusIterator, listXAttrs, makeQualified, mkdirs, mkdirs, modifyAclEntries, moveFromLocalFile, moveFromLocalFile, moveToLocalFile, newInstance, newInstance, newInstance, newInstanceLocal, open, primitiveCreate, primitiveMkdir, primitiveMkdir, printStatistics, processDeleteOnExit, removeAcl, removeAclEntries, removeDefaultAcl, removeXAttr, rename, renameSnapshot, resolveLink, resolvePath, setAcl, setDefaultUri, setDefaultUri, setOwner, setPermission, setReplication, setStoragePolicy, setTimes, setVerifyChecksum, setWriteChecksum, setXAttr, setXAttr, startLocalOutput, supportsSymlinks, truncate, unsetStoragePolicy
getConf, setConf
public static final org.apache.commons.logging.Log LOG
public static final int DEFAULT_BUFFER_SIZE
public static final int DEFAULT_BLOCK_SIZE
public static final String FS_SFTP_USER_PREFIX
public static final String FS_SFTP_PASSWORD_PREFIX
public static final String FS_SFTP_HOST
public static final String FS_SFTP_HOST_PORT
public static final String FS_SFTP_KEYFILE
public static final String FS_SFTP_CONNECTION_MAX
public static final String E_SAME_DIRECTORY_ONLY
public static final String E_HOST_NULL
public static final String E_USER_NULL
public static final String E_PATH_DIR
public static final String E_FILE_STATUS
public static final String E_FILE_NOTFOUND
public static final String E_FILE_EXIST
public static final String E_CREATE_DIR
public static final String E_DIR_CREATE_FROMFILE
public static final String E_MAKE_DIR_FORPATH
public static final String E_DIR_NOTEMPTY
public static final String E_FILE_CHECK_FAILED
public static final String E_NOT_SUPPORTED
public static final String E_SPATH_NOTEXIST
public static final String E_DPATH_EXIST
public static final String E_FAILED_GETHOME
public static final String E_FAILED_DISCONNECT
public SFTPFileSystem()
public void initialize(URI uriInfo, Configuration conf) throws IOException
FileSystem
initialize
in class FileSystem
uriInfo
- a uri whose authority section names the host, port, etc.
for this FileSystemconf
- the configurationIOException
public URI getUri()
FileSystem
getUri
in class FileSystem
public FSDataInputStream open(Path f, int bufferSize) throws IOException
FileSystem
open
in class FileSystem
f
- the file name to openbufferSize
- the size of the buffer to be used.IOException
public FSDataOutputStream create(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress) throws IOException
create
in class FileSystem
f
- the file name to openoverwrite
- if a file with this name already exists, then if true,
the file will be overwritten, and if false an error will be thrown.bufferSize
- the size of the buffer to be used.replication
- required block replication for the file.IOException
FileSystem.setPermission(Path, FsPermission)
public FSDataOutputStream append(Path f, int bufferSize, Progressable progress) throws IOException
FileSystem
append
in class FileSystem
f
- the existing file to be appended.bufferSize
- the size of the buffer to be used.progress
- for reporting progress if it is not null.IOException
public boolean rename(Path src, Path dst) throws IOException
FileSystem
rename
in class FileSystem
src
- path to be renameddst
- new path after renameIOException
- on failurepublic boolean delete(Path f, boolean recursive) throws IOException
FileSystem
delete
in class FileSystem
f
- the path to delete.recursive
- if path is a directory and set to
true, the directory is deleted else throws an exception. In
case of a file the recursive can be set to either true or false.IOException
public FileStatus[] listStatus(Path f) throws IOException
FileSystem
Does not guarantee to return the List of files/directories status in a sorted order.
listStatus
in class FileSystem
f
- given pathFileNotFoundException
- when the path does not exist;
IOException see specific implementationIOException
public void setWorkingDirectory(Path newDir)
FileSystem
setWorkingDirectory
in class FileSystem
public Path getWorkingDirectory()
FileSystem
getWorkingDirectory
in class FileSystem
public Path getHomeDirectory()
FileSystem
getHomeDirectory
in class FileSystem
public boolean mkdirs(Path f, FsPermission permission) throws IOException
FileSystem
mkdirs
in class FileSystem
f
- path to createpermission
- to apply to fIOException
public FileStatus getFileStatus(Path f) throws IOException
FileSystem
getFileStatus
in class FileSystem
f
- The path we want information fromFileNotFoundException
- when the path does not exist;
IOException see specific implementationIOException
Copyright © 2017 Apache Software Foundation. All Rights Reserved.