Modifier and Type | Method and Description |
---|---|
FileSystemOptions |
FileSystem.getFileSystemOptions()
Returns the FileSystemOptions used to instantiate this filesystem
|
Modifier and Type | Method and Description |
---|---|
int |
FileSystemOptions.compareTo(FileSystemOptions other) |
protected java.lang.Object |
FileSystemConfigBuilder.getParam(FileSystemOptions opts,
java.lang.String name) |
protected boolean |
FileSystemConfigBuilder.hasParam(FileSystemOptions opts,
java.lang.String name) |
FileObject |
FileSystemManager.resolveFile(java.lang.String name,
FileSystemOptions fileSystemOptions)
Locates a file by name.
|
protected void |
FileSystemConfigBuilder.setParam(FileSystemOptions opts,
java.lang.String name,
java.lang.Object value) |
Modifier and Type | Method and Description |
---|---|
UserAuthenticator |
DefaultFileSystemConfigBuilder.getUserAuthenticator(FileSystemOptions opts) |
FileObject |
DefaultFileSystemManager.resolveFile(FileObject baseFile,
java.lang.String uri,
FileSystemOptions fileSystemOptions)
Resolves a URI, realtive to a base file with specified FileSystem
configuration
|
FileObject |
DefaultFileSystemManager.resolveFile(java.lang.String uri,
FileSystemOptions fileSystemOptions)
Locate a file by URI, use the FileSystemOptions for file-system creation
|
void |
DefaultFileSystemConfigBuilder.setUserAuthenticator(FileSystemOptions opts,
UserAuthenticator userAuthenticator)
Sets the user authenticator to get authentication informations
|
Constructor and Description |
---|
VirtualFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
FileSystemOptions |
AbstractFileSystem.getFileSystemOptions()
Return the FileSystemOptions used to instantiate this filesystem
|
Modifier and Type | Method and Description |
---|---|
FileObject |
FileProvider.createFileSystem(java.lang.String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
FileObject |
AbstractLayeredFileProvider.createFileSystem(java.lang.String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
FileObject |
AbstractFileProvider.createFileSystem(java.lang.String scheme,
FileObject file,
FileSystemOptions properties)
Creates a layered file system.
|
protected abstract FileSystem |
AbstractOriginatingFileProvider.doCreateFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions)
Creates a
FileSystem . |
protected abstract FileSystem |
AbstractLayeredFileProvider.doCreateFileSystem(java.lang.String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
protected FileObject |
AbstractOriginatingFileProvider.findFile(FileName name,
FileSystemOptions fileSystemOptions)
Locates a file from its parsed URI.
|
FileObject |
FileProvider.findFile(FileObject baseFile,
java.lang.String uri,
FileSystemOptions fileSystemOptions)
Locates a file object, by absolute URI.
|
FileObject |
CompositeFileProvider.findFile(FileObject baseFile,
java.lang.String uri,
FileSystemOptions fileSystemOptions)
Locates a file object, by absolute URI.
|
FileObject |
AbstractOriginatingFileProvider.findFile(FileObject baseFile,
java.lang.String uri,
FileSystemOptions fileSystemOptions)
Locates a file object, by absolute URI.
|
FileObject |
AbstractLayeredFileProvider.findFile(FileObject baseFile,
java.lang.String uri,
FileSystemOptions properties)
Locates a file object, by absolute URI.
|
protected FileSystem |
AbstractFileProvider.findFileSystem(java.lang.Comparable key,
FileSystemOptions fileSystemProps)
Locates a cached file system
|
FileObject |
VfsComponentContext.resolveFile(FileObject baseFile,
java.lang.String name,
FileSystemOptions fileSystemOptions)
Locate a file by name.
|
FileObject |
VfsComponentContext.resolveFile(java.lang.String name,
FileSystemOptions fileSystemOptions)
Locate a file by name.
|
Constructor and Description |
---|
AbstractFileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
DefaultURLStreamHandler(VfsComponentContext context,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
protected FileSystem |
Bzip2FileProvider.createFileSystem(FileName name,
FileObject file,
FileSystemOptions fileSystemOptions) |
Constructor and Description |
---|
Bzip2FileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
protected abstract FileSystem |
CompressedFileFileProvider.createFileSystem(FileName name,
FileObject file,
FileSystemOptions fileSystemOptions) |
protected FileSystem |
CompressedFileFileProvider.doCreateFileSystem(java.lang.String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
Constructor and Description |
---|
CompressedFileFileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
static org.apache.commons.net.ftp.FTPClient |
FtpClientFactory.createConnection(java.lang.String hostname,
int port,
char[] username,
char[] password,
java.lang.String workingDirectory,
FileSystemOptions fileSystemOptions)
Creates a new connection to the server.
|
protected FileSystem |
FtpFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions)
Creates the filesystem.
|
java.lang.Integer |
FtpFileSystemConfigBuilder.getDataTimeout(FileSystemOptions opts) |
java.lang.String |
FtpFileSystemConfigBuilder.getDefaultDateFormat(FileSystemOptions opts)
get the language code used by the server.
|
java.lang.String |
FtpFileSystemConfigBuilder.getEntryParser(FileSystemOptions opts) |
org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory |
FtpFileSystemConfigBuilder.getEntryParserFactory(FileSystemOptions opts) |
java.lang.Boolean |
FtpFileSystemConfigBuilder.getPassiveMode(FileSystemOptions opts) |
java.lang.String |
FtpFileSystemConfigBuilder.getRecentDateFormat(FileSystemOptions opts)
see
FTPClientConfig for details and examples. |
java.lang.String |
FtpFileSystemConfigBuilder.getServerLanguageCode(FileSystemOptions opts)
get the language code used by the server.
|
java.lang.String |
FtpFileSystemConfigBuilder.getServerTimeZoneId(FileSystemOptions opts)
see
FTPClientConfig for details and examples. |
java.lang.String[] |
FtpFileSystemConfigBuilder.getShortMonthNames(FileSystemOptions opts)
see
FTPClientConfig for details and examples. |
java.lang.Boolean |
FtpFileSystemConfigBuilder.getUserDirIsRoot(FileSystemOptions opts) |
void |
FtpFileSystemConfigBuilder.setDataTimeout(FileSystemOptions opts,
java.lang.Integer dataTimeout)
set the data timeout for the ftp client.
If you set the dataTimeout to null no dataTimeout will be set on the
ftp client. |
void |
FtpFileSystemConfigBuilder.setDefaultDateFormat(FileSystemOptions opts,
java.lang.String defaultDateFormat)
set the language code used by the server.
|
void |
FtpFileSystemConfigBuilder.setEntryParser(FileSystemOptions opts,
java.lang.String key)
set the FQCN of your FileEntryParser used to parse the directory listing from your server.
If you do not use the default commons-net FTPFileEntryParserFactory e.g. |
void |
FtpFileSystemConfigBuilder.setEntryParserFactory(FileSystemOptions opts,
org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory factory)
FTPFileEntryParserFactory which will be used for ftp-entry parsing
|
void |
FtpFileSystemConfigBuilder.setPassiveMode(FileSystemOptions opts,
boolean passiveMode)
enter into passive mode
|
void |
FtpFileSystemConfigBuilder.setRecentDateFormat(FileSystemOptions opts,
java.lang.String recentDateFormat)
see
FTPClientConfig for details and examples. |
void |
FtpFileSystemConfigBuilder.setServerLanguageCode(FileSystemOptions opts,
java.lang.String serverLanguageCode)
set the language code used by the server.
|
void |
FtpFileSystemConfigBuilder.setServerTimeZoneId(FileSystemOptions opts,
java.lang.String serverTimeZoneId)
see
FTPClientConfig for details and examples. |
void |
FtpFileSystemConfigBuilder.setShortMonthNames(FileSystemOptions opts,
java.lang.String[] shortMonthNames)
see
FTPClientConfig for details and examples. |
void |
FtpFileSystemConfigBuilder.setUserDirIsRoot(FileSystemOptions opts,
boolean userDirIsRoot)
use user directory as root (do not change to fs root)
|
Constructor and Description |
---|
FtpFileSystem(GenericFileName rootName,
FtpClient ftpClient,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
protected FileSystem |
GzipFileProvider.createFileSystem(FileName name,
FileObject file,
FileSystemOptions fileSystemOptions) |
Constructor and Description |
---|
GzipFileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
static org.apache.commons.httpclient.HttpClient |
HttpClientFactory.createConnection(java.lang.String scheme,
java.lang.String hostname,
int port,
java.lang.String username,
java.lang.String password,
FileSystemOptions fileSystemOptions)
Creates a new connection to the server.
|
protected FileSystem |
HttpFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions)
Creates a
FileSystem . |
org.apache.commons.httpclient.Cookie[] |
HttpFileSystemConfigBuilder.getCookies(FileSystemOptions opts)
The cookies to add to the reqest
|
UserAuthenticator |
HttpFileSystemConfigBuilder.getProxyAuthenticator(FileSystemOptions opts)
Get the proxy authenticator where the system should get the credentials from
|
java.lang.String |
HttpFileSystemConfigBuilder.getProxyHost(FileSystemOptions opts)
Get the proxy to use for http connection
You have to set the ProxyPort too if you would like to have the proxy relly used.
|
int |
HttpFileSystemConfigBuilder.getProxyPort(FileSystemOptions opts)
Get the proxy-port to use for http the connection
You have to set the ProxyHost too if you would like to have the proxy relly used.
|
java.lang.String |
HttpFileSystemConfigBuilder.getUrlCharset(FileSystemOptions opts)
Set the charset used for url encoding
|
void |
HttpFileSystemConfigBuilder.setCookies(FileSystemOptions opts,
org.apache.commons.httpclient.Cookie[] cookies)
The cookies to add to the reqest
|
void |
HttpFileSystemConfigBuilder.setProxyAuthenticator(FileSystemOptions opts,
UserAuthenticator authenticator)
Set the proxy authenticator where the system should get the credentials from
|
void |
HttpFileSystemConfigBuilder.setProxyHost(FileSystemOptions opts,
java.lang.String proxyHost)
Set the proxy to use for http connection.
You have to set the ProxyPort too if you would like to have the proxy relly used. |
void |
HttpFileSystemConfigBuilder.setProxyPort(FileSystemOptions opts,
int proxyPort)
Set the proxy-port to use for http connection
You have to set the ProxyHost too if you would like to have the proxy relly used.
|
void |
HttpFileSystemConfigBuilder.setUrlCharset(FileSystemOptions opts,
java.lang.String chaset)
Set the charset used for url encoding
|
Constructor and Description |
---|
HttpFileSystem(GenericFileName rootName,
org.apache.commons.httpclient.HttpClient client,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
protected FileSystem |
JarFileProvider.doCreateFileSystem(java.lang.String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
Constructor and Description |
---|
JarFileSystem(FileName rootName,
FileObject file,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
protected FileSystem |
DefaultLocalFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions)
Creates the filesystem.
|
Constructor and Description |
---|
LocalFileSystem(FileName rootName,
java.lang.String rootFile,
FileSystemOptions opts) |
Modifier and Type | Method and Description |
---|---|
protected FileSystem |
RamFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions) |
int |
RamFileSystemConfigBuilder.getMaxSize(FileSystemOptions opts) |
void |
RamFileSystemConfigBuilder.setMaxSize(FileSystemOptions opts,
int sizeInBytes)
sets the maximum size of the file system
|
Constructor and Description |
---|
RamFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
FileObject |
ResourceFileProvider.findFile(FileObject baseFile,
java.lang.String uri,
FileSystemOptions fileSystemOptions)
Locates a file object, by absolute URI.
|
java.lang.ClassLoader |
ResourceFileSystemConfigBuilder.getClassLoader(FileSystemOptions opts) |
void |
ResourceFileSystemConfigBuilder.setClassLoader(FileSystemOptions opts,
java.lang.ClassLoader classLoader) |
Modifier and Type | Method and Description |
---|---|
static com.jcraft.jsch.Session |
SftpClientFactory.createConnection(java.lang.String hostname,
int port,
char[] username,
char[] password,
FileSystemOptions fileSystemOptions)
Creates a new connection to the server.
|
protected FileSystem |
SftpFileProvider.doCreateFileSystem(FileName name,
FileSystemOptions fileSystemOptions)
Creates a
FileSystem . |
java.lang.String |
SftpFileSystemConfigBuilder.getCompression(FileSystemOptions opts) |
java.io.File[] |
SftpFileSystemConfigBuilder.getIdentities(FileSystemOptions opts) |
java.io.File |
SftpFileSystemConfigBuilder.getKnownHosts(FileSystemOptions opts) |
java.lang.String |
SftpFileSystemConfigBuilder.getProxyHost(FileSystemOptions opts)
Get the proxy to use for sftp connection
You have to set the ProxyPort too if you would like to have the proxy relly used.
|
int |
SftpFileSystemConfigBuilder.getProxyPort(FileSystemOptions opts)
Get the proxy-port to use for sftp the connection
You have to set the ProxyHost too if you would like to have the proxy relly used.
|
SftpFileSystemConfigBuilder.ProxyType |
SftpFileSystemConfigBuilder.getProxyType(FileSystemOptions opts)
Get the proxy type to use for sftp connection.
|
java.lang.String |
SftpFileSystemConfigBuilder.getStrictHostKeyChecking(FileSystemOptions opts) |
java.lang.Integer |
SftpFileSystemConfigBuilder.getTimeout(FileSystemOptions opts) |
java.lang.Boolean |
SftpFileSystemConfigBuilder.getUserDirIsRoot(FileSystemOptions opts) |
com.jcraft.jsch.UserInfo |
SftpFileSystemConfigBuilder.getUserInfo(FileSystemOptions opts) |
void |
SftpFileSystemConfigBuilder.setCompression(FileSystemOptions opts,
java.lang.String compression)
configure the compression to use.
e.g. |
void |
SftpFileSystemConfigBuilder.setIdentities(FileSystemOptions opts,
java.io.File[] identities)
Set the identity files (your private key files).
Need to use a java.io.File as JSch cant deal with vfs FileObjects ;-) |
void |
SftpFileSystemConfigBuilder.setKnownHosts(FileSystemOptions opts,
java.io.File sshdir)
Set the known_hosts file.
|
void |
SftpFileSystemConfigBuilder.setProxyHost(FileSystemOptions opts,
java.lang.String proxyHost)
Set the proxy to use for sftp connection.
You have to set the ProxyPort too if you would like to have the proxy relly used. |
void |
SftpFileSystemConfigBuilder.setProxyPort(FileSystemOptions opts,
int proxyPort)
Set the proxy-port to use for sftp connection
You have to set the ProxyHost too if you would like to have the proxy relly used.
|
void |
SftpFileSystemConfigBuilder.setProxyType(FileSystemOptions opts,
SftpFileSystemConfigBuilder.ProxyType proxyType)
Set the proxy type to use for sftp connection.
|
void |
SftpFileSystemConfigBuilder.setStrictHostKeyChecking(FileSystemOptions opts,
java.lang.String hostKeyChecking)
configure the host key checking to use.
valid arguments are only yes, no and ask. See the jsch documentation for details. |
void |
SftpFileSystemConfigBuilder.setTimeout(FileSystemOptions opts,
java.lang.Integer timeout)
set the timeout value on jsch session
|
void |
SftpFileSystemConfigBuilder.setUserDirIsRoot(FileSystemOptions opts,
boolean userDirIsRoot)
use user directory as root (do not change to fs root)
|
void |
SftpFileSystemConfigBuilder.setUserInfo(FileSystemOptions opts,
com.jcraft.jsch.UserInfo info)
Set the userinfo class to use if e.g.
|
Constructor and Description |
---|
SftpFileSystem(GenericFileName rootName,
com.jcraft.jsch.Session session,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
protected FileSystem |
TarFileProvider.doCreateFileSystem(java.lang.String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
Constructor and Description |
---|
TarFileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
FileObject |
TemporaryFileProvider.findFile(FileObject baseFile,
java.lang.String uri,
FileSystemOptions properties)
Locates a file object, by absolute URI.
|
Modifier and Type | Method and Description |
---|---|
FileObject |
UrlFileProvider.findFile(FileObject baseFile,
java.lang.String uri,
FileSystemOptions fileSystemOptions)
Locates a file object, by absolute URI.
|
Constructor and Description |
---|
UrlFileSystem(FileName rootName,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
protected FileSystem |
ZipFileProvider.doCreateFileSystem(java.lang.String scheme,
FileObject file,
FileSystemOptions fileSystemOptions)
Creates a layered file system.
|
Constructor and Description |
---|
ZipFileSystem(FileName rootName,
FileObject parentLayer,
FileSystemOptions fileSystemOptions) |
Modifier and Type | Method and Description |
---|---|
static UserAuthenticationData |
UserAuthenticatorUtils.authenticate(FileSystemOptions opts,
UserAuthenticationData.Type[] authenticatorTypes)
if there is a authenticator the authentication will take place, else null will be reutrned
|
void |
DelegatingFileSystemOptionsBuilder.setConfigClass(FileSystemOptions fso,
java.lang.String scheme,
java.lang.String name,
java.lang.Class className)
Set a single class value.
The class has to implement a no-args constructor, else the instantiation might fail. |
void |
DelegatingFileSystemOptionsBuilder.setConfigClasses(FileSystemOptions fso,
java.lang.String scheme,
java.lang.String name,
java.lang.Class[] classNames)
Set an array of class values.
The class has to implement a no-args constructor, else the instantiation might fail. |
void |
DelegatingFileSystemOptionsBuilder.setConfigString(FileSystemOptions fso,
java.lang.String scheme,
java.lang.String name,
java.lang.String value)
Set a single string value.
|
void |
DelegatingFileSystemOptionsBuilder.setConfigStrings(FileSystemOptions fso,
java.lang.String scheme,
java.lang.String name,
java.lang.String[] values)
Set an array of string value.
|