org.apache.hadoop.fs.ftp

クラス FTPFileSystem

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.FileSystem

org.apache.hadoop.fs.ftp.FTPFileSystem

すべての実装されたインタフェース:

Closeable, AutoCloseable, Configurable

@InterfaceAudience.Public
 @InterfaceStability.Stable
public class FTPFileSystem
extends FileSystem

A FileSystem backed by an FTP client provided by Apache Commons Net.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static int	DEFAULT_BLOCK_SIZE
static int	DEFAULT_BUFFER_SIZE
static String	E_SAME_DIRECTORY_ONLY
static String	FS_FTP_HOST
static String	FS_FTP_HOST_PORT
static String	FS_FTP_PASSWORD_PREFIX
static String	FS_FTP_USER_PREFIX
static org.apache.commons.logging.Log	LOG

クラスから継承されたフィールド org.apache.hadoop.fs.FileSystem

DEFAULT_FS, FS_DEFAULT_NAME_KEY, SHUTDOWN_HOOK_PRIORITY, statistics, TRASH_PREFIX

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FTPFileSystem()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
FSDataOutputStream	append(Path f, int bufferSize, Progressable progress) This optional operation is not yet supported.
FSDataOutputStream	create(Path file, 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 file, boolean recursive) Delete a file.
protected int	getDefaultPort() Get the default port for this FTPFileSystem.
FileStatus	getFileStatus(Path file) Return a file status object that represents the path.
Path	getHomeDirectory() Return the current user's home directory in this filesystem.
String	getScheme() Return the protocol scheme for the 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 uri, Configuration conf) Called after a new FileSystem instance is constructed.
FileStatus[]	listStatus(Path file) List the statuses of the files/directories in the given path if the path is a directory.
boolean	mkdirs(Path file, FsPermission permission) Make the given file and all non-existent parents into directories.
FSDataInputStream	open(Path file, 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.

クラスから継承されたメソッド org.apache.hadoop.fs.FileSystem

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, getCanonicalUri, getContentSummary, getDefaultBlockSize, getDefaultBlockSize, getDefaultReplication, getDefaultReplication, getDefaultUri, getFileBlockLocations, getFileBlockLocations, getFileChecksum, getFileChecksum, getFileLinkStatus, getFileSystemClass, getFSofPath, getGlobalStorageStatistics, getInitialWorkingDirectory, getLength, getLinkTarget, getLocal, getName, getNamed, getQuotaUsage, getReplication, 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

クラスから継承されたメソッド org.apache.hadoop.conf.Configured

getConf, setConf

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

LOG

public static final org.apache.commons.logging.Log LOG

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

関連項目:

定数フィールド値

DEFAULT_BLOCK_SIZE

public static final int DEFAULT_BLOCK_SIZE

関連項目:

定数フィールド値

FS_FTP_USER_PREFIX

public static final String FS_FTP_USER_PREFIX

関連項目:

定数フィールド値

FS_FTP_HOST

public static final String FS_FTP_HOST

関連項目:

定数フィールド値

FS_FTP_HOST_PORT

public static final String FS_FTP_HOST_PORT

関連項目:

定数フィールド値

FS_FTP_PASSWORD_PREFIX

public static final String FS_FTP_PASSWORD_PREFIX

関連項目:

定数フィールド値

E_SAME_DIRECTORY_ONLY

public static final String E_SAME_DIRECTORY_ONLY

関連項目:

定数フィールド値

コンストラクタの詳細

FTPFileSystem

public FTPFileSystem()

メソッドの詳細

getScheme

public String getScheme()

Return the protocol scheme for the FileSystem.

オーバーライド:

getScheme クラス内 FileSystem

戻り値:

ftp

getDefaultPort

protected int getDefaultPort()

Get the default port for this FTPFileSystem.

オーバーライド:

getDefaultPort クラス内 FileSystem

戻り値:

the default port

initialize

public void initialize(URI uri,
                       Configuration conf)
                throws IOException

クラスからコピーされた説明: FileSystem

Called after a new FileSystem instance is constructed.

オーバーライド:

initialize クラス内 FileSystem

パラメータ:

uri - a uri whose authority section names the host, port, etc. for this FileSystem

conf - the configuration

例外:

IOException

open

public FSDataInputStream open(Path file,
                              int bufferSize)
                       throws IOException

クラスからコピーされた説明: FileSystem

Opens an FSDataInputStream at the indicated Path.

定義:

open クラス内 FileSystem

パラメータ:

file - the file name to open

bufferSize - the size of the buffer to be used.

例外:

IOException

create

public FSDataOutputStream create(Path file,
                                 FsPermission permission,
                                 boolean overwrite,
                                 int bufferSize,
                                 short replication,
                                 long blockSize,
                                 Progressable progress)
                          throws IOException

A stream obtained via this call must be closed before using other APIs of this class or else the invocation will block.

定義:

create クラス内 FileSystem

パラメータ:

file - the file name to open

permission - file permission

overwrite - 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.

blockSize - block size

progress - the progress reporter

例外:

IOException

関連項目:

FileSystem.setPermission(Path, FsPermission)

append

public FSDataOutputStream append(Path f,
                                 int bufferSize,
                                 Progressable progress)
                          throws IOException

This optional operation is not yet supported.

定義:

append クラス内 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

delete

public boolean delete(Path file,
                      boolean recursive)
               throws IOException

クラスからコピーされた説明: FileSystem

Delete a file.

定義:

delete クラス内 FileSystem

パラメータ:

file - 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.

戻り値:

true if delete is successful else false.

例外:

IOException

getUri

public URI getUri()

クラスからコピーされた説明: FileSystem

Returns a URI whose scheme and authority identify this FileSystem.

定義:

getUri クラス内 FileSystem

listStatus

public FileStatus[] listStatus(Path file)
                        throws IOException

クラスからコピーされた説明: FileSystem

List the statuses of the files/directories in the given path if the path is a directory.

Does not guarantee to return the List of files/directories status in a sorted order.

定義:

listStatus クラス内 FileSystem

パラメータ:

file - given path

戻り値:

the statuses of the files/directories in the given patch

例外:

FileNotFoundException - when the path does not exist; IOException see specific implementation

IOException

getFileStatus

public FileStatus getFileStatus(Path file)
                         throws IOException

クラスからコピーされた説明: FileSystem

Return a file status object that represents the path.

定義:

getFileStatus クラス内 FileSystem

パラメータ:

file - The path we want information from

戻り値:

a FileStatus object

例外:

FileNotFoundException - when the path does not exist; IOException see specific implementation

IOException

mkdirs

public boolean mkdirs(Path file,
                      FsPermission permission)
               throws IOException

クラスからコピーされた説明: FileSystem

Make the given file and all non-existent parents into directories. Has the semantics of Unix 'mkdir -p'. Existence of the directory hierarchy is not an error.

定義:

mkdirs クラス内 FileSystem

パラメータ:

file - path to create

permission - to apply to f

例外:

IOException

rename

public boolean rename(Path src,
                      Path dst)
               throws IOException

クラスからコピーされた説明: FileSystem

Renames Path src to Path dst. Can take place on local fs or remote DFS.

定義:

rename クラス内 FileSystem

パラメータ:

src - path to be renamed

dst - new path after rename

戻り値:

true if rename is successful

例外:

IOException - on failure

getWorkingDirectory

public Path getWorkingDirectory()

クラスからコピーされた説明: FileSystem

Get the current working directory for the given file system

定義:

getWorkingDirectory クラス内 FileSystem

戻り値:

the directory pathname

getHomeDirectory

public Path getHomeDirectory()

クラスからコピーされた説明: FileSystem

Return the current user's home directory in this filesystem. The default implementation returns "/user/$USER/".

オーバーライド:

getHomeDirectory クラス内 FileSystem

setWorkingDirectory

public void setWorkingDirectory(Path newDir)

クラスからコピーされた説明: FileSystem

Set the current working directory for the given file system. All relative paths will be resolved relative to it.

定義:

setWorkingDirectory クラス内 FileSystem

パラメータ:

newDir - Path of new working directory